NIFI-4637: HBase visibility lables

Fixed additional docs directory structure.


Project: http://git-wip-us.apache.org/repos/asf/nifi/repo
Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/500a254e
Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/500a254e
Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/500a254e

Branch: refs/heads/master
Commit: 500a254e3f5fe709a2cf6bd1268d57710334ea27
Parents: 0b85191
Author: Koji Kawamura <ijokaruma...@apache.org>
Authored: Fri May 11 07:30:19 2018 +0000
Committer: Koji Kawamura <ijokaruma...@apache.org>
Committed: Fri May 11 07:30:19 2018 +0000

----------------------------------------------------------------------
 .../additionalDetails.html                      |  39 -------
 .../additionalDetails.html                      |  41 -------
 .../additionalDetails.html                      |  41 -------
 .../additionalDetails.html                      | 113 -------------------
 .../additionalDetails.html                      |  39 +++++++
 .../additionalDetails.html                      |  41 +++++++
 .../additionalDetails.html                      |  41 +++++++
 .../additionalDetails.html                      | 113 +++++++++++++++++++
 8 files changed, 234 insertions(+), 234 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
deleted file mode 100644
index b1820c0..0000000
--- 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
+++ /dev/null
@@ -1,39 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-      http://www.apache.org/licenses/LICENSE-2.0
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-<head>
-    <meta charset="utf-8" />
-    <title>DeleteHBaseCells</title>
-    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
-</head>
-
-<body>
-<!-- Processor Documentation 
================================================== -->
-<h2>Overview</h2>
-<p>
-    This processor provides the ability to do deletes against one or more 
HBase cells, without having to delete the entire row. It should
-    be used as the primary delete method when visibility labels are in use and 
the cells have different visibility labels. Each line in
-    the flowfile body is a fully qualified cell (row id, column family, column 
qualifier and visibility labels if applicable). The separator
-    that separates each piece of the fully qualified cell is configurable, but 
<strong>::::</strong> is the default value.
-</p>
-<h2>Example FlowFile</h2>
-<pre>
-row1::::user::::name
-row1::::user::::address::::PII
-row1::::user::::billing_code_1::::PII&&amp;BILLING
-</pre>
-</body>
-</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
deleted file mode 100644
index 7fb35d7..0000000
--- 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
+++ /dev/null
@@ -1,41 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-      http://www.apache.org/licenses/LICENSE-2.0
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-<head>
-    <meta charset="utf-8" />
-    <title>PutHBaseCell</title>
-    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
-</head>
-
-<body>
-<!-- Processor Documentation 
================================================== -->
-<h2>Visibility Labels</h2>
-<p>
-    This processor provides the ability to attach visibility labels to HBase 
Puts that it generates, if visibility labels
-    are enabled on the HBase cluster. There are two ways to enable this:
-</p>
-<ul>
-    <li>Attributes on the flowfile.</li>
-    <li>Dynamic properties added to the processor.</li>
-</ul>
-<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
-attributes set on the flowfile. The naming convention for both (property name 
and attribute name) is:</p>
-<ul>
-    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
-    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
-</ul>
-</body>
-</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
deleted file mode 100644
index 09c4995..0000000
--- 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
+++ /dev/null
@@ -1,41 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-      http://www.apache.org/licenses/LICENSE-2.0
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-<head>
-    <meta charset="utf-8" />
-    <title>PutHBaseJSON</title>
-    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
-</head>
-
-<body>
-<!-- Processor Documentation 
================================================== -->
-<h2>Visibility Labels</h2>
-<p>
-    This processor provides the ability to attach visibility labels to HBase 
Puts that it generates, if visibility labels
-    are enabled on the HBase cluster. There are two ways to enable this:
-</p>
-<ul>
-    <li>Attributes on the flowfile.</li>
-    <li>Dynamic properties added to the processor.</li>
-</ul>
-<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
-    attributes set on the flowfile. The naming convention for both (property 
name and attribute name) is:</p>
-<ul>
-    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
-    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
-</ul>
-</body>
-</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
deleted file mode 100644
index 975f3ea..0000000
--- 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/META-INF/services/docs.org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
+++ /dev/null
@@ -1,113 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<!--
-  Licensed to the Apache Software Foundation (ASF) under one or more
-  contributor license agreements.  See the NOTICE file distributed with
-  this work for additional information regarding copyright ownership.
-  The ASF licenses this file to You under the Apache License, Version 2.0
-  (the "License"); you may not use this file except in compliance with
-  the License.  You may obtain a copy of the License at
-      http://www.apache.org/licenses/LICENSE-2.0
-  Unless required by applicable law or agreed to in writing, software
-  distributed under the License is distributed on an "AS IS" BASIS,
-  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-  See the License for the specific language governing permissions and
-  limitations under the License.
--->
-<head>
-    <meta charset="utf-8" />
-    <title>PutHBaseRecord</title>
-    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
-</head>
-
-<body>
-<!-- Processor Documentation 
================================================== -->
-<h2>Visibility Labels:</h2>
-<p>
-    PutHBaseRecord provides the ability to define a branch of the record as a 
map which contains an association between
-    column qualifiers and the visibility label that they should have assigned 
to them.
-</p>
-<h3>Example Schema</h3>
-<pre>
-{
-    "type": "record",
-    "name": "SampleRecord",
-    "fields": [
-        { "name": "name", "type": "string" },
-        { "name": "address", "type": "string" },
-        { "name": "dob", "type": "string" },
-        { "name": "attendingPhysician", "type": "string" },
-        { "name": "accountNumber", "type": "string" },
-        { "name": "visibility_labels", "type": "map", "values": "string" }
-    ]
-}
-</pre>
-<h3>Example Record</h3>
-<pre>
-{
-    "name": "John Smith",
-    "address": "12345 Main Street",
-    "dob": "1970-01-01",
-    "attendingPhysician": "Dr. Jane Doe",
-    "accountNumber": "1234-567-890-ABC",
-    "visibility_labels": {
-        "name": "OPEN",
-        "address": "PII",
-        "dob": "PII",
-        "attendingPhysician": "PII&amp;PHI",
-        "accountNumber": "PII&amp;BILLING"
-    }
-}
-</pre>
-<h3>Results in HBase</h3>
-<p>Example is for row with ID <em>patient-1</em> and column family 
<em>patient</em></p>
-<table>
-    <thead>
-        <tr>
-            <th>Row</th>
-            <th>Value</th>
-            <th>Visibility</th>
-        </tr>
-    </thead>
-    <tbody>
-        <tr>
-            <td>patient-1:patient:name</td>
-            <td>John Smith</td>
-            <td>OPEN</td>
-        </tr>
-        <tr>
-            <td>patient-1:patient:address</td>
-            <td>12345 Main Street</td>
-            <td>PII</td>
-        </tr>
-        <tr>
-            <td>patient-1:patient:</td>
-            <td>1970-01-01</td>
-            <td>PII</td>
-        </tr>
-        <tr>
-            <td>patient-1:patient:attendingPhysician</td>
-            <td>Dr. Jane Doe</td>
-            <td>PII&amp;PHI</td>
-        </tr>
-        <tr>
-            <td>patient-1:patient:accountNumber</td>
-            <td>1234-567-890-ABC</td>
-            <td>PII&amp;BILLING</td>
-        </tr>
-    </tbody>
-</table>
-<p>In addition to the branch for visibility labels, the same methods used for 
PutHBaseCell and PutHBaseJSON can be used.
-They are:</p>
-<ul>
-    <li>Attributes on the flowfile.</li>
-    <li>Dynamic properties added to the processor.</li>
-</ul>
-<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
-    attributes set on the flowfile. The naming convention for both (property 
name and attribute name) is:</p>
-<ul>
-    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
-    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
-</ul>
-</body>
-</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
new file mode 100644
index 0000000..b1820c0
--- /dev/null
+++ 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.DeleteHBaseCells/additionalDetails.html
@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<head>
+    <meta charset="utf-8" />
+    <title>DeleteHBaseCells</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
+</head>
+
+<body>
+<!-- Processor Documentation 
================================================== -->
+<h2>Overview</h2>
+<p>
+    This processor provides the ability to do deletes against one or more 
HBase cells, without having to delete the entire row. It should
+    be used as the primary delete method when visibility labels are in use and 
the cells have different visibility labels. Each line in
+    the flowfile body is a fully qualified cell (row id, column family, column 
qualifier and visibility labels if applicable). The separator
+    that separates each piece of the fully qualified cell is configurable, but 
<strong>::::</strong> is the default value.
+</p>
+<h2>Example FlowFile</h2>
+<pre>
+row1::::user::::name
+row1::::user::::address::::PII
+row1::::user::::billing_code_1::::PII&&amp;BILLING
+</pre>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
new file mode 100644
index 0000000..7fb35d7
--- /dev/null
+++ 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseCell/additionalDetails.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<head>
+    <meta charset="utf-8" />
+    <title>PutHBaseCell</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
+</head>
+
+<body>
+<!-- Processor Documentation 
================================================== -->
+<h2>Visibility Labels</h2>
+<p>
+    This processor provides the ability to attach visibility labels to HBase 
Puts that it generates, if visibility labels
+    are enabled on the HBase cluster. There are two ways to enable this:
+</p>
+<ul>
+    <li>Attributes on the flowfile.</li>
+    <li>Dynamic properties added to the processor.</li>
+</ul>
+<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
+attributes set on the flowfile. The naming convention for both (property name 
and attribute name) is:</p>
+<ul>
+    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
+    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
+</ul>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
new file mode 100644
index 0000000..09c4995
--- /dev/null
+++ 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseJSON/additionalDetails.html
@@ -0,0 +1,41 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<head>
+    <meta charset="utf-8" />
+    <title>PutHBaseJSON</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
+</head>
+
+<body>
+<!-- Processor Documentation 
================================================== -->
+<h2>Visibility Labels</h2>
+<p>
+    This processor provides the ability to attach visibility labels to HBase 
Puts that it generates, if visibility labels
+    are enabled on the HBase cluster. There are two ways to enable this:
+</p>
+<ul>
+    <li>Attributes on the flowfile.</li>
+    <li>Dynamic properties added to the processor.</li>
+</ul>
+<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
+    attributes set on the flowfile. The naming convention for both (property 
name and attribute name) is:</p>
+<ul>
+    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
+    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
+</ul>
+</body>
+</html>
\ No newline at end of file

http://git-wip-us.apache.org/repos/asf/nifi/blob/500a254e/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
----------------------------------------------------------------------
diff --git 
a/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
new file mode 100644
index 0000000..d6077cd
--- /dev/null
+++ 
b/nifi-nar-bundles/nifi-hbase-bundle/nifi-hbase-processors/src/main/resources/docs/org.apache.nifi.hbase.PutHBaseRecord/additionalDetails.html
@@ -0,0 +1,113 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<head>
+    <meta charset="utf-8" />
+    <title>PutHBaseRecord</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" 
type="text/css" />
+</head>
+
+<body>
+<!-- Processor Documentation 
================================================== -->
+<h2>Visibility Labels:</h2>
+<p>
+    PutHBaseRecord provides the ability to define a branch of the record as a 
map which contains an association between
+    column qualifiers and the visibility label that they should have assigned 
to them.
+</p>
+<h3>Example Schema</h3>
+<pre>
+{
+    "type": "record",
+    "name": "SampleRecord",
+    "fields": [
+        { "name": "name", "type": "string" },
+        { "name": "address", "type": "string" },
+        { "name": "dob", "type": "string" },
+        { "name": "attendingPhysician", "type": "string" },
+        { "name": "accountNumber", "type": "string" },
+        { "name": "visibility_labels", "type": { "type" : "map", "values": 
"string" } }
+    ]
+}
+</pre>
+<h3>Example Record</h3>
+<pre>
+{
+    "name": "John Smith",
+    "address": "12345 Main Street",
+    "dob": "1970-01-01",
+    "attendingPhysician": "Dr. Jane Doe",
+    "accountNumber": "1234-567-890-ABC",
+    "visibility_labels": {
+        "name": "OPEN",
+        "address": "PII",
+        "dob": "PII",
+        "attendingPhysician": "PII&amp;PHI",
+        "accountNumber": "PII&amp;BILLING"
+    }
+}
+</pre>
+<h3>Results in HBase</h3>
+<p>Example is for row with ID <em>patient-1</em> and column family 
<em>patient</em></p>
+<table>
+    <thead>
+        <tr>
+            <th>Row</th>
+            <th>Value</th>
+            <th>Visibility</th>
+        </tr>
+    </thead>
+    <tbody>
+        <tr>
+            <td>patient-1:patient:name</td>
+            <td>John Smith</td>
+            <td>OPEN</td>
+        </tr>
+        <tr>
+            <td>patient-1:patient:address</td>
+            <td>12345 Main Street</td>
+            <td>PII</td>
+        </tr>
+        <tr>
+            <td>patient-1:patient:</td>
+            <td>1970-01-01</td>
+            <td>PII</td>
+        </tr>
+        <tr>
+            <td>patient-1:patient:attendingPhysician</td>
+            <td>Dr. Jane Doe</td>
+            <td>PII&amp;PHI</td>
+        </tr>
+        <tr>
+            <td>patient-1:patient:accountNumber</td>
+            <td>1234-567-890-ABC</td>
+            <td>PII&amp;BILLING</td>
+        </tr>
+    </tbody>
+</table>
+<p>In addition to the branch for visibility labels, the same methods used for 
PutHBaseCell and PutHBaseJSON can be used.
+They are:</p>
+<ul>
+    <li>Attributes on the flowfile.</li>
+    <li>Dynamic properties added to the processor.</li>
+</ul>
+<p>When the dynamic properties are defined on the processor, they will be the 
default value, but can be overridden by
+    attributes set on the flowfile. The naming convention for both (property 
name and attribute name) is:</p>
+<ul>
+    <li>visibility.COLUMN_FAMILY - every column qualifier under the column 
family will get this.</li>
+    <li>visibility.COLUMN_FAMILY.COLUMN_VISIBILITY - the qualified column 
qualifier will be assigned this value.</li>
+</ul>
+</body>
+</html>

Reply via email to