Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFTP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFTP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches files from an FTP Server and creates FlowFiles from them</p><h3>Tags: </h3><p>FTP, get, retrieve, files, fetch, remote, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</ th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">21</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Connection Mode</td><td id="default-value">Passive</td><td id="allowable-values"><ul><li>Active</li><li >Passive</li></ul></td><td id="description">The FTP Connection >Mode</td></tr><tr><td id="name">Transfer Mode</td><td >id="default-value">Binary</td><td >id="allowable-values"><ul><li>Binary</li><li>ASCII</li></ul></td><td >id="description">The FTP Transfer Mode</td></tr><tr><td id="name">Remote >Path</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The path on the remote system from which to pull or push >files<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">File Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Provides a Java Regular Expression for filtering Filenames; >if a filter is supplied, only files whose names match that Regular Expression >will be fetched</td></tr><tr><td id="name">Path Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">When Search Recursively is true, then only subdirectories >whose path matches the giv en Regular Expression will be scanned</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">60 sec</td><td id="allowable-values"></td><td id="description">Determines how long to wait between fetching the listing for new files</td></tr><tr><td id="name"><strong>Search Recursively</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories</td></tr><tr><td id="name"><strong>Ignore Dotted Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, files whose names begin with a dot (".") will be ignored</td></tr><tr><td id="name"><strong>Delete Original</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">De termines whether or not the file is deleted from the remote system after it has been successfully transferred</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Max Selects</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in a single connection</td></tr><tr><td id="name"><strong>Remote Poll Batch Size</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="descriptio n">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.</td></tr><tr><td id="name"><strong>Use Natural Ordering</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, 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</td></tr><tr><td id="name">Proxy Type</td><td id="default-value">DIRECT</td><td id="allowable-values"><ul><li>DIRECT</li><li>HTTP</li><li>SOCKS</li></ul></td><td id="description">Proxy type used for file transfers</td></tr><tr><td id="name">Proxy Host</td>< td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name">Http Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Username</td></tr><tr><td id="name">Http Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Password<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>fi lename</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 /tmp, files picked up from /tmp will have the path attribute set to /tmp. If the <Search Recursively> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to /tmp/abc/1/2/3</td></tr><tr><td>file.lastModifiedTime</td><td>The date and time that the source file was last modified</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 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></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutFTP/index.html">PutFTP</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches files from an FTP Server and creates FlowFiles from them</p><h3>Tags: </h3><p>FTP, get, retrieve, files, fetch, remote, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</ th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">21</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Connection Mode</td><td id="default-value">Passive</td><td id="allowable-values"><ul><li>Active</li><li >Passive</li></ul></td><td id="description">The FTP Connection >Mode</td></tr><tr><td id="name">Transfer Mode</td><td >id="default-value">Binary</td><td >id="allowable-values"><ul><li>Binary</li><li>ASCII</li></ul></td><td >id="description">The FTP Transfer Mode</td></tr><tr><td id="name">Remote >Path</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The path on the remote system from which to pull or push >files<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">File Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Provides a Java Regular Expression for filtering Filenames; >if a filter is supplied, only files whose names match that Regular Expression >will be fetched</td></tr><tr><td id="name">Path Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">When Search Recursively is true, then only subdirectories >whose path matches the giv en Regular Expression will be scanned</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">60 sec</td><td id="allowable-values"></td><td id="description">Determines how long to wait between fetching the listing for new files</td></tr><tr><td id="name"><strong>Search Recursively</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories</td></tr><tr><td id="name"><strong>Ignore Dotted Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, files whose names begin with a dot (".") will be ignored</td></tr><tr><td id="name"><strong>Delete Original</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">De termines whether or not the file is deleted from the remote system after it has been successfully transferred</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name"><strong>Max Selects</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in a single connection</td></tr><tr><td id="name"><strong>Remote Poll Batch Size</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="descriptio n">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.</td></tr><tr><td id="name"><strong>Use Natural Ordering</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, 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</td></tr><tr><td id="name">Proxy Type</td><td id="default-value">DIRECT</td><td id="allowable-values"><ul><li>DIRECT</li><li>HTTP</li><li>SOCKS</li></ul></td><td id="description">Proxy type used for file transfers</td></tr><tr><td id="name">Proxy Host</td>< td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr><tr><td id="name">Http Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Username</td></tr><tr><td id="name">Http Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Http Proxy Password<br/><strong>Sensitive Property: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>fi lename</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 /tmp, files picked up from /tmp will have the path attribute set to /tmp. If the <Search Recursively> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to /tmp/abc/1/2/3</td></tr><tr><td>file.lastModifiedTime</td><td>The date and time that the source file was last modified</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 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></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutFTP/index.html">PutFTP</a></p></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFile/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFile/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFile/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetFile/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates FlowFiles from files in a directory. NiFi will ignore files it doesn't have at least read permissions for.</p><h3>Tags: </h3><p>local, files, filesystem, ingest, ingress, get, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The input directory from which to pull files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>File Filter</strong></td><td id="default-value">[^\.].*</td><td id="allowable-values"></td><td id="description">Only files whose names match the given regular expression will be picked up</td></tr><tr><td id="name">Path Filter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in each iteration</td></tr><tr><td id="name"><strong>Keep Source File</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the file is not deleted after it has b een copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.</td></tr><tr><td id="name"><strong>Recurse Subdirectories</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to pull files from subdirectories</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Indicates how long to wait before performing a directory listing</td></tr><tr><td id="name"><strong>Ignore Hidden Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not hidden files should be ignored</td></tr><tr><td id="name"><strong>M inimum File Age</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored</td></tr><tr><td id="name">Maximum File Age</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored</td></tr><tr><td id="name"><strong>Minimum File Size</strong></td><td id="default-value">0 B</td><td id="allowable-values"></td><td id="description">The minimum size that a file must be in order to be pulled</td></tr><tr><td id="name">Maximum File Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum size that a file can be in order to be pulled</td></tr></table><h3>Relationships: </h3><table id=" relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>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 /tmp, files picked up from /tmp will have the path attribute set to ./. If the <Recurse Subdirectories> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to abc/1/2/3</td></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></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutFile/index.html">PutFile</a>, <a href="../org.apache.nifi.processors.standard.FetchFile/index.html">FetchFile</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetFile</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Creates FlowFiles from files in a directory. NiFi will ignore files it doesn't have at least read permissions for.</p><h3>Tags: </h3><p>local, files, filesystem, ingest, ingress, get, source, input, restricted</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Directory</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="descr iption">The input directory from which to pull files<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>File Filter</strong></td><td id="default-value">[^\.].*</td><td id="allowable-values"></td><td id="description">Only files whose names match the given regular expression will be picked up</td></tr><tr><td id="name">Path Filter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When Recurse Subdirectories is true, then only subdirectories whose path matches the given regular expression will be scanned</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in each iteration</td></tr><tr><td id="name"><strong>Keep Source File</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, the file is not deleted af ter it has been copied to the Content Repository; this causes the file to be picked up continually and is useful for testing purposes. If not keeping original NiFi will need write permissions on the directory it is pulling from otherwise it will ignore the file.</td></tr><tr><td id="name"><strong>Recurse Subdirectories</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to pull files from subdirectories</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">Indicates how long to wait before performing a directory listing</td></tr><tr><td id="name"><strong>Ignore Hidden Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not hidden files should be ignored</td></tr><tr><td id="nam e"><strong>Minimum File Age</strong></td><td id="default-value">0 sec</td><td id="allowable-values"></td><td id="description">The minimum age that a file must be in order to be pulled; any file younger than this amount of time (according to last modification date) will be ignored</td></tr><tr><td id="name">Maximum File Age</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum age that a file must be in order to be pulled; any file older than this amount of time (according to last modification date) will be ignored</td></tr><tr><td id="name"><strong>Minimum File Size</strong></td><td id="default-value">0 B</td><td id="allowable-values"></td><td id="description">The minimum size that a file must be in order to be pulled</td></tr><tr><td id="name">Maximum File Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum size that a file can be in order to be pulled</td></tr></table><h3>Relationships: </h3 ><table >id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All > files are routed to success</td></tr></table><h3>Reads Attributes: </h3>None >specified.<h3>Writes Attributes: </h3><table >id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>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 /tmp, files picked up from /tmp will have the path >attribute set to ./. If the <Recurse Subdirectories> property is set to >true and a file is picked up from /tmp/abc/1/2/3, then the path attribute >will be set to abc/1/2/3</td></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 s ystems</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></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><td>Provides operator the ability to read from and delete any file that NiFi has access to.</td><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutFile/index.html">PutFile</a>, <a href="../org.apache.nifi.processors.standard.FetchFile/index.html">Fetch File</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetHTTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetHTTP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetHTTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetHTTP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetHTTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches data from an HTTP or HTTPS URL and writes the data to the content of a FlowFile. Once the content has been fetched, the ETag and Last Modified dates are remembered (if the web server supports these concepts). This allows the Processor to fetch new data only if the remote data has changed or until the state is cleared. That is, once the content has been fetched from the given URL, it will not be fetched again until the content on the remote server changes. Note that due to limitations on state management, stored "last modified" and etag fields never expire. If the URL in GetHttp uses Expression Language that is unbounded, there is the potential for Out of Memory Errors to occur.</p><h3>Tags: </h3><p>get, fetch, poll, http, https, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL to pull from<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Filename</strong></td><td id="default-value"></td><td id="allowable -values"></td><td id="description">The filename to assign to the file when pulled<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username required to access the URL</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password required to access the URL<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td>< td id="allowable-values"></td><td id="description">How long to wait when attempting to connect to the remote server before giving up</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">How long to wait between receiving segments of data from the remote server before giving up and discarding the partial file</td></tr><tr><td id="name">User Agent</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">What to report as the User Agent when we connect to the remote server</td></tr><tr><td id="name">Accept Content-Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, requests will only accept the provided Content-Type</td></tr><tr><td id="name">Follow Redirects</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If we receive a 3xx HTTP Status Cod e from the server, indicates whether or not we should follow the redirect that the server specifies</td></tr><tr><td id="name">Redirect Cookie Policy</td><td id="default-value">default</td><td id="allowable-values"><ul><li>default <img src="../../html/images/iconInfo.png" alt="Default cookie policy that provides a higher degree of compatibility with common cookie management of popular HTTP agents for non-standard (Netscape style) cookies." title="Default cookie policy that provides a higher degree of compatibility with common cookie management of popular HTTP agents for non-standard (Netscape style) cookies."></img></li><li>standard <img src="../../html/images/iconInfo.png" alt="RFC 6265 compliant cookie policy (interoperability profile)." title="RFC 6265 compliant cookie policy (interoperability profile)."></img></li><li>strict <img src="../../html/images/iconInfo.png" alt="RFC 6265 compliant cookie policy (strict profile)." title="RFC 6265 compliant cookie policy (strict profile). "></img></li><li>netscape <img src="../../html/images/iconInfo.png" alt="Netscape draft compliant cookie policy." title="Netscape draft compliant cookie policy."></img></li><li>ignore <img src="../../html/images/iconInfo.png" alt="A cookie policy that ignores cookies." title="A cookie policy that ignores cookies."></img></li></ul></td><td id="description">When a HTTP server responds to a request with a redirect, this is the cookie policy used to copy cookies to the following request.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are transferred to the succes s relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename is set to the name of the file on the remote server</td></tr><tr><td>mime.type</td><td>The MIME Type of the FlowFile, as reported by the HTTP Content-Type header</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetHTTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches data from an HTTP or HTTPS URL and writes the data to the content of a FlowFile. Once the content has been fetched, the ETag and Last Modified dates are remembered (if the web server supports these concepts). This allows the Processor to fetch new data only if the remote data has changed or until the state is cleared. That is, once the content has been fetched from the given URL, it will not be fetched again until the content on the remote server changes. Note that due to limitations on state management, stored "last modified" and etag fields never expire. If the URL in GetHttp uses Expression Language that is unbounded, there is the potential for Out of Memory Errors to occur.</p><h3>Tags: </h3><p>get, fetch, poll, http, https, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL to pull from<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Filename</strong></td><td id="default-value"></td><td id="allowable -values"></td><td id="description">The filename to assign to the file when pulled<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username required to access the URL</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password required to access the URL<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td>< td id="allowable-values"></td><td id="description">How long to wait when attempting to connect to the remote server before giving up</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">How long to wait between receiving segments of data from the remote server before giving up and discarding the partial file</td></tr><tr><td id="name">User Agent</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">What to report as the User Agent when we connect to the remote server</td></tr><tr><td id="name">Accept Content-Type</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, requests will only accept the provided Content-Type</td></tr><tr><td id="name">Follow Redirects</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If we receive a 3xx HTTP Status Cod e from the server, indicates whether or not we should follow the redirect that the server specifies</td></tr><tr><td id="name">Redirect Cookie Policy</td><td id="default-value">default</td><td id="allowable-values"><ul><li>default <img src="../../html/images/iconInfo.png" alt="Default cookie policy that provides a higher degree of compatibility with common cookie management of popular HTTP agents for non-standard (Netscape style) cookies." title="Default cookie policy that provides a higher degree of compatibility with common cookie management of popular HTTP agents for non-standard (Netscape style) cookies."></img></li><li>standard <img src="../../html/images/iconInfo.png" alt="RFC 6265 compliant cookie policy (interoperability profile)." title="RFC 6265 compliant cookie policy (interoperability profile)."></img></li><li>strict <img src="../../html/images/iconInfo.png" alt="RFC 6265 compliant cookie policy (strict profile)." title="RFC 6265 compliant cookie policy (strict profile). "></img></li><li>netscape <img src="../../html/images/iconInfo.png" alt="Netscape draft compliant cookie policy." title="Netscape draft compliant cookie policy."></img></li><li>ignore <img src="../../html/images/iconInfo.png" alt="A cookie policy that ignores cookies." title="A cookie policy that ignores cookies."></img></li></ul></td><td id="description">When a HTTP server responds to a request with a redirect, this is the cookie policy used to copy cookies to the following request.</td></tr><tr><td id="name">Proxy Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the proxy server</td></tr><tr><td id="name">Proxy Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port of the proxy server</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All files are transferred to the succes s relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The filename is set to the name of the file on the remote server</td></tr><tr><td>mime.type</td><td>The MIME Type of the FlowFile, as reported by the HTTP Content-Type header</td></tr></table><h3>State management: </h3><table id="stateful"><tr><th>Scope</th><th>Description</th></tr><tr><td>LOCAL</td><td>Stores Last Modified Time and ETag headers returned by server so that the same data will not be fetched multiple times.</td></tr></table><h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetJMSQueue</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls messages from a JMS Queue, creating a FlowFile for each JMS Message or bundle of messages, as configured</p><h3>Tags: </h3><p>jms, queue, listen, get, pull, source, consume, consumer</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th> </tr><tr><td id="name"><strong>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">Client Acknowledge</td><td id="allowable-values"><ul><li>Client Acknowledge</l i><li>Auto Acknowledge</li></ul></td><td id="description">The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.</td></tr><tr><td id="name">Message Selector</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The JMS Message Selector to use in order to narrow the messages that are pulled</td></tr><tr><td id="name"><strong>Copy JMS Properties to Attributes</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name</td></tr><tr><td id="name">Client ID Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used to associate connections with yoursel f so that the maintainers of the JMS Server know who to contact if problems arise</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutJMS/index.html">PutJMS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetJMSQueue</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls messages from a JMS Queue, creating a FlowFile for each JMS Message or bundle of messages, as configured</p><h3>Tags: </h3><p>jms, queue, listen, get, pull, source, consume, consumer</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th> </tr><tr><td id="name"><strong>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">Client Acknowledge</td><td id="allowable-values"><ul><li>Client Acknowledge</l i><li>Auto Acknowledge</li></ul></td><td id="description">The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.</td></tr><tr><td id="name">Message Selector</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The JMS Message Selector to use in order to narrow the messages that are pulled</td></tr><tr><td id="name"><strong>Copy JMS Properties to Attributes</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name</td></tr><tr><td id="name">Client ID Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used to associate connections with yoursel f so that the maintainers of the JMS Server know who to contact if problems arise</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutJMS/index.html">PutJMS</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetJMSTopic</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls messages from a JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured</p><h3>Tags: </h3><p>jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allow able Values</th><th>Description</th></tr><tr><td id="name"><strong>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description"> The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">Client Acknowledge</td><td id="allowable-v alues"><ul><li>Client Acknowledge</li><li>Auto Acknowledge</li></ul></td><td id="description">The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.</td></tr><tr><td id="name">Message Selector</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The JMS Message Selector to use in order to narrow the messages that are pulled</td></tr><tr><td id="name"><strong>Copy JMS Properties to Attributes</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name</td></tr><tr><td id="name">Client ID Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used t o associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise</td></tr><tr><td id="name"><strong>Use Durable Subscription</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutJMS/index.html">PutJMS</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetJMSTopic</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Pulls messages from a JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured</p><h3>Tags: </h3><p>jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allow able Values</th><th>Description</th></tr><tr><td id="name"><strong>JMS Provider</strong></td><td id="default-value">ActiveMQ</td><td id="allowable-values"><ul><li>ActiveMQ</li></ul></td><td id="description">The Provider used for the JMS Server</td></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL of the JMS Server</td></tr><tr><td id="name"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Topic or queue to use</td></tr><tr><td id="name"><strong>Communications Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait when attempting to receive a message before giving up and assuming failure</td></tr><tr><td id="name"><strong>Message Batch Size</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description"> The number of messages to pull/push in a single iteration of the processor</td></tr><tr><td id="name">Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username used for authentication and authorization</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password used for authentication and authorization<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">SSL Context Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The Controller Service to use in order to obtain an SSL Context.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">Client Acknowledge</td><td id="allowable-v alues"><ul><li>Client Acknowledge</li><li>Auto Acknowledge</li></ul></td><td id="description">The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.</td></tr><tr><td id="name">Message Selector</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The JMS Message Selector to use in order to narrow the messages that are pulled</td></tr><tr><td id="name"><strong>Copy JMS Properties to Attributes</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name</td></tr><tr><td id="name">Client ID Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A human-readable ID that can be used t o associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise</td></tr><tr><td id="name"><strong>Use Durable Subscription</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles are routed to success</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutJMS/index.html">PutJMS</a></p></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches files from an SFTP Server and creates FlowFiles from them</p><h3>Tags: </h3><p>sftp, get, retrieve, files, fetch, remote, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Nam e</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">22</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Private Key Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description" >The fully qualified path to the Private Key file</td></tr><tr><td >id="name">Private Key Passphrase</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">Password for the private >key<br/><strong>Sensitive Property: true</strong></td></tr><tr><td >id="name">Remote Path</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The path on the remote system >from which to pull or push files<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">File Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Provides a Java Regular Expression for filtering Filenames; >if a filter is supplied, only files whose names match that Regular Expression >will be fetched</td></tr><tr><td id="name">Path Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">When Search Recursively is true, then only subdirectories >whose path matches the giv en Regular Expression will be scanned</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">60 sec</td><td id="allowable-values"></td><td id="description">Determines how long to wait between fetching the listing for new files</td></tr><tr><td id="name"><strong>Search Recursively</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories</td></tr><tr><td id="name"><strong>Ignore Dotted Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, files whose names begin with a dot (".") will be ignored</td></tr><tr><td id="name"><strong>Delete Original</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">De termines whether or not the file is deleted from the remote system after it has been successfully transferred</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name">Host Key File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used</td></tr><tr><td id="name"><strong>Max Selects</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in a single connection</td></tr><tr><td id="name"><strong>Remote Poll Batch Size</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name"><strong>Strict Host Key Checking</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not strict enforcement of hosts keys should be applied</td></tr><tr><td id="name"><strong>Send Keep Alive On Timeout</strong></td><td id="default-va lue">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to send a single Keep Alive message when SSH socket times out</td></tr><tr><td id="name"><strong>Use Compression</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not ZLIB compression should be used when transferring files</td></tr><tr><td id="name"><strong>Use Natural Ordering</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, 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</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received are routed to success</td></tr></table><h3> Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>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 /tmp, files picked up from /tmp will have the path attribute set to /tmp. If the <Search Recursively> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to /tmp/abc/1/2/3</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>absolu te.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></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a></p></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSFTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Fetches files from an SFTP Server and creates FlowFiles from them</p><h3>Tags: </h3><p>sftp, get, retrieve, files, fetch, remote, ingest, source, input</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Nam e</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully qualified hostname or IP address of the remote system<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">22</td><td id="allowable-values"></td><td id="description">The port that the remote system is listening on for file transfers</td></tr><tr><td id="name"><strong>Username</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username</td></tr><tr><td id="name">Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password for the user account<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Private Key Path</td><td id="default-value"></td><td id="allowable-values"></td><td id="description" >The fully qualified path to the Private Key file</td></tr><tr><td >id="name">Private Key Passphrase</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">Password for the private >key<br/><strong>Sensitive Property: true</strong></td></tr><tr><td >id="name">Remote Path</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">The path on the remote system >from which to pull or push files<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">File Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">Provides a Java Regular Expression for filtering Filenames; >if a filter is supplied, only files whose names match that Regular Expression >will be fetched</td></tr><tr><td id="name">Path Filter Regex</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">When Search Recursively is true, then only subdirectories >whose path matches the giv en Regular Expression will be scanned</td></tr><tr><td id="name"><strong>Polling Interval</strong></td><td id="default-value">60 sec</td><td id="allowable-values"></td><td id="description">Determines how long to wait between fetching the listing for new files</td></tr><tr><td id="name"><strong>Search Recursively</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories</td></tr><tr><td id="name"><strong>Ignore Dotted Files</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, files whose names begin with a dot (".") will be ignored</td></tr><tr><td id="name"><strong>Delete Original</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">De termines whether or not the file is deleted from the remote system after it has been successfully transferred</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">Amount of time to wait before timing out while creating a connection</td></tr><tr><td id="name"><strong>Data Timeout</strong></td><td id="default-value">30 sec</td><td id="allowable-values"></td><td id="description">When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems</td></tr><tr><td id="name">Host Key File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If supplied, the given file will be used as the Host Key; otherwise, no use host key file will be used</td></tr><tr><td id="name"><strong>Max Selects</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">The maximum number of files to pull in a single connection</td></tr><tr><td id="name"><strong>Remote Poll Batch Size</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">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.</td></tr><tr><td id="name"><strong>Strict Host Key Checking</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not strict enforcement of hosts keys should be applied</td></tr><tr><td id="name"><strong>Send Keep Alive On Timeout</strong></td><td id="default-va lue">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not to send a single Keep Alive message when SSH socket times out</td></tr><tr><td id="name"><strong>Use Compression</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Indicates whether or not ZLIB compression should be used when transferring files</td></tr><tr><td id="name"><strong>Use Natural Ordering</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If true, 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</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received are routed to success</td></tr></table><h3> Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>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 /tmp, files picked up from /tmp will have the path attribute set to /tmp. If the <Search Recursively> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to /tmp/abc/1/2/3</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>absolu te.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></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a></p></body></html> \ No newline at end of file
