Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetHTTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetHTTP/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetHTTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetHTTP/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1,2 @@ +<!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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetHTTP</h1><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="../../../nifi-ssl-context-service-nar/1.2.0/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 sp ecified, 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 Code 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>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">Header Name</td><td id="value">The Expression Language to be used to populate the header value</td><td>The additional headers to be sent by the processor whenever making a new HTTP request. + Setting a dynamic property name to XYZ and value to ${attribute} will result in the header 'XYZ: attribute_value' being sent to the HTTP endpoint</td></tr></table></p><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 success 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>This compone nt is not restricted.</body></html> \ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSQueue/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSQueue/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSQueue/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSQueue/index.html Tue May 9 15:27:39 2017 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetJMSQueue</h1><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 <s trong>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 befo re 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="../../../nifi-ssl-context-service-nar/1.2.0/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</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 to associate connections with yourself 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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSTopic/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSTopic/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSTopic/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetJMSTopic/index.html Tue May 9 15:27:39 2017 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetJMSTopic</h1><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 se nsitive 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="../../../nifi-ssl-context-service-nar/1.2.0/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</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 FlowF ile 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 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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetSFTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetSFTP/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetSFTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.GetSFTP/index.html Tue May 9 15:27:39 2017 @@ -0,0 +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><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetSFTP</h1><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>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">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<br/><strong>Supports Expression Language: true</strong></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><br/><strong>Supports Expression Language: 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 Express ion 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 given 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">Determines 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 i d="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-value">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 pu ll 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>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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<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 Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,43 @@ +<!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>HandleHttpRequest</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Usage Description</h2> + <p> + The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> Processor + provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available + through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a + flow such as: + </p> + + <p> + <a href="index.html">HandleHttpRequest</a> -> + <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> + <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> + </p> + + <p> + The HandleHttpRequest Processor provides several Properties to configure which methods are supported, the paths that are + supported, and SSL configuration. + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HandleHttpRequest</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HandleHttpRequest</h1><h2>Description: </h2><p>Starts an HTTP Server and listens for HTTP Requests. For each request, creates a FlowFile and transfers to 'success'. This Processor is designed to be used in conjunction with the HandleHttpResponse Processor in order to create a Web Service</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>http, https, request, listen, ingress, web service</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. Th e table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Listening Port</strong></td><td id="default-value">80</td><td id="allowable-values"></td><td id="description">The Port to listen on for incoming HTTP requests</td></tr><tr><td id="name">Hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Hostname to bind to. If not specified, will bind to all hosts</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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service to use in order to secure the server. If specified, the server will accept only HTTPS requests; otherwise, the server will accept only HTTP requests</td></tr><tr><td id="name"><strong>HTTP Context Map</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>HttpContextMap<br/><strong>Implementation:</strong><br/><a href="../../../nifi-http-context-map-nar/1.2.0/org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a></td><td id="description">The HTTP Context Map Controller Service to use for caching the HTTP Request Information</td></tr><tr><td id="name">Allowed Paths</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A Regular Expression that specifies the valid HTTP Paths that are allowed in the incoming URL Requests. If this value is specified and the path of the HTTP Requests does not match this Regular Expression, the Processor will respond with a 404: NotFound</td></tr><tr><td id="name"><strong>Default URL Character Set</strong></ td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The character set to use for decoding URL parameters if the HTTP Request does not supply one</td></tr><tr><td id="name"><strong>Allow GET</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Allow HTTP GET Method</td></tr><tr><td id="name"><strong>Allow POST</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Allow HTTP POST Method</td></tr><tr><td id="name"><strong>Allow PUT</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Allow HTTP PUT Method</td></tr><tr><td id="name"><strong>Allow DELETE</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Allow HTTP DELETE Method</td></tr ><tr><td id="name"><strong>Allow HEAD</strong></td><td >id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Allow HTTP HEAD Method</td></tr><tr><td >id="name"><strong>Allow OPTIONS</strong></td><td >id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">Allow HTTP OPTIONS Method</td></tr><tr><td >id="name">Additional HTTP Methods</td><td id="default-value"></td><td >id="allowable-values"></td><td id="description">A comma-separated list of >non-standard HTTP Methods that should be allowed</td></tr><tr><td >id="name"><strong>Client Authentication</strong></td><td >id="default-value">No Authentication</td><td id="allowable-values"><ul><li>No >Authentication <img src="../../../../../html/images/iconInfo.png" >alt="Processor will not authenticate clients. Anyone can communicate with >this Processor anonymously" title="Processor will not authenticate clients. >Anyone can comm unicate with this Processor anonymously"></img></li><li>Want Authentication <img src="../../../../../html/images/iconInfo.png" alt="Processor will try to verify the client but if unable to verify will allow the client to communicate anonymously" title="Processor will try to verify the client but if unable to verify will allow the client to communicate anonymously"></img></li><li>Need Authentication <img src="../../../../../html/images/iconInfo.png" alt="Processor will reject communications from any client unless the client provides a certificate that is trusted by the TrustStorespecified in the SSL Context Service" title="Processor will reject communications from any client unless the client provides a certificate that is trusted by the TrustStorespecified in the SSL Context Service"></img></li></ul></td><td id="description">Specifies whether or not the Processor should authenticate clients. This value is ignored if the <SSL Context Service> Property is not specified or the SS L Context provided uses only a KeyStore and not a TrustStore.</td></tr><tr><td id="name"><strong>Container Queue Size</strong></td><td id="default-value">50</td><td id="allowable-values"></td><td id="description">The size of the queue for Http Request Containers</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All content that is received is routed to the 'success' 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>http.context.identifier</td><td>An identifier that allows the HandleHttpRequest and HandleHttpResponse to coordinate which FlowFile belongs to which HTTP Request/Response.</td></tr><tr><td>mime.type</td><td>The MIME Type of the data, according to the HTTP Header "Content-Type"</td></tr><tr><td>http.servlet.path</td><td>The part of the request URL that is consider ed the Servlet Path</td></tr><tr><td>http.context.path</td><td>The part of the request URL that is considered to be the Context Path</td></tr><tr><td>http.method</td><td>The HTTP Method that was used for the request, such as GET or POST</td></tr><tr><td>http.local.name</td><td>IP address/hostname of the server</td></tr><tr><td>http.server.port</td><td>Listening port of the server</td></tr><tr><td>http.query.string</td><td>The query string portion of hte Request URL</td></tr><tr><td>http.remote.host</td><td>The hostname of the requestor</td></tr><tr><td>http.remote.addr</td><td>The hostname:port combination of the requestor</td></tr><tr><td>http.remote.user</td><td>The username of the requestor</td></tr><tr><td>http.request.uri</td><td>The full Request URL</td></tr><tr><td>http.auth.type</td><td>The type of HTTP Authorization used</td></tr><tr><td>http.principal.name</td><td>The name of the authenticated user making the request</td></tr><tr><td>http.subject.dn</td><td>The Distinguish ed Name of the requestor. This value will not be populated unless the Processor is configured to use an SSLContext Service</td></tr><tr><td>http.issuer.dn</td><td>The Distinguished Name of the entity that issued the Subject's certificate. This value will not be populated unless the Processor is configured to use an SSLContext Service</td></tr><tr><td>http.headers.XXX</td><td>Each of the HTTP Headers that is received in the request will be added as an attribute, prefixed with "http.headers." For example, if the request contains an HTTP Header named "x-my-header", then the value will be added to an attribute named "http.headers.x-my-header"</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a>, <a href="../../../nifi-http-context-map-nar/1.2.0/org.apache.nifi.http.StandardHttpContextMa p/index.html">StandardHttpContextMap</a>, <a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,44 @@ +<!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>HandleHttpResponse</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Usage Description:</h2> + <p> + The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> Processor + provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available + through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a + flow such as: + </p> + + <p> + <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> -> + <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> + <a href="index.html">HandleHttpResponse</a> + </p> + + <p> + This Processor must be configured with the same <HTTP Context Map> service as the corresponding HandleHttpRequest Processor. + Otherwise, all FlowFiles will be routed to the 'failure' relationship. + </p> + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HandleHttpResponse/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HandleHttpResponse</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HandleHttpResponse</h1><h2>Description: </h2><p>Sends an HTTP Response to the Requestor that generated a FlowFile. This Processor is designed to be used in conjunction with the HandleHttpRequest in order to create a web service.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>http, https, response, egress, web service</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 s upports 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>HTTP Status Code</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The HTTP Status Code to use when responding to the HTTP Request. See Section 10 of RFC 2616 for more information.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTTP Context Map</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>HttpContextMap<br/><strong>Implementation:</strong><br/><a href="../../../nifi-http-context-map-nar/1.2.0/org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a></td><td id="description">The HTTP Context Map Controller Service to use for caching the HTTP Request Information</td></ tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">An HTTP header name</td><td id="value">An HTTP header value</td><td>These HTTPHeaders are set in the HTTP Response</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles will be routed to this Relationship after the response has been successfully sent to the requestor</td></tr><tr><td>failure</td><td>FlowFiles will be routed to this Relationship if the Processor is unable to respond to the requestor. This may happen, for instance, if the connection times out or if NiFi is restarted before responding to the HTTP Request.</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>http.context.identifier</ td><td>The value of this attribute is used to lookup the HTTP Response so that the proper message can be sent back to the requestor. If this attribute is missing, the FlowFile will be routed to 'failure.'</td></tr><tr><td>http.request.uri</td><td>Value of the URI requested by the client. Used for provenance event.</td></tr><tr><td>http.remote.host</td><td>IP address of the client. Used for provenance event.</td></tr><tr><td>http.local.name</td><td>IP address/hostname of the server. Used for provenance event.</td></tr><tr><td>http.server.port</td><td>Listening port of the server. Used for provenance event.</td></tr><tr><td>http.subject.dn</td><td>SSL distinguished name (if any). Used for provenance event.</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleH ttpRequest</a>, <a href="../../../nifi-http-context-map-nar/1.2.0/org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a>, <a href="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashAttribute/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashAttribute/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashAttribute/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashAttribute/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HashAttribute</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HashAttribute</h1><h2>Description: </h2><p>Hashes together the key/value pairs of several FlowFile Attributes and adds the hash as a new attribute. Optional properties are to be added such that the name of the 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, will cause 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 will be used.</p><h3>Tags: </h3><p>attributes, hash</p><h3>Properties: </h3><p>In the list b elow, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Hash Value Attribute Key</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the FlowFile Attribute where the hash value should be stored</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">A flowfile attribute key for attribute inspection</td><td id="value">A Regular Expression</td><td>This regular expression is evaluated against the flowfile attribute values. If the regular expression contains a capturing group, the value of that group will be used when comparing flow file attributes. Otherwise, the original flow file attribute's value will be used if and only if the value matches the given regular expression.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Used for FlowFiles that have a hash value added</td></tr><tr><td>failure</td><td>Used for FlowFiles that are missing required attributes</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td><Hash Value Attribute Key></td><td>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.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body>< /html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashContent/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.HashContent/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HashContent</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HashContent</h1><h2>Description: </h2><p>Calculates a hash value for the Content of a FlowFile and puts that hash value on the FlowFile as an attribute whose name is determined by the <Hash Attribute Name> property</p><h3>Tags: </h3><p>hash, content, MD5, SHA-1, SHA-256</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></ tr><tr><td id="name"><strong>Hash Attribute Name</strong></td><td id="default-value">hash.value</td><td id="allowable-values"></td><td id="description">The name of the FlowFile Attribute into which the Hash Value should be written. If the value already exists, it will be overwritten</td></tr><tr><td id="name"><strong>Hash Algorithm</strong></td><td id="default-value">MD5</td><td id="allowable-values"><ul><li>SHA-1</li><li>SHA-384</li><li>SKEIN-512-256</li><li>SKEIN-1024-384</li><li>BLAKE2B-160</li><li>SHA</li><li>KECCAK-288</li><li>WHIRLPOOL</li><li>SKEIN-512-384</li><li>SHA-224</li><li>SM3</li><li>BLAKE2B-512</li><li>GOST3411-2012-512</li><li>SKEIN-512-128</li><li>KECCAK-256</li><li>BLAKE2B-384</li><li>OID.2.16.840.1.101.3.4.2.10</li><li>SKEIN-256-160</li><li>SHA-256</li><li>SHA3-256</li><li>KECCAK-384</li><li>SKEIN-256-128</li><li>KECCAK-224</li><li>SKEIN-512-512</li><li>SKEIN-1024-512</li><li>SKEIN-512-160</li><li>GOST3411</li><li>BLAKE2B-256</li><li>SKEIN-1024-1024</li><li>SHA3- 384</li><li>OID.2.16.840.1.101.3.4.2.9</li><li>SHA-512/224</li><li>OID.2.16.840.1.101.3.4.2.8</li><li>OID.2.16.840.1.101.3.4.2.7</li><li>TIGER</li><li>RIPEMD256</li><li>SKEIN-256-256</li><li>SHA3-224</li><li>SHA3-512</li><li>RIPEMD320</li><li>2.16.840.1.101.3.4.2.9</li><li>RIPEMD160</li><li>GOST3411-2012-256</li><li>KECCAK-512</li><li>SKEIN-512-224</li><li>2.16.840.1.101.3.4.2.8</li><li>2.16.840.1.101.3.4.2.7</li><li>2.16.840.1.101.3.4.2.10</li><li>SHA-512/256</li><li>MD2</li><li>RIPEMD128</li><li>MD4</li><li>SHA-512</li><li>SKEIN-256-224</li><li>MD5</li></ul></td><td id="description">Determines what hashing algorithm should be used to perform the hashing function</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that are process successfully will be sent to this relationship</td></tr><tr><td>failure</td><td>Any FlowFile that cannot be processed successfully will be sent to this relationship without any attribute being added</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><Hash Attribute Name></td><td>This Processor adds an attribute whose value is the result of Hashing the existing FlowFile content. The name of this attribute is specified by the <Hash Attribute Name> property</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,64 @@ +<!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>IdentifyMimeType</title> + + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <p>The following is a non-exhaustive list of MIME Types detected: + </p> + <ul> + <li>application/gzip</li> + <li>application/bzip2</li> + <li>application/flowfile-v3</li> + <li>application/flowfile-v1</li> + <li>application/xml</li> + <li>video/mp4</li> + <li>video/x-m4v</li> + <li>video/mp4a-latm</li> + <li>video/quicktime</li> + <li>video/mpeg</li> + <li>audio/wav</li> + <li>audio/mp3</li> + <li>image/bmp</li> + <li>image/png</li> + <li>image/jpg</li> + <li>image/gif</li> + <li>image/tif</li> + <li>application/vnd.ms-works</li> + <li>application/msexcel</li> + <li>application/mspowerpoint</li> + <li>application/msaccess</li> + <li>application/x-ms-wmv</li> + <li>application/pdf</li> + <li>application/x-rpm</li> + <li>application/tar</li> + <li>application/x-7z-compressed</li> + <li>application/java-archive</li> + <li>application/zip</li> + <li>application/x-lzh</li> + </ul> + <p>For a complete list, please refer to + <a href="https://git-wip-us.apache.org/repos/asf?p=tika.git;a=blob;f=tika-core/src/main/resources/org/apache/tika/mime/tika-mimetypes.xml;h=fffb9bbca8f49d2265479da798c0c01ceb2060e2;hb=d647a234783bbc3f83d3691a1e1d5788c438d55d";> + Apache Tika's source code</a> + </p> + + </body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.IdentifyMimeType/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>IdentifyMimeType</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">IdentifyMimeType</h1><h2>Description: </h2><p>Attempts to identify the MIME Type used for a FlowFile. If the MIME Type can be identified, an attribute with the name 'mime.type' is added with the value being the MIME Type. If the MIME Type cannot be determined, the value will be set to 'application/octet-stream'. In addition, the attribute mime.extension will be set if a common file extension for the MIME Type is known.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>compression, gzip, bzip2, zip, MIME, mime.type, file, identify</p><h3>Properties: </h3><p>Th is component has no required or optional properties.</p><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><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>This Processor sets the FlowFile's mime.type attribute to the detected MIME Type. If unable to detect the MIME Type, the attribute's value will be set to application/octet-stream</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.InvokeHTTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.InvokeHTTP/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.InvokeHTTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.InvokeHTTP/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>InvokeHTTP</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">InvokeHTTP</h1><h2>Description: </h2><p>An HTTP client processor which can interact with a configurable HTTP Endpoint. The destination URL and HTTP Method are configurable. FlowFile attributes are converted to HTTP headers and the FlowFile contents are included as the body of the request (if the HTTP Method is PUT, POST or PATCH).</p><h3>Tags: </h3><p>http, https, rest, client</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>HTTP Method</strong></td><td id="default-value">GET</td><td id="allowable-values"></td><td id="description">HTTP request method (GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS). Arbitrary methods are also supported. Methods other than POST, PUT and PATCH will be sent without a message body.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Remote URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="des cription">Remote URL which will be connected to, including scheme, host, port, path.<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="../../../nifi-ssl-context-service-nar/1.2.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL (https) connections.</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for connection to remote service.</td></tr><tr><td id="name"><strong>Read Timeout</strong></td><td id="default-value">15 secs</td><td id="allowable-values"></td><td id="description">Max wait time for response from remote service.</td></tr><tr><td id="name"><strong>Include Date Header</strong></td><td id="default-value">True</td><td id="allowable-values"><ul><li>True</li><li>False</li></ul></td><td id="description">Include an RFC-2616 Date header in the request.</td></tr><tr><td id="name"><strong>Follow Redirects</strong></td><td id="default-value">True</td><td id="allowable-values"><ul><li>True</li><li>False</li></ul></td><td id="description">Follow HTTP redirects issued by remote server.</td></tr><tr><td id="name">Attributes to Send</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Regular expression that defines which attributes to send as HTTP headers in the request. If not defined, no attributes are sent as headers. Also any dynamic properties set will be sent as headers. The dynamic property key will be the header key and the dynamic property value will be interpreted as expression language will be the header value.</td></tr><tr><td id="name">Basic Authentication Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to be used by the client to authenticate against the Remote URL. Cannot include control characters (0-31), ':', or DEL (127).</td></tr><tr><td id="name">Basic Authentication Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password to be used by the client to authenticate against the Remote URL.<br/><strong>Sensitive Property: true</strong></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">Proxy Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Username to set when a uthenticating against proxy</td></tr><tr><td id="name">Proxy Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Password to set when authenticating against proxy<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Put Response Body In Attribute</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If set, the response body received back will be put into an attribute of the original FlowFile instead of a separate FlowFile. The attribute key to put to is determined by evaluating value of this property. <br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Max Length To Put In Attribute</td><td id="default-value">256</td><td id="allowable-values"></td><td id="description">If routing the response body to an attribute of the original (by setting the "Put response body in attribute" property or by receiving an error status code), the number of characters put to the at tribute value will be at most this amount. This is important because attributes are held in memory and large attributes will quickly cause out of memory issues. If the output goes longer than this value, it will be truncated to fit. Consider making this smaller if able.</td></tr><tr><td id="name">Use Digest Authentication</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication.</td></tr><tr><td id="name">Always Output Response</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Will force a response FlowFile to be generated and routed to the 'Response' relationship regardless of what the server status code received is or if the processor is configured to put the server response bod y in the request attribute. In the later configuration a request FlowFile with the response body in the attribute and a typical response FlowFile will be emitted to their respective relationships.</td></tr><tr><td id="name">Trusted Hostname</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Bypass the normal truststore hostname verifier to allow the specified remote hostname as trusted. Enabling this property has MITM security implications, use wisely. Will still accept other connections based on the normal truststore hostname verifier. Only valid with SSL (HTTPS) connections.</td></tr><tr><td id="name">Add Response Headers to Request</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this property saves all the response headers to the original request. This may be when the response headers are needed but a response is not generated due to the status code received.</td ></tr><tr><td id="name"><strong>Content-Type</strong></td><td >id="default-value">${mime.type}</td><td id="allowable-values"></td><td >id="description">The Content-Type to specify for when content is being >transmitted through a PUT, POST or PATCH. In the case of an empty value after >evaluating an expression language expression, Content-Type defaults to >application/octet-stream<br/><strong>Supports Expression Language: >true</strong></td></tr><tr><td id="name">Send Message Body</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, sends the HTTP message body on POST/PUT/PATCH >requests (default). If false, suppresses the message body and content-type >header for these requests.</td></tr><tr><td id="name"><strong>Use Chunked >Encoding</strong></td><td id="default-value">false</td><td >id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td >id="description">When POST'ing, PUT'ing or PATCH'ing content se t this property to true in order to not pass the 'Content-length' header and instead send 'Transfer-Encoding' with a value of 'chunked'. This will enable the data transfer mechanism which was introduced in HTTP 1.1 to pass data of unknown lengths in chunks.</td></tr><tr><td id="name">Penalize on "No Retry"</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Enabling this property will penalize FlowFiles that are routed to the "No Retry" relationship.</td></tr></table><h3>Dynamic Properties: </h3><p>Dynamic Properties allow the user to specify both the name and value of a property.<table id="dynamic-properties"><tr><th>Name</th><th>Value</th><th>Description</th></tr><tr><td id="name">Header Name</td><td id="value">Attribute Expression Language</td><td>Send request header with a key matching the Dynamic Property Key and a value created by evaluating the Attribute Expression Language set in the value of the Dynami c Property.<br/><strong>Supports Expression Language: true</strong></td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Original</td><td>The original FlowFile will be routed upon success (2xx status codes). It will have new attributes detailing the success of the request.</td></tr><tr><td>Failure</td><td>The original FlowFile will be routed on any type of connection failure, timeout or general exception. It will have new attributes detailing the request.</td></tr><tr><td>Retry</td><td>The original FlowFile will be routed on any status code that can be retried (5xx status codes). It will have new attributes detailing the request.</td></tr><tr><td>No Retry</td><td>The original FlowFile will be routed on any status code that should NOT be retried (1xx, 3xx, 4xx status codes). It will have new attributes detailing the request.</td></tr><tr><td>Response</td><td>A Response FlowFile will be routed upon success (2xx statu s codes). If the 'Output Response Regardless' property is true then the response will be sent to this relationship regardless of the status code received.</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>invokehttp.status.code</td><td>The status code that is returned</td></tr><tr><td>invokehttp.status.message</td><td>The status message that is returned</td></tr><tr><td>invokehttp.response.body</td><td>In the instance where the status code received is not a success (2xx) then the response body will be put to the 'invokehttp.response.body' attribute of the request FlowFile.</td></tr><tr><td>invokehttp.request.url</td><td>The request URL</td></tr><tr><td>invokehttp.tx.id</td><td>The transaction ID that is returned after reading the response</td></tr><tr><td>invokehttp.remote.dn</td><td>The DN of the remote server</td></tr><tr><td>invokehttp.java.exception.class</td><td> The Java exception class raised when the processor fails</td></tr><tr><td>invokehttp.java.exception.message</td><td>The Java exception message raised when the processor fails</td></tr><tr><td>user-defined</td><td>If the 'Put Response Body In Attribute' property is set then whatever it is set to will become the attribute key and the value would be the body of the HTTP response.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/additionalDetails.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/additionalDetails.html Tue May 9 15:27:39 2017 @@ -0,0 +1,40 @@ +<!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>JoltTransformJSON</title> + <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"/> +</head> + +<body> +<!-- Processor Documentation ================================================== --> +<h2>Usage Information</h2> + +<p> + The Jolt utilities processing JSON are not not stream based therefore large JSON document + transformation may consume large amounts of memory. Currently UTF-8 FlowFile content and Jolt specifications are supported. + A specification can be defined using Expression Language where attributes can be referred either on the left or right hand side within the specification syntax. + + Custom Jolt Transformations (that implement the Transform interface) are supported. Modules containing custom libraries which do not + existing on the current class path can be included via the custom module directory property. + + <Strong>Note:</Strong> When configuring a processor if user selects of the Default transformation yet provides a + Chain specification the system does not alert that the specification is invalid and and will produce failed flow files. + This is a known issue identified within the Jolt library. +</p> +</body> +</html> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/index.html?rev=1794596&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.2.0/org.apache.nifi.processors.standard.JoltTransformJSON/index.html Tue May 9 15:27:39 2017 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JoltTransformJSON</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">JoltTransformJSON</h1><h2>Description: </h2><p>Applies a list of Jolt specifications to the flowfile JSON payload. A new FlowFile is created with transformed content and is routed to the 'success' relationship. If the JSON transform fails, the original FlowFile is routed to the 'failure' relationship.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>json, jolt, transform, shiftr, chainr, defaultr, removr, cardinality, sort</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (no t 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>Jolt Transformation DSL</strong></td><td id="default-value">jolt-transform-chain</td><td id="allowable-values"><ul><li>Cardinality <img src="../../../../../html/images/iconInfo.png" alt="Change the cardinality of input elements to create the output JSON." title="Change the cardinality of input elements to create the output JSON."></img></li><li>Chain <img src="../../../../../html/images/iconInfo.png" alt="Execute list of Jolt transformations." title="Execute list of Jolt transformations."></img></li><li>Default <img src="../../../../../html/images/iconInfo.png" alt=" Apply default values to the output JSON." title=" Apply default values to the output JSON."></img></li><li>Modify - Default <img src="../../../../../html/images/iconInfo.png" alt="Writes when key is missing or value is null" title="Writes when key is missing or value is null"></img></li><li>Modify - Define <img src="../../../../../html/images/iconInfo.png" alt="Writes when key is missing" title="Writes when key is missing"></img></li><li>Modify - Overwrite <img src="../../../../../html/images/iconInfo.png" alt=" Always overwrite value" title=" Always overwrite value"></img></li><li>Remove <img src="../../../../../html/images/iconInfo.png" alt=" Remove values from input data to create the output JSON." title=" Remove values from input data to create the output JSON."></img></li><li>Shift <img src="../../../../../html/images/iconInfo.png" alt="Shift input JSON/data to create the output JSON." title="Shift input JSON/data to create the output JSON."></img></li><li>Sort <img src="../../../../../html/images/iconInfo.png" alt="Sort input json key values alphabe tically. Any specification set is ignored." title="Sort input json key values alphabetically. Any specification set is ignored."></img></li><li>Custom <img src="../../../../../html/images/iconInfo.png" alt="Custom Transformation. Requires Custom Transformation Class Name" title="Custom Transformation. Requires Custom Transformation Class Name"></img></li></ul></td><td id="description">Specifies the Jolt Transformation that should be used with the provided specification.</td></tr><tr><td id="name">Custom Transformation Class Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Fully Qualified Class Name for Custom Transformation</td></tr><tr><td id="name">Custom Module Directory</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Comma-separated list of paths to files and/or directories which contain modules containing custom transformations (that are not included on NiFi's classpath).</td></tr><tr><td id="name">Jolt Specification</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Jolt Specification for transform of JSON data. This value is ignored if the Jolt Sort Transformation is selected.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Transform Cache Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">Compiling a Jolt Transform can be fairly expensive. Ideally, this will be done only once. However, if the Expression Language is used in the transform, we may need a new Transform for each FlowFile. This value controls how many of those Transforms we cache in memory in order to avoid having to compile the Transform each time.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>The FlowFile with transformed content will be routed to this relationship</td></tr><tr><td>failure</td><td>If a FlowF ile fails processing for any reason (for example, the FlowFile is not valid JSON), it will be routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Always set to application/json</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html> \ No newline at end of file
