http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html deleted file mode 100644 index aa5251d..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.CompressContent/index.html +++ /dev/null @@ -1,166 +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>CompressContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - <p> - This processor compresses and decompresses the contents of - FlowFiles using a user-specified compression algorithm. - </p> - - <p> - <strong>Uses Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>mime.type</td> - <td>If the <code>Compression Format</code> is set to <code>use mime.type attribute</code>, - this attribute is used to determine the compression type. Otherwise, this attribute is ignored.</td> - </tr> - </tbody> - </table> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>mime.type</td> - <td>If the <code>Mode</code> property is set to <code>compress</code>, the appropriate MIME Type is set. If the - <code>Mode</code> property is set to <code>decompress</code> and the file is successfully decompressed, - this attribute is removed, as the MIME Type is no longer known. - </td> - </tr> - </tbody> - </table> - - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. - </p> - - <ul> - <li> - <strong>Mode</strong> - <ul> - <li> - Indicates whether the processor should compress or decompress - content. Valid values are: - <ul> - <li>compress</li> - <li>decompress</li> - </ul> - </li> - <li>Default value: compress</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Compression Format</strong> - <ul> - <li> - The compression format to use. Valid values are: - <ul> - <li>gzip : GZIP compression format</li> - <li>bzip2 : BZIP2 compression format</li> - <li>xz-lzma2 : XZ-LZMA2 compression format</li> - <li>lzma : LZMA compression format</li> - <li> - use mime.type attribute : The compression format should be - determined by examining the - <code>mime.type</code> - attribute. - If the attribute is not present, the FlowFile will be routed to - 'failure'. If the attribute is present but does not denote - one of the supported compression formats, the FlowFile will be - routed to 'success' without being modified. This allows - CompressContent - to follow the - <a href="../org.apache.nifi.processors.standard.IdentifyMimeType/index.html">IdentifiyMimeType Processor</a> - so that files that are - compressed can automatically be decompressed and files that are not - compressed will continue on. - </li> - </ul> - </li> - <li>Default value: use mime.type attribute</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Compression Level</strong> - <ul> - <li>The compression level to use. This is valid only when using - the gzip compression format. A lower value results in faster - processing but less compression. A value of zero (0) indicates no - compression but simply archiving. Valid values are 0-9.</li> - <li>Default value: 1</li> - <li>Supports expression language: false.</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - failure - <ul> - <li>If FlowFiles fail to compress or decompress, then they follow - this relationship.</li> - </ul> - </li> - <li> - success - <ul> - <li>If FlowFiles are successfully compressed or decompressed, then - they follow this relationship.</li> - </ul> - </li> - </ul> - - </body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html deleted file mode 100644 index cbe1088..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ControlRate/index.html +++ /dev/null @@ -1,116 +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>ControlRate</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor controls the rate at which data is - transferred to follow-on processors. - </p> - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Rate Control Criteria</strong> - <ul> - <li>Indicates the criteria used to control the throughput rate. - Changing this value resets the rate counters. Possible values are: - <ul> - <li>data rate</li> - <li>flowfile count</li> - <li>attribute value</li> - </ul> - </li> - <li>Default value: data rate</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Maximum Rate</strong> - <ul> - <li>The maximum rate at which data should pass through this - processor. The format of this value is expected to be a - non-negative integer or, if the Rate Control Criteria is set to - data rate, a data size (such as 1MB).</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Rate Controlled Attribute - <ul> - <li>The name of an attribute whose values build toward the rate - limit if the Rate Control Criteria is set to attribute value. The - value of the attribute referenced by this property must be a - non-negative integer; otherwise, the flowfile will be routed to the - failure relationship. This value is ignored if the Rate Control - Criteria is not set to attribute value. Changing this value resets - the rate counters.</li> - <li>Default value: no default</li> - <li>Supports expression language: true.</li> - </ul> - </li> - <li><strong>Time Duration</strong> - <ul> - <li>The amount of time to which the Maximum Rate property - pertains. Changing this value resets the rate counters.</li> - <li>Default value: 1 min</li> - <li>Supports expression language: false.</li> - </ul></li> - <li>Grouping Attribute - <ul> - <li>By default, a single "throttle" is used for all FlowFiles. - If this value is specified, a separate throttle is used for each - value specified by the attribute with this name. Changing this - value resets the rate counters.</li> - <li>Default value: no default</li> - <li>Supports expression language: true.</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If FlowFiles are successfully processed, then they follow - this relationship.</li> - </ul> - </li> - </ul> - - - - - - - - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html deleted file mode 100644 index 9a88815..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ConvertCharacterSet/index.html +++ /dev/null @@ -1,65 +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>ConvertCharacterSet</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor converts a FlowFile's content from one - character set to another.</p> - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Input Character Set</strong> - <ul> - <li>The name of the character set to expect for the input.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Output Character Set</strong> - <ul> - <li>The name of the character set to convert to</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If a FlowFile's character set is successfully converted, - then it follows this relationship.</li> - </ul> - </li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html new file mode 100644 index 0000000..c0b65b9 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/additionalDetails.html @@ -0,0 +1,58 @@ +<!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>DetectDuplicate</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>original.flowfile.description</td> + <td>All FlowFiles routed to the <code>duplicate</code> + relationship will have an attribute added named <code>original.flowfile.description</code>. + 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> + </tbody> + </table> + + <p> + <strong>See Also:</strong> + </p> + <ul> + <li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li> + <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> + </ul> + + + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html deleted file mode 100644 index 87e066c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DetectDuplicate/index.html +++ /dev/null @@ -1,147 +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>DetectDuplicate</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - <p>This processor detects duplicate data by examining flow file attributes, - thus allowing the user to configure what it means for two FlowFiles to be - considered "duplicates". This processor does not read the contents of a - flow file, and is typically preceded by another processor which computes a - value based on the flow file content and adds that value to the flow file's - attributes; e.g. HashContent. Because this Processor needs to be able - to work within a NiFi cluster, it makes use of a distributed cache service to - determine whether or not the data has been seen previously.</p> - - <p> - If the processor is to be run on a standalone instance of - NiFi, that instance should have both a - DistributedMapCacheClient and a DistributedMapCacheServer configured - in its controller-services.xml file. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>original.flowfile.description</td> - <td>All FlowFiles routed to the <code>duplicate</code> - relationship will have an attribute added named <code>original.flowfile.description</code>. - 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> - </tbody> - </table> - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Distributed Cache Service</strong> - <ul> - <li>The Controller Service that is used to cache unique - identifiers which are used to determine duplicates</li> - <li>Default value: (None)</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Cache Entry Identifier</strong> - <ul> - <li>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</li> - <li>Default value: ${hash.value}</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>FlowFile Description</strong> - <ul> - <li>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</li> - <li>Default value:</li> - <li>Supports expression language: true</li> - </ul></li> - <li>Age Off Duration</strong> - <ul> - <li>Time interval to age off FlowFiles from the Distributed Cache Service; must specify time unit</li> - <li>Default value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>duplicate - <ul> - <li>If a FlowFile has been detected to be a duplicate, it will - be routed to this relationship. This FlowFile will have an - attribute named "original.flowfile.description" that provides - details about the original version of the FlowFile.</li> - </ul> - </li> - <li>non-duplicate - <ul> - <li>If a FlowFile's Cache Entry Identifier was not found in the - cache, it will be routed to this relationship. In this case, the - FlowFile's "description" (as defined by the <code>FlowFile - Description</code> property) will be stored in the cache. - </li> - </ul> - </li> - <li>failure - <ul> - <li>If unable to communicate with the cache or if the FlowFile does not - have the attribute identified by the Cache Entry Identifier, the FlowFile will - be penalized and routed to this relationship</li> - </ul> - </li> - </ul> - - - <p> - <strong>See Also:</strong> - </p> - <ul> - <li><a href="../org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">Distributed Map Cache Client Service</a></li> - <li><a href="../org.apache.nifi.distributed.cache.server.map.DistributedMapCacheServer/index.html">Distributed Map Cache Server</a></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html new file mode 100644 index 0000000..0c16e4f --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/additionalDetails.html @@ -0,0 +1,60 @@ +<!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>DistributeLoad</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Description:</h2> + <p>This processor distributes FlowFiles to downstream + processors based on a distribution strategy. The user may select the strategy "round robin", the + strategy "next available", or "load distribution service". If using the round robin + strategy, the default is to assign each destination (i.e., relationship) a weighting of 1 + (evenly distributed). However, the user may add optional properties to change this weighting. When + adding a property, the name must be a positive integer between 1 and the number of relationships (inclusive). + For example, if Number of Relationships has a value of 8 and a property is added with the name 5 + and the value 10, then relationship 5 (among the 8) will receive 10 + FlowFiles in each iteration instead of 1. All other relationships will receive 1 FlowFile in each iteration. + </p> + <strong>Properties:</strong> + <p>In the list below, the names of required properties appear + in bold. Any other properties (not in bold) are considered optional. + If a property has a default value, it is indicated. If a property + supports the use of the NiFi Expression Language (or simply, + "expression language"), that is also indicated.</p> + + <p> + <strong>Relationships:</strong> + </p> + <ul> + <li>1 + <ul> + <li>By default, there is one relationship, named 1. The number + of relationships is determined by the value of the <Number of + Relationships> property.</li> + </ul> + </li> + </ul> + + + + +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html deleted file mode 100644 index f1ca056..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.DistributeLoad/index.html +++ /dev/null @@ -1,106 +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>DistributeLoad</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - <p>This processor distributes FlowFiles to downstream - processors based on a distribution strategy. The user may select the strategy "round robin", the - strategy "next available", or "load distribution service". If using the round robin - strategy, the default is to assign each destination (i.e., relationship) a weighting of 1 - (evenly distributed). However, the user may add optional properties to change this weighting. When - adding a property, the name must be a positive integer between 1 and the number of relationships (inclusive). - For example, if Number of Relationships has a value of 8 and a property is added with the name 5 - and the value 10, then relationship 5 (among the 8) will receive 10 - FlowFiles in each iteration instead of 1. All other relationships will receive 1 FlowFile in each iteration. - </p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - - <ul> - <li><strong>Number of Relationships</strong> - <ul> - <li>The number of relationships to which the load should be - distributed. A valid value is a non-negative integer.</li> - <li>Default value: 1</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Distribution Strategy</strong> - <ul> - <li>This property determines how the load is distributed. If - the round robin strategy is used, the processor does not distribute - any FlowFiles unless all destinations can accept FlowFiles. If the - next available strategy is used, the processor distributes - FlowFiles as long as at least one destination can accept FlowFiles. - If the load distribution service is used, the processor ignores any - user specified optional properties, requires the service id of the - Load Distribution Service, and requires a list of fully qualified host - names, or FQDN's, which are the distribution end points. - Valid values are: - <ul> - <li>round robin</li> - <li>next available</li> - <li>load distribution service</li> - </ul> - </li> - <li>Default value: round robin</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Hostnames - this is required when using 'load distribution service' strategy - <ul> - <li>List of remote servers to distribute across. Each server must be FQDN and use either ',', ';', or 'space' as a delimiter</li> - <li>Default Value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Load Distribution Service ID - this is required when using 'load distribution service' strategy - <ul> - <li>The identifier of the Load Distribution Service</li> - <li>Default Value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>1 - <ul> - <li>By default, there is one relationship, named 1. The number - of relationships is determined by the value of the <Number of - Relationships> property.</li> - </ul> - </li> - </ul> - - - - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html deleted file mode 100644 index ed49aaa..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EncryptContent/index.html +++ /dev/null @@ -1,97 +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>EncryptContent</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor encrypts or decrypts FlowFiles. - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - - <ul> - <li><strong>Mode</strong> - <ul> - <li>This property specifies whether the content should be encrypted or decrypted. Valid values are: - <ul> - <li>Encrypt</li> - <li>Decrypt</li> - </ul></li> - <li>Default value: Encrypt</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Encryption Algorithm</strong> - <ul> - <li>The encryption algorithm to use. Valid values are available in the property's drop down menu; they include: - <ul> - <li>MD5_128AES - requires only 'strong encryption policies'</li> - <li>MD5_256AES - requires only 'strong encryption policies'</li> - <li>SHA1_RC2 - requires only 'strong encryption policies'</li> - <li>SHA1_DES - requires only 'strong encryption policies'</li> - <li>MD5_192AES - requires only 'strong encryption policies'</li> - <li>MD5_DES - requires only 'strong encryption policies'</li> - <li>MD5_RC2 - requires only 'strong encryption policies'</li> - <li>SHA_192AES - requires unlimited JCE policies</li> - <li>SHA_40RC4 - requires unlimited JCE policies</li> - <li>SHA256_128AES - requires unlimited JCE policies</li> - <li>SHA_128RC2 - requires unlimited JCE policies</li> - <li>SHA_128AES - requires unlimited JCE policies</li> - <li>SHA256_192AES - requires unlimited JCE policies</li> - <li>SHA_2KEYTRIPLEDES - requires unlimited JCE policies</li> - <li>SHA256_256AES - requires unlimited JCE policies</li> - <li>SHA_40RC2 - requires unlimited JCE policies</li> - <li>SHA_256AES - requires unlimited JCE policies</li> - <li>SHA_3KEYTRIPLEDES - requires unlimited JCE policies</li> - <li>SHA_TWOFISH - requires unlimited JCE policies</li> - <li>SHA_128RC4 - requires unlimited JCE policies</li> - </ul></li> - <li>Default value: MD5_256AES</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Password</strong> - <ul> - <li>The password to use for encrypting or decrypting the data. Passwords longer than 16 characters require unlimited JCE policies</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If a FlowFile cannot be encrypted or decrypted, then it follows this relationship</li> - </ul></li> - <li>success - <ul> - <li>If a FlowFile is successfully encrypted or decrypted, then it follows this relationship</li> - </ul></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html deleted file mode 100644 index 87a99db..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateRegularExpression/index.html +++ /dev/null @@ -1,160 +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>EvaluateRegularExpression</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor evaluates one or more Regular Expressions against the content of a FlowFile. - The results of those Regular Expressions are assigned to FlowFile Attributes. - Regular Expressions are entered by adding user-defined properties; - the name of the property maps to the Attribute Name into which the result will be placed. - The value of the property must be a valid Regular Expressions with exactly one capturing group. - If the Regular Expression matches more than once, only the first match will be used. - If any provided Regular Expression matches, the FlowFile(s) will be routed to 'matched'. - If no provided Regular Expression matches, the FlowFile will be routed to 'unmatched' and no attributes will be applied to the FlowFile. - - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <p> - This processor adds user-defined attributes. - </p> - - <ul> - <li><strong>Character Set</strong> - <ul> - <li>The character set in which the file is encoded.</li> - <li>Default value: UTF-8</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Maximum Buffer Size</strong> - <ul> - <li>Specifies the maximum amount of data to buffer (per file) in order to apply the regular expressions. Files larger than the specified maximum will not be fully evaluated.</li> - <li>Default value: 1MB</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Canonical Equivalence</strong> - <ul> - <li>Indicates that two characters match only when their full canonical decompositions match.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Case-insensitive Matching</strong> - <ul> - <li>Indicates that two characters match even if they are in a different case. Can also be specified via the embeded flag (?i).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Permit Whitespace and Comments in Pattern</strong> - <ul> - <li>In this mode, whitespace is ignored, and embedded comments starting with # are ignored until the end of a line. Can also be specified via the embeded flag (?x).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable DOTALL Mode</strong> - <ul> - <li>Indicates that the expression '.' should match any character, including a line terminator. Can also be specified via the embeded flag (?s).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Literal Parsing of the Pattern</strong> - <ul> - <li>Indicates that Metacharacters and escape characters should be given no special meaning.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Multiline Mode</strong> - <ul> - <li>Indicates that '^' and '$' should match just after and just before a line terminator or end of sequence, instead of only the begining or end of the entire input. - Can also be specified via the embeded flag (?m).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Unicode-aware Case Folding</strong> - <ul> - <li>When used with 'Enable Case-insensitive Matching', matches in a manner consistent with the Unicode Standard. Can also be specified via the embeded flag (?u).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Unicode Predefined Character Classes</strong> - <ul> - <li>Specifies conformance with the Unicode Technical Standard #18: Unicode Regular Expression Annex C: Compatibility Properties. Can also be specified via the embeded flag (?U).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li><strong>Enable Unix Lines Mode</strong> - <ul> - <li>Indicates that only the '\n' line terminator is recognized int the behavior of '.', '^', and '$'. Can also be specified via the embeded flag (?d).</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - - <li> - user-defined properties - <ul> - <li>The name of the attribute to put the Regular Expression result into.</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - matched - <ul> - <li>FlowFiles are routed to this relationship when the Regular Expression is successfully evaluated and the FlowFile is modified as a result.</li> - </ul> - </li> - <li> - unmatched - <ul> - <li>FlowFiles are routed to this relationship when no provided Regular Expression matches the content of the FlowFile.</li> - </ul> - </li> - </ul> - </p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html new file mode 100644 index 0000000..5fe58a5 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/additionalDetails.html @@ -0,0 +1,34 @@ +<!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>EvaluateXPath</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <p> + This processor adds user-defined attributes if the <Destination> property is set to + <code>flowfile-attribute</code>. + </p> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html deleted file mode 100644 index e1f0fa9..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXPath/index.html +++ /dev/null @@ -1,135 +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>EvaluateXPath</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor evaluates one or more XPaths against the content - of FlowFiles. The results of those XPaths are assigned to FlowFile - attributes or are written to the content of the FlowFile itself, - depending on how the user configures the Destination and Return Type properties in the - processor. XPaths are entered by adding user-defined properties; the - name of each user-added property maps to the attribute name into - which the result should be placed. The value of the property must be - a valid XPath expression. - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <p> - This processor adds user-defined attributes if the <Destination> property is set to - <code>flowfile-attribute</code>. - </p> - - - <ul> - <li> - <strong>Destination</strong> - <ul> - <li>Indicates whether the results of the XPath evaluation are - written to the FlowFile content or a FlowFile attribute; if using - attribute, the attribute's name must be specified in the value of - the Attribute Name property.</li> - <li> - Valid values are: - <ul> - <li>flowfile-content</li> - <li>flowfile-attribute</li> - </ul> - </li> - <li>Default value: flowfile-content</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Return Type</strong> - <ul> - <li>Indicates the desired return type of the Xpath expressions. - Selecting 'auto-detect' will set the return type to 'nodeset' for a - Destination of 'flowfile-content', and 'string' for a Destination of - 'flowfile-attribute'.")</li> - <li> - Valid values are: - <ul> - <li>auto-detect</li> - <li>nodeset</li> - <li>string</li> - </ul> - </li> - <li>Default value: auto-detect</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - user-defined properties - <ul> - <li>The name of the attribute to put the XPath result into if - flowfile-attribute is used as the value for the Destination - property; if using flowfile-content as the value for the - Destination property, this value is ignored.</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - failure - <ul> - <li>If the XPath cannot be evaluated against the content of the - FlowFile, then the FlowFile follows this relationship. For - example, if the FlowFile does not contain valid XML.</li> - </ul> - </li> - <li> - matched - <ul> - <li>If the XPath is successfully evaluated and the FlowFile is - modified as a result, then the FlowFile follows this - relationship.</li> - </ul> - </li> - <li> - unmatched - <ul> - <li>If the XPath does not match the content of the FlowFile, then - the FlowFile follows this relationship.</li> - </ul> - </li> - </ul> - </p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html new file mode 100644 index 0000000..3d120a4 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html @@ -0,0 +1,161 @@ +<!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>EvaluateXQuery</title> +<link rel="stylesheet" href="../../css/component-usage.css" + type="text/css" /> +</head> + + +<body> + + <!-- Processor Documentation ================================================== --> + + + <p> + <strong>Modifies Attributes:</strong> + </p> + + <p> + This processor adds user-defined attributes if the <Destination> + property is set to + <code>flowfile-attribute</code> + . + </p> + + + <p> + <strong>Examples:</strong> + </p> + + <p>This processor produces one attribute or FlowFile per + XQueryResult. If only one attribute or FlowFile is desired, the + following examples demonstrate how this can be achieved using the + XQuery language. The examples below reference the following sample + XML:</p> + + <pre> + <code> + <?xml version="1.0" encoding="UTF-8"?> + <?xml-stylesheet type="text/xsl" href="foo.xsl"?> + <ns:fruitbasket xmlns:ns="http://namespace/1"> + <fruit taste="crisp"> + <!-- Apples are my favorite--> + <name>apple</name> + <color>red</color> + </fruit> + <fruit> + <name>apple</name> + <color>green</color> + </fruit> + <fruit> + <name>banana</name> + <color>yellow</color> + </fruit> + <fruit taste="sweet"> + <name>orange</name> + <color>orange</color> + </fruit> + <fruit> + <name>blueberry</name> + <color>blue</color> + </fruit> + <fruit taste="tart"> + <name>raspberry</name> + <color>red</color> + </fruit> + <fruit> + <name>none</name> + <color/> + </fruit> + </ns:fruitbasket> +</code> + </pre> + + <p> + <ul> + <li>XQuery to return all "fruit" nodes individually (7 Results): + <ul> + <li>//fruit</li> + </ul> + </li> + <li>XQuery to return only the first "fruit" node (1 Result): + <ul> + <li>//fruit[1]</li> + </ul> + </li> + <li>XQuery to return only the last "fruit" node (1 Result): + <ul> + <li>//fruit[count(//fruit)]</li> + </ul> + </li> + <li>XQuery to return all "fruit" nodes, wrapped in a "basket" tag + (1 Result): + <ul> + <li><basket>{//fruit}</basket></li> + </ul> + </li> + <li>XQuery to return all "fruit" names individually (7 Results): + <ul> + <li>//fruit/text()</li> + </ul> + </li> + <li>XQuery to return only the first "fruit" name (1 Result): + <ul> + <li>//fruit[1]/text()</li> + </ul> + </li> + <li>XQuery to return only the last "fruit" name (1 Result): + <ul> + <li>//fruit[count(//fruit)]/text()</li> + </ul> + </li> + <li>XQuery to return all "fruit" names as a comma separated list + (1 Result): + <ul> + <li>string-join((for $x in //fruit return $x/name/text()), ', + ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a comma + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + ', ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a comma + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + ', ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a new line + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + '\n')</li> + </ul> + </li> + </ul> +</body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html deleted file mode 100644 index 7db8cba..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/index.html +++ /dev/null @@ -1,311 +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>EvaluateXQuery</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css"/> - </head> - - - <body> - - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - - <p>This processor evaluates one or more XQueries against the - content of FlowFiles. The results of those XQueries are assigned to - FlowFile attributes or are written to the content of the FlowFile - itself, depending on how the user configures the Destination property - in the processor. One attribute or FlowFile is produced for each XQuery - result. Each produced FlowFile will carry the attributes of the input - FlowFile. See the "Examples" section for details on how - multiple results can be wrapped or concatenated. XQueries are - entered by adding user-defined - properties; the name of each user-added property maps to the attribute - name into which the result should be placed. The value of the property - must be a valid XQuery expression. </p> - - <p> <strong>Properties:</strong> </p> - - <p> In the list below, the names of required properties - appear in bold. Any other properties (not in bold) are considered - optional. If a property has a default value, it is indicated. If a - property supports the use of the NiFi Expression Language (or - simply, "expression language"), that is also indicated. </p> - - <p> <strong>Modifies Attributes:</strong> </p> - - <p> This processor adds user-defined attributes if the - <Destination> property is set to <code>flowfile-attribute</code> - . </p> - - <ul> - - <li> <strong>Destination</strong> - <ul> - - <li>Indicates whether the results of the XQuery evaluation - are written to the FlowFile content or a FlowFile attribute; if using - attribute, the attribute's name must be specified in the value of the - Attribute Name property. </li> - - <li> Valid values are: - <ul> - - <li>flowfile-content</li> - - <li>flowfile-attribute</li> - - </ul> - - </li> - - <li>Default value: flowfile-content</li> - - <li>Supports expression language: false</li> - - </ul> - - </li> - - <li> <strong>Output: Method</strong> - <ul> - - <li>Identifies the overall method that should be used for - outputting a result tree. This property will be ignored if the result - of the XQuery is not a DOCUMENT or ELEMENT Node. </li> - - <li> Valid values are: - <ul> - - <li>xml</li> - - <li>html</li> - - <li>text</li> - - </ul> - - </li> - - <li>Default value: xml</li> - - <li>Supports expression language: false</li> - - </ul> - - </li> - - <li> <strong>Output: Omit XML Declaration</strong> - <ul> - - <li>Specifies whether the processor should output an XML - declaration when transforming a result tree. This property will be - ignored if the result of the XQuery is not a DOCUMENT or ELEMENT Node. </li> - - <li> Valid values are: - <ul> - - <li>true</li> - - <li>false</li> - - </ul> - - </li> - - <li>Default value: false</li> - - <li>Supports expression language: false</li> - - </ul> - - </li> - - <li> <strong>Output: Indent</strong> - <ul> - - <li>Specifies whether the processor may add additional - whitespace when outputting a result tree. This property will be ignored - if the result of the XQuery is not a DOCUMENT or ELEMENT Node. </li> - - <li> Valid values are: - <ul> - - <li>true</li> - - <li>false</li> - - </ul> - - </li> - - <li>Default value: false</li> - - <li>Supports expression language: false</li> - - </ul> - - </li> - - <li> user-defined properties - <ul> - - <li>The name of the attribute to put the XQuery result into - if flowfile-attribute is used as the value for the Destination - property; if using flowfile-content as the value for the Destination - property, this value is ignored. </li> - - <li>Supports expression language: false</li> - - </ul> - - </li> - - </ul> - - <p> <strong>Relationships:</strong> </p> - - <ul> - - <li> failure - <ul> - - <li>If the XQuery cannot be evaluated against the content - of the FlowFile, then the FlowFile follows this relationship. For - example, if the FlowFile does not contain valid XML. </li> - - </ul> - - </li> - - <li> matched - <ul> - - <li>If the XQuery is successfully evaluated and the - FlowFile is modified as a result, then the FlowFile follows this - relationship. </li> - - </ul> - - </li> - - <li> unmatched - <ul> - - <li>If the XQuery does not match the content of the - FlowFile, then the FlowFile follows this relationship. </li> - - </ul> - - </li> - - </ul> - - <p> <strong>Examples:</strong> </p> - - <p> This processor produces one attribute or FlowFile per - XQueryResult. If only one attribute or FlowFile is desired, the following - examples demonstrate how this can be achieved using the XQuery - language. The examples below reference the following sample XML:</p> - - <pre><code> - <?xml version="1.0" encoding="UTF-8"?> - <?xml-stylesheet type="text/xsl" href="foo.xsl"?> - <ns:fruitbasket xmlns:ns="http://namespace/1"> - <fruit taste="crisp"> - <!-- Apples are my favorite--> - <name>apple</name> - <color>red</color> - </fruit> - <fruit> - <name>apple</name> - <color>green</color> - </fruit> - <fruit> - <name>banana</name> - <color>yellow</color> - </fruit> - <fruit taste="sweet"> - <name>orange</name> - <color>orange</color> - </fruit> - <fruit> - <name>blueberry</name> - <color>blue</color> - </fruit> - <fruit taste="tart"> - <name>raspberry</name> - <color>red</color> - </fruit> - <fruit> - <name>none</name> - <color/> - </fruit> - </ns:fruitbasket> -</code></pre> - - <p> - <ul> - <li> - XQuery to return all "fruit" nodes individually (7 Results): - <ul><li>//fruit</li></ul> - </li> - <li> - XQuery to return only the first "fruit" node (1 Result): - <ul><li>//fruit[1]</li></ul> - </li> - <li> - XQuery to return only the last "fruit" node (1 Result): - <ul><li>//fruit[count(//fruit)]</li></ul> - </li> - <li> - XQuery to return all "fruit" nodes, wrapped in a "basket" tag (1 Result): - <ul><li><basket>{//fruit}</basket></li></ul> - </li> - <li> - XQuery to return all "fruit" names individually (7 Results): - <ul><li>//fruit/text()</li></ul> - </li> - <li> - XQuery to return only the first "fruit" name (1 Result): - <ul><li>//fruit[1]/text()</li></ul> - </li> - <li> - XQuery to return only the last "fruit" name (1 Result): - <ul><li>//fruit[count(//fruit)]/text()</li></ul> - </li> - <li> - XQuery to return all "fruit" names as a comma separated list (1 Result): - <ul><li>string-join((for $x in //fruit return $x/name/text()), ', ')</li></ul> - </li> - <li> - XQuery to return all "fruit" colors and names as a comma separated list (1 Result): - <ul><li>string-join((for $y in (for $x in //fruit return string-join(($x/color/text() , $x/name/text()), ' ')) return $y), ', ')</li></ul> - </li> - <li> - XQuery to return all "fruit" colors and names as a comma separated list (1 Result): - <ul><li>string-join((for $y in (for $x in //fruit return string-join(($x/color/text() , $x/name/text()), ' ')) return $y), ', ')</li></ul> - </li> - <li> - XQuery to return all "fruit" colors and names as a new line separated list (1 Result): - <ul><li>string-join((for $y in (for $x in //fruit return string-join(($x/color/text() , $x/name/text()), ' ')) return $y), '\n')</li></ul> - </li> - </ul> - </p> -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html new file mode 100644 index 0000000..0aa703b --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/additionalDetails.html @@ -0,0 +1,57 @@ +<!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>ExecuteStreamCommand</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Creates Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>execution.command</td> + <td>The name of the command executed to create the new FlowFile</td> + </tr> + <tr> + <td>execution.command.args</td> + <td>The semi-colon delimited list of arguments</td> + </tr> + <tr> + <td>execution.status</td> + <td>The exit status code returned from executing the command</td> + </tr> + <tr> + <td>execution.error</td> + <td>Any error messages returned from executing the command</td> + </tr> + </tbody> + </table> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html deleted file mode 100644 index 94d0f03..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteStreamCommand/index.html +++ /dev/null @@ -1,111 +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>ExecuteStreamCommand</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2> Description:</h2> - <p>This processor executes an external command on the contents of a FlowFile, and creates a new FlowFile with the - results of the command.</p> - <p> - <strong>Creates Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>execution.command</td> - <td>The name of the command executed to create the new FlowFile</td> - </tr> - <tr> - <td>execution.command.args</td> - <td>The semi-colon delimited list of arguments</td> - </tr> - <tr> - <td>execution.status</td> - <td>The exit status code returned from executing the command</td> - </tr> - <tr> - <td>execution.error</td> - <td>Any error messages returned from executing the command</td> - </tr> - </tbody> - </table> - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - <ul> - <li><strong>Command Path</strong> - <ul> - <li>Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's - environment PATH.</li> - <li>Default value: none</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Command Arguments - <ul> - <li>The arguments to supply to the executable delimited by the ';' character. Each argument may be an Expression Language - statement.</li> - <li>Default value: none</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>Working Directory - <ul> - <li>The directory to use as the current working directory when executing the command. If the directory does not exist, - then the process's current working directory will be used.</li> - <li>Default value: none (which means whatever NiFi's current working directory is...probably the root of the NiFi - installation directory.)</li> - <li>Supports expression language: true</li> - </ul> - </li> - - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>original - <ul> - <li>The destination path for the original incoming FlowFile. This FlowFile will have the created attributes listed above.</li> - </ul> - </li> - <li>output-stream - <ul> - <li>The destination path for the FlowFile created from the command's output. This FlowFile will have the created attributes listed above.</li> - </ul> - </li> - </ul> - </body> -</html>
