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.GenerateFlowFile/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html deleted file mode 100644 index ef1f26b..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GenerateFlowFile/index.html +++ /dev/null @@ -1,64 +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>GenerateFlowFile</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor creates FlowFiles of random data to be used for load testing purposes. - </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>File Size</strong> - <ul> - <li>The file size for each generated FlowFile. The value must be a non-negative integer, followed by a data unit, such as B, KB, MB, GB, TB. Example: 3 KB.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Batch Size</strong> - <ul> - <li>The number of FlowFiles to be transferred in each invocation. The value must be a non-negative integer.</li> - <li>Default value: 1</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If FlowFiles are successfully generated, 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.GetFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html new file mode 100644 index 0000000..92d69fd --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/additionalDetails.html @@ -0,0 +1,74 @@ +<!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>GetFTP</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>filename</td> + <td>The filename is set to the name of the file on the remote server</td> + </tr> + <tr> + <td>path</td> + <td>The path is set to the path of the file's + directory on the remote server. For example, if the <Remote Path> + property is set to <code>/tmp</code>, files picked up from /tmp + will have the path attribute set to <code>/tmp</code>. If the + <Search Recursively> property is set to <code>true</code> + and a file is picked up from /tmp/abc/1/2/3, then the path + attribute will be set to <code>/tmp/abc/1/2/3</code></td> + </tr> + <tr> + <td>file.lastModifiedTime</td> + <td>The date and time that the source file was last modified.</td> + </tr> + <tr> + <td>file.owner</td> + <td>The numeric owner id of the source file.</td> + </tr> + <tr> + <td>file.group</td> + <td>The numeric group id of the source file.</td> + </tr> + <tr> + <td>file.permissions</td> + <td>The read/write/execute permissions of the source file.</td> + </tr> + <tr> + <td>absolute.path</td> + <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</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.GetFTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html deleted file mode 100644 index e5d3af9..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFTP/index.html +++ /dev/null @@ -1,227 +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>GetFTP</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor fetches files from an FTP server and creates - FlowFiles from them.</p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>filename</td> - <td>The filename is set to the name of the file on the remote server</td> - </tr> - <tr> - <td>path</td> - <td>The path is set to the path of the file's - directory on the remote server. For example, if the <Remote Path> - property is set to <code>/tmp</code>, files picked up from /tmp - will have the path attribute set to <code>/tmp</code>. If the - <Search Recursively> property is set to <code>true</code> - and a file is picked up from /tmp/abc/1/2/3, then the path - attribute will be set to <code>/tmp/abc/1/2/3</code></td> - </tr> - <tr> - <td>file.lastModifiedTime</td> - <td>The date and time that the source file was last modified.</td> - </tr> - <tr> - <td>file.owner</td> - <td>The numeric owner id of the source file.</td> - </tr> - <tr> - <td>file.group</td> - <td>The numeric group id of the source file.</td> - </tr> - <tr> - <td>file.permissions</td> - <td>The read/write/execute permissions of the source file.</td> - </tr> - <tr> - <td>absolute.path</td> - <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</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>Hostname</strong> - <ul> - <li>The fully qualified hostname or IP address of the remote - system.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Port</strong> - <ul> - <li>The port that the remote system is listening on for file transfers.</li> - <li>Default value: 21</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Username</strong> - <ul> - <li>The username for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Password - <ul> - <li>The password for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Connection Mode - <ul> - <li>The FTP connection mode. Valid options are: Active or Passive. For most clients, this should be set to Passive.</li> - <li>Default value: Passive</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Transfer Mode - <ul> - <li>The FTP transfer mode. Valid options are: Binary or ASCII.</li> - <li>Default value: Binary</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Remote Path - <ul> - <li>The path on the remote system from which to pull files. If - not specified, the user's home directory will be used.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>File Filter Regex - <ul> - <li>A Java regular expression for filtering filenames to - determine which files to pick up. If a filter is supplied, only - files whose names match the regular expression are picked up.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Polling Interval</strong> - <ul> - <li>Determines how long to wait before fetching the listing for - new files. The unit of measure, such as sec for seconds or min for minutes, must be specified.</li> - <li>Default value: 60 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Search Recursively</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to - traverse subdirectories and pull files from them.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Ignore Dotted Files</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to ignore - files whose names begin with a dot (.), and, therefore, not pick - them up.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Delete Original</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to delete - the original copy of the file on the remote system after it has - been transferred.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating - a connection. The unit of measure, such as sec for seconds or min for minutes, must be specified.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while - transferring data. The unit of measure, such as sec for seconds or min for minutes, must be specified.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Max Selects</strong> - <ul> - <li>The maximum number of files to pull in a single connection. - </li> - <li>Default value: 100</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Remote Poll Batch Size</strong> - <ul> - <li>The given value specifies how many file paths to find in a - given directory on the remote system when doing a file listing. - This value should not need to be modified in general; however, when - polling against a remote system with a significantly large number - of files, this value can be critical. Setting this value too high - can result in very poor performance, while setting it too low can - cause the flow to be slower than usual.</li> - <li>Default value: 5000</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Use Natural Ordering</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to pull - files in the order in which they are naturally listed. If false, - the order in which to pull files is not defined.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If FlowFiles are successfully retrieved by FTP, 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.GetFile/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html new file mode 100644 index 0000000..76046c6 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/additionalDetails.html @@ -0,0 +1,79 @@ +<!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>GetFile</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>filename</td> + <td>The filename is set to the name of the file on disk</td> + </tr> + <tr> + <td>path</td> + <td>The path is set to the relative path of the file's directory on disk. For example, if the <Input Directory> + property is set to <code>/tmp</code>, files picked up from /tmp will have the path attribute set to <code>./</code>. + If the <Recurse Subdirectories> property is set to <code>true</code> and a file is picked up + from /tmp/abc/1/2/3, then the path attribute will be set to <code>abc/1/2/3</code> + </tr> + <tr> + <td>file.creationTime</td> + <td>The date and time that the file was created. May not work on all file systems</td> + </tr> + <tr> + <td>file.lastModifiedTime</td> + <td>The date and time that the file was last modified. May not work on all file systems</td> + </tr> + <tr> + <td>file.lastAccessTime</td> + <td>The date and time that the file was last accessed. May not work on all file systems</td> + </tr> + <tr> + <td>file.owner</td> + <td>The owner of the file. May not work on all file systems</td> + </tr> + <tr> + <td>file.group</td> + <td>The group owner of the file. May not work on all file systems</td> + </tr> + <tr> + <td>file.permissions</td> + <td>The read/write/execute permissions of the file. May not work on all file systems</td> + </tr> + <tr> + <td>absolute.path</td> + <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</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.GetFile/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html deleted file mode 100644 index 9faa128..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetFile/index.html +++ /dev/null @@ -1,186 +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>GetFile</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor obtains FlowFiles from a local directory. NiFi will need at least read permissions on the files it will pull otherwise it will ignore them.</p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>filename</td> - <td>The filename is set to the name of the file on disk</td> - </tr> - <tr> - <td>path</td> - <td>The path is set to the relative path of the file's directory on disk. For example, if the <Input Directory> - property is set to <code>/tmp</code>, files picked up from /tmp will have the path attribute set to <code>./</code>. - If the <Recurse Subdirectories> property is set to <code>true</code> and a file is picked up - from /tmp/abc/1/2/3, then the path attribute will be set to <code>abc/1/2/3</code> - </tr> - <tr> - <td>file.creationTime</td> - <td>The date and time that the file was created. May not work on all file systems</td> - </tr> - <tr> - <td>file.lastModifiedTime</td> - <td>The date and time that the file was last modified. May not work on all file systems</td> - </tr> - <tr> - <td>file.lastAccessTime</td> - <td>The date and time that the file was last accessed. May not work on all file systems</td> - </tr> - <tr> - <td>file.owner</td> - <td>The owner of the file. May not work on all file systems</td> - </tr> - <tr> - <td>file.group</td> - <td>The group owner of the file. May not work on all file systems</td> - </tr> - <tr> - <td>file.permissions</td> - <td>The read/write/execute permissions of the file. May not work on all file systems</td> - </tr> - <tr> - <td>absolute.path</td> - <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</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>Input Directory</strong> - <ul> - <li>The input directory from which to pull files.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>File Filter</strong> - <ul> - <li>Only files whose names match the given regular expression - are picked up.</li> - <li>Default value: [^\.].*</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Keep Source File</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to leave a - copy of the file in the input directory after retrieving it; this - causes the file to be picked up continually and is useful for - testing purposes. If not keeping source file NiFi will need - at least write permissions to the directory it is pulling from - otherwise it will ignore the file.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Recurse Subdirectories</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to pull - files from subdirectories.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Polling Interval</strong> - <ul> - <li>The amount of time to wait between directory listings. Valid values must be non-negative integers - followed by a time unit, such as nanos, millis, secs, mins, hrs, days. <b>NOTE:</b> If a directory - listing is empty, the processor will yield for the full yield duration and will not poll during that - time. - </li> - <li>Default value: 0 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Ignore Hidden Files</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to ignore - hidden files.</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Minimum File Age</strong> - <ul> - <li>The minimum age that a file must be in order to be pulled; - any file younger than this amount of time (according to the last - modification date) will be ignored.</li> - <li>Default value: 0 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum File Age - <ul> - <li>The maximum age that a file must be in order to be pulled; - any file older than this amount of time (according to the last - modification date) will be ignored. The value must be a - non-negative integer, followed by a time unit, such as nanos, - millis, secs, mins, hrs, days.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Minimum File Size</strong> - <ul> - <li>The minimum size that a file must be in order to be pulled.</li> - <li>Default value: 0 B</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum File Size - <ul> - <li>The maximum size that a file must be in order to be pulled. - The value must be a non-negative integer followed by a data size - unit, such as B, KB, MB, GB, TB.</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 FlowFiles are successfully selected, 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.GetHTTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html new file mode 100644 index 0000000..94f639b --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/additionalDetails.html @@ -0,0 +1,45 @@ +<!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>GetHTTP</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Description:</h2> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>filename</td> + <td>The filename is set to the name of the file on the remote server</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.GetHTTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html deleted file mode 100644 index 37eb479..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetHTTP/index.html +++ /dev/null @@ -1,143 +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>GetHTTP</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor fetches files via HTTP and creates FlowFiles - from them. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>filename</td> - <td>The filename is set to the name of the file on the remote server</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>URL</strong> - <ul> - <li>The URL from which to pull files</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Filename</strong> - <ul> - <li>The filename to assign to the file when pulled.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>SSL Context Service - <ul> - <li>The Controller Service to use for obtaining an SSL Context. The SSL Context controller service is a mechanism for providing all the security properties that allow for secure communications between NiFi extensions and other systems. See the User Guide or the Controller Services documentation via the "help" link in the upper-right corner of the GUI for more information about the StandardSSLContextService. The value for this property is the identifier name that is configured in the StandardSSLContextService.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Username - <ul> - <li>The username required to access the URL.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Password - <ul> - <li>The password required to access the URL.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating - a connection.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while - transferring data.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li>User Agent - <ul> - <li>What to report as the user agent when a connection is made - to the remote server.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Accept Content-Type - <ul> - <li>If specified, requests will only accept the provided - Content-Type.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Follow Redirects - <ul> - <li>A Boolean value (true/false), indicating whether to follow - the redirect provided by the remote server if that server if that - server sends a 3XX HTTP status code.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>All incoming FlowFiles 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.GetJMSQueue/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html deleted file mode 100644 index bcbf0dd..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSQueue/index.html +++ /dev/null @@ -1,118 +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>GetJMSQueue</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor pulls messages from a JMS Queue, creating a FlowFile for each JMS message or bundle of messages, as configured. - </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>JMS Provider</strong> - <ul> - <li>This property specifies the provider used for the JMS server. Available options include: - <ul> - <li>ActiveMQ</li> - </ul></li> - <li>Default value: ActiveMQ</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>URL</strong> - <ul> - <li>The URL of the JMS server.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Destination Name</strong> - <ul> - <li>The name of the JMS queue to use.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Communications Timeout</strong> - <ul> - <li>The amount of time to wait when attempting to receive a message before giving up and assuming failure.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Message Batch Size</strong> - <ul> - <li>The number of messages to pull in a single iteration of the processor.</li> - <li>Default value: 10</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Username - <ul> - <li>The username used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Password - <ul> - <li>The password used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Acknowledgement Mode</strong> - <ul> - <li>The JMS acknowledgement Mode. Two options exist: Client Acknowledge and Auto Acknowledge. Using Auto Acknowledge can cause messages to be lost upon a restart of NiFi but may provide better performance than Client Acknowledge.</li> - <li>Default value: Client Acknowledge</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Message Selector - <ul> - <li>The JMS Message Selector to use in order to narrow the messages that are pulled.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Copy of JMS Properties Attributes</strong> - <ul> - <li>A Boolean value (true/false), indicating whether the JMS Message Properties should be copied to the FlowFile attributes; if so, each attribute name will be jms.XXX, where XXX is the JMS Property name. </li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Client ID Prefix</strong> - <ul> - <li>A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS server know who to contact if problems arise.</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>All incoming FlowFiles 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.GetJMSTopic/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html deleted file mode 100644 index 3496df8..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetJMSTopic/index.html +++ /dev/null @@ -1,122 +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>GetJMSTopic</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor pulls messages from a JMS Topic, creating a FlowFile for each JMS message or bundle of messages, as configured. - </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>JMS Provider</strong> - <ul> - <li>This property specifies the provider used for the JMS server. Available options include: - <ul> - <li>ActiveMQ</li> - </ul></li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>URL</strong> - <ul> - <li>The URL of the JMS server.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Destination Name</strong> - <ul> - <li>The name of the JMS topic to use.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Communications Timeout</strong> - <ul> - <li>The amount of time to wait when attempting to receive a message before giving up and assuming failure.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Message Batch Size</strong> - <ul> - <li>The number of messages to pull in a single iteration of the processor.</li> - <li>Default value: 10</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Username - <ul> - <li>The username used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Password - <ul> - <li>The password used for authentication and authorization.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Acknowledgement Mode</strong> - <ul> - <li>The JMS acknowledgement Mode. Two options exist: Client Acknowledge and Auto Acknowledge. Using Auto Acknowledge can cause messages to be lost upon a restart of NiFi but may provide better performance than Client Acknowledge.</li> - <li>Default value: Client Acknowledge</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Message Selector - <ul> - <li>The JMS Message Selector to use in order to narrow the messages that are pulled.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Copy of JMS Properties Attributes</strong> - <ul> - <li>A Boolean value (true/false), indicating whether the JMS Message Properties should be copied to the FlowFile attributes; if so, each attribute name will be jms.XXX, where XXX is the JMS Property name. </li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Client ID Prefix</strong> - <ul> - <li>A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS server know who to contact if problems arise.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Use Durable Subscription</strong> - <ul> - <li>A Boolean value (true/false), indicating whether connections to the specified topic will use Durable Subscription so that messages are queued when NiFi is not pulling them. </li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>All incoming FlowFiles 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.GetSFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html new file mode 100644 index 0000000..8cb6526 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/additionalDetails.html @@ -0,0 +1,80 @@ +<!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>GetSFTP</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>filename</td> + <td>The filename is set to the name of the file on the remote server</td> + </tr> + <tr> + <td>path</td> + <td>The path is set to the path of the file's + directory on the remote server. For example, if the <Remote Path> + property is set to <code>/tmp</code>, files picked up from /tmp + will have the path attribute set to <code>/tmp</code>. If the + <Search Recursively> property is set to <code>true</code> + and a file is picked up from /tmp/abc/1/2/3, then the path + attribute will be set to <code>/tmp/abc/1/2/3</code></td> + </tr> + <tr> + <td>file.lastModifiedTime</td> + <td>The date and time that the source file was last modified.</td> + </tr> + <tr> + <td>file.owner</td> + <td>The numeric owner id of the source file.</td> + </tr> + <tr> + <td>file.group</td> + <td>The numeric group id of the source file.</td> + </tr> + <tr> + <td>file.permissions</td> + <td>The read/write/execute permissions of the source file.</td> + </tr> + <tr> + <td>absolute.path</td> + <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</td> + </tr> + </tbody> + </table> + <p> + <strong>See Also:</strong> + <ul> + <li><a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</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.GetSFTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html deleted file mode 100644 index 708f5a3..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.GetSFTP/index.html +++ /dev/null @@ -1,250 +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>GetSFTP</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor pulls files from an SFTP server and creates - FlowFiles to encapsulate them. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>filename</td> - <td>The filename is set to the name of the file on the remote server</td> - </tr> - <tr> - <td>path</td> - <td>The path is set to the path of the file's - directory on the remote server. For example, if the <Remote Path> - property is set to <code>/tmp</code>, files picked up from /tmp - will have the path attribute set to <code>/tmp</code>. If the - <Search Recursively> property is set to <code>true</code> - and a file is picked up from /tmp/abc/1/2/3, then the path - attribute will be set to <code>/tmp/abc/1/2/3</code></td> - </tr> - <tr> - <td>file.lastModifiedTime</td> - <td>The date and time that the source file was last modified.</td> - </tr> - <tr> - <td>file.owner</td> - <td>The numeric owner id of the source file.</td> - </tr> - <tr> - <td>file.group</td> - <td>The numeric group id of the source file.</td> - </tr> - <tr> - <td>file.permissions</td> - <td>The read/write/execute permissions of the source file.</td> - </tr> - <tr> - <td>absolute.path</td> - <td>The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path.</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>Hostname</strong> - <ul> - <li>The fully qualified hostname or IP address of the remote - system.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Port</strong> - <ul> - <li>The port that the remote system is listening on for file transfers.</li> - <li>Default value: 22</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Username</strong> - <ul> - <li>The username for the user account on the remote system.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Password - <ul> - <li>The password for the user account.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Private Key Path - <ul> - <li>The fully qualified path for the private key file.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Private Key Passphrase - <ul> - <li>The password for the private key.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Remote Path - <ul> - <li>The path on the remote system from which to pull files. If - not specified, the user's home directory will be used.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li>File Filter Regex - <ul> - <li>Provides a Java Regular Expression for filtering Filenames; if a filter is supplied, only files - whose names match that Regular Expression will be fetched</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Polling Interval</strong> - <ul> - <li>Determines how long to wait between fetching the listing for new files</li> - <li>Default value: 60 secs</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Search Recursively</strong> - <ul> - <li>If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Ignore Dotted Files</strong> - <ul> - <li>If true, files whose names begin with a dot (\".\") will be ignored</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Delete Original</strong> - <ul> - <li>Determines whether or not the file is deleted from the remote system after it has been successfully transferred</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating a connection.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Data Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while - transferring data.</li> - <li>Default value: 30 sec</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Host Key File - <ul> - <li>The local file path to the host key file; if not supplied, - no host key file will be used.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Max Selects</strong> - <ul> - <li>The maximum number of files to pull in a single connection.</li> - <li>Default value: 100</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Remote Poll Batch Size</strong> - <ul> - <li>The value specifies how many file paths to find in a given directory on the remote system when - doing a file listing. This value in general should not need to be modified but when polling against a - remote system with a tremendous number of files this value can be critical. Setting this value too high - can result very poor performance and setting it too low can cause the flow to be slower than normal.</li> - <li>Default value: 5000</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Strict Host Key Checking</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to apply - strict enforcement of host keys.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Use Compression</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to use - ZLIB compression when transferring files.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Use Natural Ordering</strong> - <ul> - <li>If true, will pull files in the order in which they are naturally listed; otherwise, the order in - which the files will be pulled is not defined</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If FlowFiles are successfully transferred, then they follow - this relationship.</li> - </ul> - </li> - </ul> - - <p> - <strong>See Also:</strong> - <ul> - <li><a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a></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.HashAttribute/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html new file mode 100644 index 0000000..165568c --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/additionalDetails.html @@ -0,0 +1,35 @@ +<!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>HashAttribute</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 an attribute whose value is the result of Hashing the existing FlowFile attributes. + The name of this attribute is specified by the <Hash Value Attribute Key> property. + </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.HashAttribute/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html deleted file mode 100644 index a2d4fd2..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashAttribute/index.html +++ /dev/null @@ -1,88 +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>HashAttribute</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2> Description:</h2> - <p>This processor hashes together the key/value pairs of - several FlowFile attributes and adds the hash as a new attribute. The - user may add optional properties such that the name of each property - is the name of a FlowFile attribute to consider and the value of the - property is a regular expression that, if matched by the attribute - value, causes that attribute to be used as part of the hash. If the - regular expression contains a capturing group, only the value of the - capturing group is used. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <p> - This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. - The name of this attribute is specified by the <Hash Value Attribute Key> property. - </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>Hash Value Attribute Key</strong> - <ul> - <li>The name of the FlowFile attribute whose hash value should - be stored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>User-Added Properties - <ul> - <li>See description above.</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If the processor successfully hashes the key/value pairs of - the FlowFile, then the FlowFile follows this relationship.</li> - </ul> - </li> - <li>failure - <ul> - <li>If something prevents the processor from successfully - hashing the key/value pairs of the FlowFile, then the FlowFile - 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.HashContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html new file mode 100644 index 0000000..8a3d1cb --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/additionalDetails.html @@ -0,0 +1,35 @@ +<!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>HashContent</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 an attribute whose value is the result of Hashing the existing FlowFile attributes. + The name of this attribute is specified by the <Hash Attribute Name> property. + </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.HashContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html deleted file mode 100644 index a14265f..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HashContent/index.html +++ /dev/null @@ -1,89 +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>HashContent</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor calculates a hash value for the content of a - FlowFile and puts the hash value on the FlowFile as an attribute whose - name is determined by the <strong>Hash Attribute Name</strong> - property. - </p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <p> - This Processor adds an attribute whose value is the result of Hashing the existing FlowFile attributes. - The name of this attribute is specified by the <Hash Attribute Name> property. - </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>Hash Attribute Name</strong> - <ul> - <li>The name of the FlowFile attribute to which the hash value - should be written. If the value already exists, it will be - overwritten.</li> - <li>Default value: hash.value</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Hash Algorithm</strong> - <ul> - <li>The hashing algorithm that should be used to perform the - hashing function.</li> - <li>Default value: MD5</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If the FlowFile is processed successfully, then the - FlowFile follows this relationship.</li> - </ul> - </li> - <li>failure - <ul> - <li>If the FlowFile is not processed successfully, then the - FlowFile follows this relationship.</li> - </ul> - </li> - </ul> - - -</body> -</html>
