Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CountText/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CountText/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CountText/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CountText/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CountText</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">CountText</h1><h2>Description: </h2><p>Counts various metrics on incoming text. The requested results will be recorded as attributes. The resulting flowfile will not have its content modified.</p><h3>Tags: </h3><p>count, text, line, word, character</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>C ount Lines</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, will count the number of lines present in the incoming text.</td></tr><tr><td id="name"><strong>Count Non-Empty Lines</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, will count the number of lines that contain a non-whitespace character present in the incoming text.</td></tr><tr><td id="name"><strong>Count Words</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, will count the number of words (alphanumeric character groups bounded by whitespace) present in the incoming text. Common logical delimiters [_-.] do not bound a word unless 'Split Words on Symbols' is true.</td></tr><tr><td id="name"><strong>Count Characters</strong></td><td id="de fault-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, will count the number of characters (including whitespace and symbols, but not including newlines and carriage returns) present in the incoming text.</td></tr><tr><td id="name"><strong>Split Words on Symbols</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If enabled, the word count will identify strings separated by common logical delimiters [ _ - . ] as independent words (ex. split-words-on-symbols = 4 words).</td></tr><tr><td id="name"><strong>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"><ul><li>ISO-8859-1</li><li>UTF-8</li><li>UTF-16</li><li>UTF-16LE</li><li>UTF-16BE</li><li>US-ASCII</li></ul></td><td id="description">Specifies a character encoding to use.</td></tr><tr><td id="name"><strong>Call Immediate Adjustment</strong></td> <td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the counter will be updated immediately, without regard to whether the ProcessSession is commit or rolled back;otherwise, the counter will be incremented only if and when the ProcessSession is committed.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The flowfile contains the original content with one or more attributes added containing the respective counts</td></tr><tr><td>failure</td><td>If the flowfile text cannot be counted for some reason, the original file will be routed to this destination and nothing will be routed elsewhere</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>text.line.count</td><td>The number of lines of text present in the FlowFil e content</td></tr><tr><td>text.line.nonempty.count</td><td>The number of lines of text (with at least one non-whitespace character) present in the original FlowFile</td></tr><tr><td>text.word.count</td><td>The number of words present in the original FlowFile</td></tr><tr><td>text.character.count</td><td>The number of characters (given the specified character encoding) present in the original FlowFile</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.SplitText/index.html">SplitText</a></p></body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashAttribute/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashAttribute/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashAttribute/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashAttribute/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CryptographicHashAttribute</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">CryptographicHashAttribute</h1><h2>Description: </h2><p>Calculates a hash value for each of the specified attributes using the given algorithm and writes it to an output attribute. Please refer to https://csrc.nist.gov/Projects/Hash-Functions/NIST-Policy-on-Hash-Functions for help to decide which algorithm to use. </p><h3>Tags: </h3><p>attributes, hash, md5, sha, keccak, blake2, cryptography</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Character Set</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"><ul><li>US-ASCII <img src="../../../../../html/images/iconInfo.png" alt="US-ASCII" title="US-ASCII"></img></li><li>ISO-8859-1 <img src="../../../../../html/images/iconInfo.png" alt="ISO-8859-1" title="ISO-8859-1"></img></li><li>UTF-8 <img src="../../../../../html/images/iconInfo.png" alt="UTF-8" title="UTF-8"></img></li><li>UTF-16BE <img src="../../../../../html/images/iconInfo.png" alt="UTF-16BE" title="UTF-16BE"></img></li><li>UTF-16LE <img src="../../../../../html/images/iconInfo.png" alt="UTF-16LE" title="UTF-16LE"></img></li><li>UTF-16 <img src="../../../../../html/images/iconInfo.png" alt="This character set normally decodes using an optional BOM at the beginning of the data but encodes by inserting a BE BOM. For hashing, it will be replaced with UTF-16BE. " title="This character set normally decodes using an optional BOM at the beginning of the data but encodes by inserting a BE BOM. For hashing, it will be replaced with UTF-16BE. "></img></li></ul></td><td id="description">The Character Set used to decode the attribute being hashed -- this applies to the incoming data encoding, not the resulting hash encoding. </td></tr><tr><td id="name"><strong>Fail when no attributes present</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Route to failure when none of the attributes that are configured for hashing are found. If set to false, then flow files that do not contain any of the attributes that are configured for hashing will just pass through to success.</td></tr><tr><td id="name"><strong>Hash Algorithm</strong></td><td id="default-value">SHA-256</td><td id="allowable-values"><ul><li>MD2 <img src="../../../../../html/images/iconIn fo.png" alt="MD2 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions" title="MD2 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>MD5 <img src="../../../../../html/images/iconInfo.png" alt="MD5 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions" title="MD5 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>SHA-1 <img src="../../../../../html/images/iconInfo.png" alt="SHA-1 (20 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions" title="SHA-1 (20 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>SHA-224 <img src="../../../../../html/images/iconInfo.png" alt="SHA-224 (28 byte output) SHA-2 family" title="SHA-224 (28 byte output) SHA-2 family"></img></li><li>SHA-256 <i mg src="../../../../../html/images/iconInfo.png" alt="SHA-256 (32 byte output) SHA-2 family" title="SHA-256 (32 byte output) SHA-2 family"></img></li><li>SHA-384 <img src="../../../../../html/images/iconInfo.png" alt="SHA-384 (48 byte output) SHA-2 family" title="SHA-384 (48 byte output) SHA-2 family"></img></li><li>SHA-512 <img src="../../../../../html/images/iconInfo.png" alt="SHA-512 (64 byte output) SHA-2 family" title="SHA-512 (64 byte output) SHA-2 family"></img></li><li>SHA-512/224 <img src="../../../../../html/images/iconInfo.png" alt="SHA-512/224 (28 byte output) SHA-2 using SHA-512 with truncated output" title="SHA-512/224 (28 byte output) SHA-2 using SHA-512 with truncated output"></img></li><li>SHA-512/256 <img src="../../../../../html/images/iconInfo.png" alt="SHA-512/256 (32 byte output) SHA-2 using SHA-512 with truncated output" title="SHA-512/256 (32 byte output) SHA-2 using SHA-512 with truncated output"></img></li><li>SHA3-224 <img src="../../../../../html/images/i conInfo.png" alt="SHA3-224 (28 byte output) Keccak-based SHA3 family" title="SHA3-224 (28 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-256 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-256 (32 byte output) Keccak-based SHA3 family" title="SHA3-256 (32 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-384 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-384 (48 byte output) Keccak-based SHA3 family" title="SHA3-384 (48 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-512 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-512 (64 byte output) Keccak-based SHA3 family" title="SHA3-512 (64 byte output) Keccak-based SHA3 family"></img></li><li>BLAKE2-160 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-160 (20 byte output) Also known as Blake2b" title="BLAKE2-160 (20 byte output) Also known as Blake2b"></img></li><li>BLAKE2-256 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-256 (32 byte ou tput) Also known as Blake2b" title="BLAKE2-256 (32 byte output) Also known as Blake2b"></img></li><li>BLAKE2-384 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-384 (48 byte output) Also known as Blake2b" title="BLAKE2-384 (48 byte output) Also known as Blake2b"></img></li><li>BLAKE2-512 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-512 (64 byte output) Also known as Blake2b" title="BLAKE2-512 (64 byte output) Also known as Blake2b"></img></li></ul></td><td id="description">The cryptographic hash algorithm to use. Note that not all of the algorithms available are recommended for use (some are provided for legacy use). There are many things to consider when picking an algorithm; it is recommended to use the most secure algorithm possible.</td></tr><tr><td id="name"><strong>Missing attribute policy</strong></td><td id="default-value">ALLOW</td><td id="allowable-values"><ul><li>Allow missing attributes <img src="../../../../../html/images/iconInfo.png" a lt="Do not route to failure if there are attributes configured for hashing that are not present in the flowfile" title="Do not route to failure if there are attributes configured for hashing that are not present in the flowfile"></img></li><li>Fail if missing attributes <img src="../../../../../html/images/iconInfo.png" alt="Route to failure if there are attributes configured for hashing that are not present in the flowfile" title="Route to failure if there are attributes configured for hashing that are not present in the flowfile"></img></li></ul></td><td id="description">Policy for how the processor handles attributes that are configured for hashing but are not found in the flowfile.</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A flowfile attribute key for attribute inspection</td><td id="val ue">Attribute Name</td><td>The property name defines the attribute to look for and hash in the incoming flowfile. The property value defines the name to give the generated attribute. Attribute names must be unique.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Used for flowfiles that have a hash value added</td></tr><tr><td>failure</td><td>Used for flowfiles that are missing required attributes</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td><Specified Attribute Name per Dynamic Property></td><td>This Processor adds an attribute whose value is the result of hashing the specified attribute. The name of this attribute is specified by the value of the dynamic property.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashContent/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.CryptographicHashContent/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CryptographicHashContent</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">CryptographicHashContent</h1><h2>Description: </h2><p>Calculates a cryptographic hash value for the flowfile content using the given algorithm and writes it to an output attribute. Please refer to https://csrc.nist.gov/Projects/Hash-Functions/NIST-Policy-on-Hash-Functions for help to decide which algorithm to use.</p><h3>Tags: </h3><p>content, hash, sha, blake2, md5, cryptography</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default v alues.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Fail if the content is empty</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Route to failure if the content is empty. While hashing an empty value is valid, some flows may want to detect empty input.</td></tr><tr><td id="name"><strong>Hash Algorithm</strong></td><td id="default-value">SHA-256</td><td id="allowable-values"><ul><li>MD2 <img src="../../../../../html/images/iconInfo.png" alt="MD2 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions" title="MD2 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>MD5 <img src="../../../../../html/images/iconInfo.png" alt="MD5 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broke n due to collisions" title="MD5 (16 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>SHA-1 <img src="../../../../../html/images/iconInfo.png" alt="SHA-1 (20 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions" title="SHA-1 (20 byte output) [WARNING -- Cryptographically broken] Cryptographically broken due to collisions"></img></li><li>SHA-224 <img src="../../../../../html/images/iconInfo.png" alt="SHA-224 (28 byte output) SHA-2 family" title="SHA-224 (28 byte output) SHA-2 family"></img></li><li>SHA-256 <img src="../../../../../html/images/iconInfo.png" alt="SHA-256 (32 byte output) SHA-2 family" title="SHA-256 (32 byte output) SHA-2 family"></img></li><li>SHA-384 <img src="../../../../../html/images/iconInfo.png" alt="SHA-384 (48 byte output) SHA-2 family" title="SHA-384 (48 byte output) SHA-2 family"></img></li><li>SHA-512 <img src="../../../../../html/images/iconInfo.png" alt="S HA-512 (64 byte output) SHA-2 family" title="SHA-512 (64 byte output) SHA-2 family"></img></li><li>SHA-512/224 <img src="../../../../../html/images/iconInfo.png" alt="SHA-512/224 (28 byte output) SHA-2 using SHA-512 with truncated output" title="SHA-512/224 (28 byte output) SHA-2 using SHA-512 with truncated output"></img></li><li>SHA-512/256 <img src="../../../../../html/images/iconInfo.png" alt="SHA-512/256 (32 byte output) SHA-2 using SHA-512 with truncated output" title="SHA-512/256 (32 byte output) SHA-2 using SHA-512 with truncated output"></img></li><li>SHA3-224 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-224 (28 byte output) Keccak-based SHA3 family" title="SHA3-224 (28 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-256 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-256 (32 byte output) Keccak-based SHA3 family" title="SHA3-256 (32 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-384 <img src="../../../../../html/images/ic onInfo.png" alt="SHA3-384 (48 byte output) Keccak-based SHA3 family" title="SHA3-384 (48 byte output) Keccak-based SHA3 family"></img></li><li>SHA3-512 <img src="../../../../../html/images/iconInfo.png" alt="SHA3-512 (64 byte output) Keccak-based SHA3 family" title="SHA3-512 (64 byte output) Keccak-based SHA3 family"></img></li><li>BLAKE2-160 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-160 (20 byte output) Also known as Blake2b" title="BLAKE2-160 (20 byte output) Also known as Blake2b"></img></li><li>BLAKE2-256 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-256 (32 byte output) Also known as Blake2b" title="BLAKE2-256 (32 byte output) Also known as Blake2b"></img></li><li>BLAKE2-384 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-384 (48 byte output) Also known as Blake2b" title="BLAKE2-384 (48 byte output) Also known as Blake2b"></img></li><li>BLAKE2-512 <img src="../../../../../html/images/iconInfo.png" alt="BLAKE2-512 (64 byte out put) Also known as Blake2b" title="BLAKE2-512 (64 byte output) Also known as Blake2b"></img></li></ul></td><td id="description">The hash algorithm to use. Note that not all of the algorithms available are recommended for use (some are provided for legacy compatibility). There are many things to consider when picking an algorithm; it is recommended to use the most secure algorithm possible.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Used for flowfiles that have a hash value added</td></tr><tr><td>failure</td><td>Used for flowfiles that have no content if the 'fail on empty' setting is enabled</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>content_<algorithm></td><td>This processor adds an attribute whose value is the result of hashing the flowfile content. The name of thi s attribute is specified by the value of the algorithm, e.g. 'content_SHA-256'.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,48 @@ +<!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>DebugFlow</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <p> + When triggered, the processor loops through the appropriate response list (based on whether or not it + received a FlowFile). A response is produced the configured number of times for each pass through its + response list, as long as the processor is running. + </p><p> + Triggered by a FlowFile, the processor can produce the following responses. + <ol> + <li>transfer FlowFile to success relationship.</li> + <li>transfer FlowFile to failure relationship.</li> + <li>rollback the FlowFile without penalty.</li> + <li>rollback the FlowFile and yield the context.</li> + <li>rollback the FlowFile with penalty.</li> + <li>throw an exception.</li> + </ol> + </p><p> + Triggered without a FlowFile, the processor can produce the following responses. + <ol> + <li>do nothing and return.</li> + <li>throw an exception.</li> + <li>yield the context.</li> + </ol> + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DebugFlow/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DebugFlow</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DebugFlow</h1><h2>Description: </h2><p>The DebugFlow processor aids testing and debugging the FlowFile framework by allowing various responses to be explicitly triggered in response to the receipt of a FlowFile or a timer event without a FlowFile if using timer or cron based scheduling. It can force responses needed to exercise or test various failure modes that can occur when a processor runs.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>test, debug, processor, utility, flow, FlowFile</p><h3>Properties: </h3><p>In the list below, the names of required propert ies appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>FlowFile Success Iterations</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to success relationship.</td></tr><tr><td id="name"><strong>FlowFile Failure Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to forward to failure relationship.</td></tr><tr><td id="name"><strong>FlowFile Rollback Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back (with out penalty).</td></tr><tr><td id="name"><strong>FlowFile Rollback Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back and yield.</td></tr><tr><td id="name"><strong>FlowFile Rollback Penalty Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to roll back with penalty.</td></tr><tr><td id="name"><strong>FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of FlowFiles to throw exception.</td></tr><tr><td id="name"><strong>FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>No FlowFile Skip Iterations</strong></td><td id="default-value">1</td><td id=" allowable-values"></td><td id="description">Number of times to skip onTrigger if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to throw NPE exception if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Yield Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to yield if no FlowFile.</td></tr><tr><td id="name"><strong>No FlowFile Exception Class</strong></td><td id="default-value">java.lang.RuntimeException</td><td id="allowable-values"></td><td id="description">Exception class to be thrown if no FlowFile (must extend java.lang.RuntimeException).</td></tr><tr><td id="name"><strong>Write Iterations</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Number of times to write to the FlowFile</td></tr><tr><td id="name"><stro ng>Content Size</strong></td><td id="default-value">1 KB</td><td id="allowable-values"></td><td id="description">The number of bytes to write each time that the FlowFile is written to</td></tr><tr><td id="name"><strong>@OnScheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnScheduled method, so that the processor can be forced to take a long time to start up</td></tr><tr><td id="name"><strong>Fail When @OnScheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnScheduled are called</td></tr><tr><td id="name"><strong>@OnUnscheduled Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor sh ould sleep in the @OnUnscheduled method, so that the processor can be forced to take a long time to respond when user clicks stop</td></tr><tr><td id="name"><strong>Fail When @OnUnscheduled called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnUnscheduled are called</td></tr><tr><td id="name"><strong>@OnStopped Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the @OnStopped method, so that the processor can be forced to take a long time to shutdown<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Fail When @OnStopped called</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li> true</li><li>false</li></ul></td><td id="description">Specifies whether or not the Processor should throw an Exception when the methods annotated with @OnStopped are called</td></tr><tr><td id="name"><strong>OnTrigger Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the onTrigger() method, so that the processor can be forced to take a long time to perform its task</td></tr><tr><td id="name"><strong>CustomValidate Pause Time</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Specifies how long the processor should sleep in the customValidate() method</td></tr><tr><td id="name"><strong>Ignore Interrupts When Paused</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If the Processor's thread(s) are sleeping (due to one of the "Pause Time" properties a bove), and the thread is interrupted, this indicates whether the Processor should ignore the interrupt and continue sleeping or if it should allow itself to be interrupted.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles processed successfully.</td></tr><tr><td>failure</td><td>FlowFiles that failed to process.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DetectDuplicate/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DetectDuplicate/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DetectDuplicate/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DetectDuplicate/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DetectDuplicate</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DetectDuplicate</h1><h2>Description: </h2><p>Caches a value, computed from FlowFile attributes, for each incoming FlowFile and determines if the cached value has already been seen. If so, routes the FlowFile to 'duplicate' with an attribute named 'original.identifier' that specifies the original FlowFile's "description", which is specified in the <FlowFile Description> property. If the FlowFile is not determined to be a duplicate, the Processor routes the FlowFile to 'non-duplicate'</p><h3>Tags: </h3><p>hash, dupe, duplicate, dedupe</p><h3>Properties: </h3><p>In the list below, the names o f required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Cache Entry Identifier</strong></td><td id="default-value">${hash.value}</td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or the results of an Attribute Expression Language statement, which will be evaluated against a FlowFile in order to determine the value used to identify duplicates; it is this value that is cached<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>FlowFile Description</strong></td><td id="default-value"></t d><td id="allowable-values"></td><td id="description">When a FlowFile is added to the cache, this value is stored along with it so that if a duplicate is found, this description of the original FlowFile will be added to the duplicate's "original.flowfile.description" attribute<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Age Off Duration</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Time interval to age off cached FlowFiles</td></tr><tr><td id="name"><strong>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementations: </strong><a href="../../../nifi-couchbase-nar/1.11.4/org.apache.nifi.couchbase.CouchbaseMapCacheClient/index.html">CouchbaseMapCacheClient</a><br/><a href="../../../nifi-distributed-cache-service s-nar/1.11.4/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a><br/><a href="../../../nifi-hbase_2-client-service-nar/1.11.4/org.apache.nifi.hbase.HBase_2_ClientMapCacheService/index.html">HBase_2_ClientMapCacheService</a><br/><a href="../../../nifi-redis-nar/1.11.4/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html">RedisDistributedMapCacheClientService</a><br/><a href="../../../nifi-hbase_1_1_2-client-service-nar/1.11.4/org.apache.nifi.hbase.HBase_1_1_2_ClientMapCacheService/index.html">HBase_1_1_2_ClientMapCacheService</a></td><td id="description">The Controller Service that is used to cache unique identifiers, used to determine duplicates</td></tr><tr><td id="name">Cache The Entry Identifier</td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">When true this cause the processor to check for duplicates and cache the Entry Identifier. When false, the processor would only check for duplicates and not cache the Entry Identifier, requiring another processor to add identifiers to the distributed cache.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>duplicate</td><td>If a FlowFile has been detected to be a duplicate, it will be routed to this relationship</td></tr><tr><td>non-duplicate</td><td>If a FlowFile's Cache Entry Identifier was not found in the cache, it will be routed to this relationship</td></tr><tr><td>failure</td><td>If unable to communicate with the cache, the FlowFile will be penalized and routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>original.flowfile.description</td><td>All FlowFiles routed to the duplicate relationship will have an attribute added named original. flowfile.description. The value of this attribute is determined by the attributes of the original copy of the data and by the FlowFile Description property.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../../../nifi-distributed-cache-services-nar/1.11.4/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a>, <a href="../../../nifi-distributed-cache-services-nar/1.11.4/org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">DistributedMapCacheServer</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DistributeLoad/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DistributeLoad/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DistributeLoad/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DistributeLoad/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributeLoad</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DistributeLoad</h1><h2>Description: </h2><p>Distributes FlowFiles to downstream processors based on a Distribution Strategy. If using the Round Robin strategy, the default is to assign each destination a weighting of 1 (evenly distributed). However, optional propertiescan be added to the change this; adding a property with the name '5' and value '10' means that the relationship with name '5' will be receive 10 FlowFiles in each iteration instead of 1.</p><h3>Tags: </h3><p>distribute, load balance, route, round robin, weighted</p><h3>Properties: </h3><p>In the list below, the names of required pro perties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Relationships</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Determines the number of Relationships to which the load should be distributed</td></tr><tr><td id="name"><strong>Distribution Strategy</strong></td><td id="default-value">round robin</td><td id="allowable-values"><ul><li>round robin</li><li>next available</li><li>load distribution service</li></ul></td><td id="description">Determines how the load will be distributed. If using Round Robin, will not distribute any FlowFiles unless all destinations can accept FlowFiles; when using Next Available, will distribute FlowFiles as long as at least 1 destination can accept FlowFiles.</td></tr>< /table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">The relationship name(positive number)</td><td id="value">The relationship Weight(positive number)</td><td>adding a property with the name '5' and value '10' means that the relationship with name '5' will be receive 10 FlowFiles in each iteration instead of 1.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>1</td><td>Where to route flowfiles for this relationship index</td></tr></table><h3>Dynamic Relationships: </h3><p>A Dynamic Relationship may be created based on how the user configures the Processor.<table id="dynamic-relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>A number 1..<Number Of Relationships></td ><td>FlowFiles are sent to this relationship per the <Distribution >Strategy></td></tr></table></p><h3>Reads Attributes: </h3>None >specified.<h3>Writes Attributes: </h3><table >id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>distribute.load.relationship</td><td>The > name of the specific relationship the flow file has been routed >through</td></tr></table><h3>State management: </h3>This component does not >store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input >requirement: </h3>This component requires an incoming relationship.<h3>System >Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.DuplicateFlowFile/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DuplicateFlowFile</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">DuplicateFlowFile</h1><h2>Description: </h2><p>Intended for load testing, this processor will create the configured number of copies of each incoming FlowFile. The original FlowFile as well as all generated copies are sent to the 'success' relationship. In addition, each FlowFile gets an attribute 'copy.index' set to the copy number, where the original FlowFile gets a value of zero, and all copies receive incremented integer values.</p><h3>Tags: </h3><p>test, load, duplicate</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any othe r properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Number of Copies</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies how many copies of each incoming FlowFile will be made<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The original FlowFile and all copies will be sent to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th> Name</th><th>Description</th></tr><tr><td>copy.index</td><td>A zero-based incrementing integer value based on which copy the FlowFile is.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,30 @@ +<!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>EncryptContent</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <p> + <strong>Note:</strong> This processor supports OpenPGP algorithms that are compatible with third party programs. + However, it currently cannot add a digital signature to an encrypted FlowFile. + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EncryptContent/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,2 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EncryptContent</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">EncryptContent</h1><h2>Description: </h2><p>Encrypts or Decrypts a FlowFile using either symmetric encryption with a password and randomly generated salt, or asymmetric encryption using a public and secret key.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>encryption, decryption, password, JCE, OpenPGP, PGP, GPG</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Mode</strong></td><td id="default-value">Encrypt</td><td id="allowable-values"><ul><li>Encrypt</li><li>Decrypt</li></ul></td><td id="description">Specifies whether the content should be encrypted or decrypted</td></tr><tr><td id="name"><strong>Key Derivation Function</strong></td><td id="default-value">BCRYPT</td><td id="allowable-values"><ul><li>NiFi Legacy KDF <img src="../../../../../html/images/iconInfo.png" alt="MD5 @ 1000 iterations" title="MD5 @ 1000 iterations"></img></li><li>OpenSSL EVP_BytesToKey <img src="../../../../../html/images/iconInfo.png" alt="Single iteration MD5 compatible with PKCS#5 v1.5" title="Single iteration MD5 compatible with PKCS#5 v1.5"></img></li><li>Bcrypt <img src="../../../../../html/images/iconInfo.png" alt="Bcrypt with configurable work factor. See Admin Guide" title="Bcrypt with configurable work factor. See Admin Guide"></img></li><li>Scrypt <img src="../../../../../html/images/iconInfo.png" alt="Scrypt with configurable cost parameters. See Admin Guide" title="Scrypt with configurable cost parameters. See Admin Guide"></img></li><li>PBKDF2 <img src="../../../../../html/images/iconInfo.png" alt="PBKDF2 with configurable hash function and iteration count. See Admin Guide" title="PBKDF2 with configurable hash function and iteration count. See Admin Guide"></img></li><li>None <img src="../../../../../html/images/iconInfo.png" alt="The cipher is given a raw key conforming to the algorithm specifications" title="The cipher is given a raw key conforming to the algorithm specifications"></img></li></ul></td><td id="description">Specifies the key derivation function to generate the key from the password (and salt)</td></tr><tr><td id="name"><strong>Encryption Algorithm</strong></td><td id="default-value">MD5_128AES</td><td id="allowable-values"><ul><li>MD5_128AES <img src="../../../../../html/images/iconInfo.png" alt="org.apache.nifi.security.util.EncryptionMethod@487cd177[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="org.apache.nifi.security.util.EncryptionMethod@487cd177[Algorithm name=PBEWITHMD5AND128BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_192AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL ,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND192BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_256AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5AND256BITAES-CBC-OPENSSL,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_DES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with stro ng KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>MD5_RC2 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHMD5ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_RC2 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDRC2,Requires unlimited strength JCE policy=false,Al gorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA1_DES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA1ANDDES,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_192AES <img src ="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_256AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC2 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHS HAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC2 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC2-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_40RC4 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with s trong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND40BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_128RC4 <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND128BITRC4,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_128AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BITAES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND128BIT AES-CBC-BC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_192AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND192BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA256_256AES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHA256AND256BITAES-CBC-BC,Requires unlimited strength JCE policy=true,Algorithm Pro vider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_2KEYTRIPLEDES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND2-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>SHA_3KEYTRIPLEDES <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAAND3-KEYTRIPLEDES-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false ]"></img></li><li>SHA_TWOFISH <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PBEWITHSHAANDTWOFISH-CBC,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>PGP_ASCII_ARMOR <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unli mited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]" title="EncryptionMethod[Algorithm name=PGP-ASCII-ARMOR,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=false,Keyed cipher=false]"></img></li><li>AES_CBC <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/CBC/PKCS7Padding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_CTR <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algori thm name=AES/CTR/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li><li>AES_GCM <img src="../../../../../html/images/iconInfo.png" alt="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]" title="EncryptionMethod[Algorithm name=AES/GCM/NoPadding,Requires unlimited strength JCE policy=false,Algorithm Provider=BC,Compatible with strong KDFs=true,Keyed cipher=true]"></img></li></ul></td><td id="description">The Encryption Algorithm to use</td></tr><tr><td id="name"><strong>Allow insecure cryptographic modes</strong></td><td id="default-value">not-allowed</td><td id="allowable-values"><ul><li>Allowed <img src="../../../../../html/images/iconInfo.png" alt="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided" title="Operation will not be blocked and no alerts will be presented when unsafe combinations of encryption algorithms and passwords are provided"></img></li><li>Not Allowed <img src="../../../../../html/images/iconInfo.png" alt="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with limited strength crypto. To fix this, see the Admin Guide." title="When set, operation will be blocked and alerts will be presented to the user if unsafe combinations of encryption algorithms and passwords are provided on a JVM with limited strength crypto. To fix this, see the Admin Guide."></img></li></ul></td><td id="description">Overrides the default behavior to prevent unsafe combinations of encryption algorithms and short passwords on JVMs with limited strength cryptographic jurisdiction policies</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowab le-values"></td><td id="description">The Password to use for encrypting or decrypting the data<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Raw Key (hexadecimal)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In keyed encryption, this is the raw key, encoded in hexadecimal<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Public Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this keyring contains the public key of the recipient</td></tr><tr><td id="name">Public Key User Id</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP encrypt mode, this user id of the recipient</td></tr><tr><td id="name">Private Keyring File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this keyring contains the private key of the recipient</td></tr><t r><td id="name">Private Keyring Passphrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">In a PGP decrypt mode, this is the private keyring passphrase<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">PGP Symmetric Cipher</td><td id="default-value">7</td><td id="allowable-values"><ul><li>IDEA</li><li>TRIPLE_DES</li><li>CAST5</li><li>BLOWFISH</li><li>DES</li><li>AES_128</li><li>AES_192</li><li>AES_256</li><li>TWOFISH</li><li>CAMELLIA_128</li><li>CAMELLIA_192</li><li>CAMELLIA_256</li></ul></td><td id="description">When using PGP encryption, this is the symmetric cipher to be used. This property is ignored if Encryption Algorithm is not PGP or PGP-ASCII-ARMOR +Note that the provided cipher is only used duringthe encryption phase, while it is inferred from the ciphertext in the decryption phase</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any FlowFile that is successfully encrypted or decrypted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be encrypted or decrypted will be routed to failure</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3><table id="system-resource-considerations"><tr><th>Resource</th><th>Description</th></tr><tr><td>CPU</td><td>An instance of this component can cause high usage of this system resource. Multiple inst ances or high concurrency settings may result a degradation of performance.</td></tr></table></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EnforceOrder/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EnforceOrder/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EnforceOrder/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EnforceOrder/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EnforceOrder</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">EnforceOrder</h1><h2>Description: </h2><p>Enforces expected ordering of FlowFiles those belong to the same data group. Although PriorityAttributePrioritizer can be used on a connection to ensure that flow files going through that connection are in priority order, depending on error-handling, branching, and other flow designs, it is possible for FlowFiles to get out-of-order. EnforceOrder can be used to enforce original ordering for those FlowFiles. [IMPORTANT] In order to take effect of EnforceOrder, FirstInFirstOutPrioritizer should be used at EVERY downstream relationship UNTIL the order of Flow Files physically get FIXED by operation such as MergeContent or being stored to the final destination.</p><h3>Tags: </h3><p>sort, order</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../../../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Group Identifier</strong></td><td id="default-value">${filename}</td><td id="allowable-values"></td><td id="description">EnforceOrder is capable of multiple ordering groups. 'Group Identifier' is used to determine which group a FlowFile belongs to. This property will be evaluated with each incoming FlowFile. If evaluated result is empty, the FlowFile will be routed to failu re.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Order Attribute</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A name of FlowFile attribute whose value will be used to enforce order of FlowFiles within a group. If a FlowFile does not have this attribute, or its value is not an integer, the FlowFile will be routed to failure.</td></tr><tr><td id="name"><strong>Initial Order</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">When the first FlowFile of a group arrives, initial target order will be computed and stored in the managed state. After that, target order will start being tracked by EnforceOrder and stored in the state management store. If Expression Language is used but evaluated result was not an integer, then the FlowFile will be routed to failure, and initial order will be left unknown until consecutive FlowFiles provide a valid initial order.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name">Maximum Order</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, any FlowFiles that have larger order will be routed to failure. This property is computed only once for a given group. After a maximum order is computed, it will be persisted in the state management store and used for other FlowFiles belonging to the same group. If Expression Language is used but evaluated result was not an integer, then the FlowFile will be routed to failure, and maximum order will be left unknown until consecutive FlowFiles provide a valid maximum order.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Batch Count</strong></ td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">The maximum number of FlowFiles that EnforceOrder can process at an execution.</td></tr><tr><td id="name"><strong>Wait Timeout</strong></td><td id="default-value">10 min</td><td id="allowable-values"></td><td id="description">Indicates the duration after which waiting FlowFiles will be routed to the 'overtook' relationship.</td></tr><tr><td id="name"><strong>Inactive Timeout</strong></td><td id="default-value">30 min</td><td id="allowable-values"></td><td id="description">Indicates the duration after which state for an inactive group will be cleared from managed state. Group is determined as inactive if any new incoming FlowFile has not seen for a group for specified duration. Inactive Timeout must be longer than Wait Timeout. If a FlowFile arrives late after its group is already cleared, it will be treated as a brand new group, but will never match the order since expected preceding FlowFiles are already gone. The FlowFile will eventually timeout for waiting and routed to 'overtook'. To avoid this, group states should be kept long enough, however, shorter duration would be helpful for reusing the same group identifier again.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>overtook</td><td>A FlowFile that waited for preceding FlowFiles longer than Wait Timeout and overtook those FlowFiles, will be routed to this relationship.</td></tr><tr><td>skipped</td><td>A FlowFile that has an order younger than current, which means arrived too late and skipped, will be routed to this relationship.</td></tr><tr><td>success</td><td>A FlowFile with a matching order number will be routed to this relationship.</td></tr><tr><td>wait</td><td>A FlowFile with non matching order will be routed to this relationship</td></tr><tr><td>failure</td><td>A FlowFiles which does not have required attributes, or fails to compute those will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>EnforceOrder.startedAt</td><td>All FlowFiles going through this processor will have this attribute. This value is used to determine wait timeout.</td></tr><tr><td>EnforceOrder.result</td><td>All FlowFiles going through this processor will have this attribute denoting which relationship it was routed to.</td></tr><tr><td>EnforceOrder.detail</td><td>FlowFiles routed to 'failure' or 'skipped' relationship will have this attribute describing details.</td></tr><tr><td>EnforceOrder.expectedOrder</td><td>FlowFiles routed to 'wait' or 'skipped' relationship will have this attribute denoting expected order when the FlowFile was processed.</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>EnforceOrder uses following st ates per ordering group: '<groupId>.target' is a order number which is being waited to arrive next. When a FlowFile with a matching order arrives, or a FlowFile overtakes the FlowFile being waited for because of wait timeout, target order will be updated to (FlowFile.order + 1). '<groupId>.max is the maximum order number for a group. '<groupId>.updatedAt' is a timestamp when the order of a group was updated last time. These managed states will be removed automatically once a group is determined as inactive, see 'Inactive Timeout' for detail.</td></tr></table><h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/additionalDetails.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/additionalDetails.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1,31 @@ +<!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>EvaluateJsonPath</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <p> + <strong>Note:</strong> The underlying JsonPath library loads the entirety of the streamed content into and performs + result evaluations in memory. Accordingly, it is important to consider the anticipated profile of content being + evaluated by this processor and the hardware supporting it especially when working against large JSON documents. + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html?rev=1875518&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.4/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html Sun Mar 22 13:18:15 2020 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>EvaluateJsonPath</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">EvaluateJsonPath</h1><h2>Description: </h2><p>Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the property name is ignored). The value of the property must be a valid JsonPath expression. A Return Type o f 'auto-detect' will make a determination based off the configured destination. When 'Destination' is set to 'flowfile-attribute,' a return type of 'scalar' will be used. When 'Destination' is set to 'flowfile-content,' a return type of 'JSON' will be used.If the JsonPath evaluates to a JSON array or JSON object and the Return Type is set to 'scalar' the FlowFile will be unmodified and will be routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluates to the specified value and will be routed as a match.If Destination is 'flowfile-content' and the JsonPath does not evaluate to a defined path, the FlowFile will be routed to 'unmatched' without having its contents modified. If Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty strings as the value, and the FlowFile will always be routed to 'matched.'</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>JS ON, evaluate, JsonPath</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Destination</strong></td><td id="default-value">flowfile-content</td><td id="allowable-values"><ul><li>flowfile-content</li><li>flowfile-attribute</li></ul></td><td id="description">Indicates whether the results of the JsonPath evaluation are written to the FlowFile content or a FlowFile attribute; if using attribute, must specify the Attribute Name property. If set to flowfile-content, only one JsonPath may be specified, and the property name is ignored.</td></tr><tr><td id="name"><strong>Return Type</strong></td><td id="default-value">auto-detect</td><td id="allowable-values"><ul><li>auto-detect</li><li>jso n</li><li>scalar</li></ul></td><td id="description">Indicates the desired return type of the JSON Path expressions. Selecting 'auto-detect' will set the return type to 'json' for a Destination of 'flowfile-content', and 'scalar' for a Destination of 'flowfile-attribute'.</td></tr><tr><td id="name"><strong>Path Not Found Behavior</strong></td><td id="default-value">ignore</td><td id="allowable-values"><ul><li>warn</li><li>ignore</li></ul></td><td id="description">Indicates how to handle missing JSON path expressions when destination is set to 'flowfile-attribute'. Selecting 'warn' will generate a warning when a JSON path expression is not found.</td></tr><tr><td id="name"><strong>Null Value Representation</strong></td><td id="default-value">empty string</td><td id="allowable-values"><ul><li>empty string</li><li>the string 'null'</li></ul></td><td id="description">Indicates the desired representation of JSON Path expressions resulting in a null value.</td></tr></table><h3>Dynamic Pro perties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A FlowFile attribute(if <Destination> is set to 'flowfile-attribute')</td><td id="value">A JsonPath expression</td><td>If <Destination>='flowfile-attribute' then that FlowFile attribute will be set to any JSON objects that match the JsonPath. If <Destination>='flowfile-content' then the FlowFile content will be updated to any JSON objects that match the JsonPath.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when the JsonPath cannot be evaluated against the content of the FlowFile; for instance, if the FlowFile is not valid JSON</td></tr><tr><td>unmatched</td><td>FlowFiles are routed to this relationship when the JsonPath does not match the content of the FlowFile and the Destination is set to flowfile-content</td></tr><tr><td>matched</td><td>FlowFiles are routed to this relationship when the JsonPath is successfully evaluated and the FlowFile is modified as a result</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html> \ No newline at end of file
