Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSQueue/index.html Fri May 29 11:51:20 2015 @@ -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><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, 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</stron g>.</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"><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-va lue"></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 Attribut es: </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
Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetJMSTopic/index.html Fri May 29 11:51:20 2015 @@ -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><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, 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 <st rong>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"><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">Mes sage 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><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 Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GetSFTP/index.html Fri May 29 11:51:20 2015 @@ -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><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">Amount of time to wait before timing out while transferring data</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="na me"><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="descriptio n">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>absolute.path</td><td>The >full/absolute path from where a file was picked up. The current 'path' >attribut e 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 Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html Fri May 29 11:51:20 2015 @@ -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: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpRequest/index.html Fri May 29 11:51:20 2015 @@ -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><body><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. 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 v alue 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>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="../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="../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: No tFound</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 anonymo usly" title="Processor will not authenticate clients. Anyone can communicate 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 Cont ext Service> Property is not specified or the SSL Context provided uses only a KeyStore and not a TrustStore.</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 considered 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.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 Distinguished 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>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a>, <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a>, <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html Fri May 29 11:51:20 2015 @@ -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: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HandleHttpResponse/index.html Fri May 29 11:51:20 2015 @@ -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><body><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, 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 prope rty, 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 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="../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></tabl e><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>Th e 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></table><h3>Writes Attributes: </h3>None specified.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a>, <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a>, <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></p></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashAttribute/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashAttribute/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashAttribute/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashAttribute/index.html Fri May 29 11:51:20 2015 @@ -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><body><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 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>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></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashContent/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashContent/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashContent/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.HashContent/index.html Fri May 29 11:51:20 2015 @@ -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><body><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, 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 p roperty <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>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>RIPEMD320</li><li>SHA-1</li><li>SHA-384</li><li>RIPEMD160</li><li>SHA</li><li>WHIRLPOOL</li><li>GOST3411</li><li>SHA-224</li><li>SHA-256</li><li>MD2</li><li>RIPEMD128</li><li>MD4</li><li>SHA-512</li><li>RIPEMD256</li><li>TIGER</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 attributes. The name of this attribute is specified by the <Hash Attribute Name> property</td></tr></table></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html Fri May 29 11:51:20 2015 @@ -0,0 +1,59 @@ +<!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 MIME Types are detected: + </p> + <ul> + <li>application/gzip</li> + <li>application/bzip2</li> + <li>application/flowfile-v3</li> + <li>application/flowfile-v1 (requires Identify TAR be set to true)</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> + </body> +</html> Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.IdentifyMimeType/index.html Fri May 29 11:51:20 2015 @@ -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><body><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>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 h ref="../../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><p>This 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></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.InvokeHTTP/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.InvokeHTTP/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.InvokeHTTP/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.InvokeHTTP/index.html Fri May 29 11:51:20 2015 @@ -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><body><h2>Description: </h2><p>An HTTP client processor which converts FlowFile attributes to HTTP headers, with configurable HTTP method, url, etc.</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="propert ies"><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, DELETE, HEAD, OPTIONS).<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="description">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="../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.</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">Trusted Hostname</td><td id="value">A hostname</td><td>Bypass the normal truststore hostname verifier to allow the specified (single) remote hostname as trusted Enabling this property has MITM security implications, use wisely. Only valid with SSL (HTTPS) connections.</td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>Original</td><td>Original FlowFile will be routed upon success (2xx status codes).</td></tr><tr><td>Failure</td><td>FlowFile will be routed on any type of connection failure, timeout or general exception.</td></tr><tr><td>Retry</td><td>FlowFile will be routed on any status code that can be retried (5xx status codes).</td></tr><tr><td>No Retry</td><td>FlowFile will be routed on any status code that should NOT be retried (1xx, 3xx, 4xx status codes).</td></tr><tr><td>Response</td><td>Response FlowFile will be routed upon success (2xx status codes).</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>The response body</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 remo te server</td></tr></table></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenHTTP/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenHTTP/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenHTTP/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenHTTP/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenHTTP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Starts an HTTP Server that is used to receive FlowFiles from remote sources. The URL of the Service will be http://{hostname}:{port}/contentListener</p><h3>Tags: </h3><p>ingest, http, https, rest, listen</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.pr ops.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>Listening Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Port to listen on for incoming connections</td></tr><tr><td id="name">Max Data to Receive per Second</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum amount of data to receive per second; this allows the bandwidth to be throttled to a specified data rate; if not specified, the data rate is not throttled</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>Authorized DN Pattern</strong></td><td id="default-value">.*</td><td id="allowable-values"></td><td id="description">A Regular Expression to apply against the Distinguished Name of incoming connections. If the Pattern does not match the DN, the connection will be refused.</td></tr><tr><td id="name"><strong>Max Unconfirmed Flowfile Time</strong></td><td id="default-value">60 secs</td><td id="allowable-values"></td><td id="description">The maximum amount of time to wait for a FlowFile to be confirmed before it is removed from the cache</td></tr><tr><td id="name">HTTP Headers to receive as Attributes (Regex)</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specifies the Regular Expression that determines the names of HTTP Headers that should be passed along as FlowFile attributes</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr>< td>success</td><td>Relationship for successfully received FlowFiles</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenUDP/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenUDP/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenUDP/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListenUDP/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenUDP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Listens for Datagram Packets on a given port and concatenates the contents of those packets together generating flow files</p><h3>Tags: </h3><p>ingest, udp, listen, source</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="p roperties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Sending Host</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">IP, or name, of a remote host. Only Datagrams from the specified Sending Host Port and this host will be accepted. Improves Performance. May be a system property or an environment variable.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Sending Host Port</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Port being used by remote host to send Datagrams. Only Datagrams from the specified Sending Host and this port will be accepted. Improves Performance. May be a system property or an environment variable.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Local Network Interface</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of a local network interface to be used to restrict listening for UDP Datagrams to a specific LAN.May be a system property or an environment variable.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Channel Reader Interval</strong></td><td id="default-value">50 ms</td><td id="allowable-values"></td><td id="description">Scheduling interval for each read channel.</td></tr><tr><td id="name"><strong>FlowFile Size Trigger</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Determines the (almost) upper bound size at which a flow file would be generated.</td></tr><tr><td id="name"><strong>Max Buffer Size</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">Determines the size each receive buffer may be</td></tr><tr><td id="name"><strong>Max size of UDP Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The max imum UDP buffer size that should be used. This is a suggestion to the Operating System to indicate how big the udp socket buffer should be.</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Port to listen on. Must be known by senders of Datagrams.</td></tr><tr><td id="name"><strong>Receive Buffer Count</strong></td><td id="default-value">4</td><td id="allowable-values"></td><td id="description">Number of receiving buffers to be used to accept data from the socket. Higher numbers means more ram is allocated but can allow better throughput.</td></tr><tr><td id="name"><strong>FlowFiles Per Session</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">The number of flow files per session.</td></tr><tr><td id="name"><strong>Receive Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">The time out period when wait ing to receive data from the socket. Specify units.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Connection which contains concatenated Datagram Packets</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.LogAttribute/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.LogAttribute/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.LogAttribute/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.LogAttribute/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>LogAttribute</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>No description provided.</p><h3>Tags: </h3><p>attributes, logging</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>Log Level</strong></td><td >id="default-value">info</td><td >id="allowable-values"><ul><li>trace</li><li>debug</li><li>info</li><li>warn</li><li>error</li></ul></td><td > id="description">The Log Level to use when logging the >Attributes</td></tr><tr><td id="name"><strong>Log Payload</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 FlowFile's payload will be logged, in addition >to its attributes; otherwise, just the Attributes will be >logged.</td></tr><tr><td id="name">Attributes to Log</td><td >id="default-value"></td><td id="allowable-values"></td><td id="description">A >comma-separated list of Attributes to Log. If not specified, all attributes >will be logged.</td></tr><tr><td id="name">Attributes to Ignore</td><td >id="default-value"></td><td id="allowable-values"></td><td id="description">A >comma-separated list of Attributes to ignore. If not specified, no attributes will be ignored.</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 this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MergeContent/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MergeContent/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MergeContent/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MergeContent/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MergeContent</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Merges a Group of FlowFiles together based on a user-defined strategy and packages them into a single FlowFile. It is recommended that the Processor be configured with only a single incoming connection, as Group of FlowFiles will not be created from FlowFiles in different connections. This processor updates the mime.type attribute as appropriate.</p><h3>Tags: </h3><p>merge, content, correlation, tar, zip, stream, concatenation, archive, flowfile-stream, flowfile-stream-v3</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>Merge Strategy</strong></td><td id="default-value">Bin-Packing Algorithm</td><td id="allowable-values"><ul><li>Bin-Packing Algorithm <img src="../../html/images/iconInfo.png" alt="Generates 'bins' of FlowFiles and fills each bin as full as possible. FlowFiles are placed into a bin based on their size and optionally their attributes (if the <Correlation Attribute> property is set)" title="Generates 'bins' of FlowFiles and fills each bin as full as possible. FlowFiles are placed into a bin based on their size and optionally their attributes (if the < Correlation Attribute> property is set)"></img></li><li>Defragment <img src="../../html/images/iconInfo.png" alt="Combines fragments that are associated by attributes back into a single cohesive FlowFile. If using this strategy, all FlowFiles must have the attributes <fragment.identifier>, <fragment.count>, and <fragment.index> or alternatively (for backward compatibility purposes) <segment.identifier>, <segment.count>, and <segment.index>" title="Combines fragments that are associated by attributes back into a single cohesive FlowFile. If using this strategy, all FlowFiles must have the attributes <fragment.identifier>, <fragment.count>, and <fragment.index> or alternatively (for backward compatibility purposes) <segment.identifier>, <segment.count>, and <segment.index>"></img></li></ul></td><td id="description">Specifies the algorithm used to merge content. The 'Defragment' algorithm combines fragments that are associated by attributes back into a single cohesive FlowFile. The 'Bin-Packing Algorithm' generates a FlowFile populated by arbitrarily chosen FlowFiles</td></tr><tr><td id="name"><strong>Merge Format</strong></td><td id="default-value">Binary Concatenation</td><td id="allowable-values"><ul><li>TAR <img src="../../html/images/iconInfo.png" alt="A bin of FlowFiles will be combined into a single TAR file. The FlowFiles' <path> attribute will be used to create a directory in the TAR file if the <Keep Paths> property is set to true; otherwise, all FlowFiles will be added at the root of the TAR file. If a FlowFile has an attribute named <tar.permissions> that is 3 characters, each between 0-7, that attribute will be used as the TAR entry's 'mode'." title="A bin of FlowFiles will be combined into a single TAR file. The FlowFiles' <path> attribute will be used to create a directory in the TAR file if the <Keep Paths> property is set to true; otherwise, a ll FlowFiles will be added at the root of the TAR file. If a FlowFile has an attribute named <tar.permissions> that is 3 characters, each between 0-7, that attribute will be used as the TAR entry's 'mode'."></img></li><li>ZIP <img src="../../html/images/iconInfo.png" alt="A bin of FlowFiles will be combined into a single ZIP file. The FlowFiles' <path> attribute will be used to create a directory in the ZIP file if the <Keep Paths> property is set to true; otherwise, all FlowFiles will be added at the root of the ZIP file. The <Compression Level> property indicates the ZIP compression to use." title="A bin of FlowFiles will be combined into a single ZIP file. The FlowFiles' <path> attribute will be used to create a directory in the ZIP file if the <Keep Paths> property is set to true; otherwise, all FlowFiles will be added at the root of the ZIP file. The <Compression Level> property indicates the ZIP compression to use."></img></li><li>Flow File Stream, v3 <img src="../../html/images/iconInfo.png" alt="A bin of FlowFiles will be combined into a single Version 3 FlowFile Stream" title="A bin of FlowFiles will be combined into a single Version 3 FlowFile Stream"></img></li><li>FlowFile Stream, v2 <img src="../../html/images/iconInfo.png" alt="A bin of FlowFiles will be combined into a single Version 2 FlowFile Stream" title="A bin of FlowFiles will be combined into a single Version 2 FlowFile Stream"></img></li><li>FlowFile Tar, v1 <img src="../../html/images/iconInfo.png" alt="A bin of FlowFiles will be combined into a single Version 1 FlowFile Package" title="A bin of FlowFiles will be combined into a single Version 1 FlowFile Package"></img></li><li>Binary Concatenation <img src="../../html/images/iconInfo.png" alt="The contents of all FlowFiles will be concatenated together into a single FlowFile" title="The contents of all FlowFiles will be concatenated together into a single FlowFile"></img></li></ul></td><td id="d escription">Determines the format that will be used to merge the content.</td></tr><tr><td id="name"><strong>Attribute Strategy</strong></td><td id="default-value">Keep Only Common Attributes</td><td id="allowable-values"><ul><li>Keep Only Common Attributes</li><li>Keep All Unique Attributes</li></ul></td><td id="description">Determines which FlowFile attributes should be added to the bundle. If 'Keep All Unique Attributes' is selected, any attribute on any FlowFile that gets bundled will be kept unless its value conflicts with the value from another FlowFile. If 'Keep Only Common Attributes' is selected, only the attributes that exist on all FlowFiles in the bundle, with the same value, will be preserved.</td></tr><tr><td id="name">Correlation Attribute Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">If specified, like FlowFiles will be binned together, where 'like FlowFiles' means FlowFiles that have the same value for this Attribute. If no t specified, FlowFiles are bundled by the order in which they are pulled from the queue.</td></tr><tr><td id="name"><strong>Minimum Number of Entries</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The minimum number of files to include in a bundle</td></tr><tr><td id="name">Maximum Number of Entries</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum number of files to include in a bundle. If not specified, there is no maximum.</td></tr><tr><td id="name"><strong>Minimum Group Size</strong></td><td id="default-value">0 B</td><td id="allowable-values"></td><td id="description">The minimum size of for the bundle</td></tr><tr><td id="name">Maximum Group Size</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The maximum size for the bundle. If not specified, there is no maximum.</td></tr><tr><td id="name">Max Bin Age</td><td id="default-value"></td><td id="allowabl e-values"></td><td id="description">The maximum age of a Bin that will trigger a Bin to be complete. Expected format is <duration> <time unit> where <duration> is a positive integer and time unit is one of seconds, minutes, hours</td></tr><tr><td id="name"><strong>Maximum number of Bins</strong></td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specifies the maximum number of bins that can be held in memory at any one time</td></tr><tr><td id="name">Header File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Filename specifying the header to use. If not specified, no header is supplied. This property is valid only when using the binary-concatenation merge strategy; otherwise, it is ignored.</td></tr><tr><td id="name">Footer File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Filename specifying the footer to use. If not specified, no footer is supplied. Thi s property is valid only when using the binary-concatenation merge strategy; otherwise, it is ignored.</td></tr><tr><td id="name">Demarcator File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Filename specifying the demarcator to use. If not specified, no demarcator is supplied. This property is valid only when using the binary-concatenation merge strategy; otherwise, it is ignored.</td></tr><tr><td id="name"><strong>Compression Level</strong></td><td id="default-value">1</td><td id="allowable-values"><ul><li>0</li><li>1</li><li>2</li><li>3</li><li>4</li><li>5</li><li>6</li><li>7</li><li>8</li><li>9</li></ul></td><td id="description">Specifies the compression level to use when using the Zip Merge Format; if not using the Zip Merge Format, this value is ignored</td></tr><tr><td id="name"><strong>Keep Path</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 using the Zip or Tar Merge Format, specifies whether or not the FlowFiles' paths should be included in their entry names; if using other merge strategy, this value is ignored</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>If the bundle cannot be created, all FlowFiles that would have been used to created the bundle will be transferred to failure</td></tr><tr><td>original</td><td>The FlowFiles that were used to create the bundle</td></tr><tr><td>merged</td><td>The FlowFile containing the merged content</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>fragment.identifier</td><td>Applicable only if the <Merge Strategy> property is set to Defragment. All FlowFiles with the same value for this attribute will be bundled together</td></tr><tr><td>fragment.index</td><td>Applicable only if the <Merge Strategy> property is set to Defragment. This attribute must be present on all FlowFiles with the same value for the fragment.identifier attribute and must be a unique integer between 0 and the value of the fragment.count attribute. This attribute indicates the order in which the fragments should be assembled</td></tr><tr><td>fragment.count</td><td>Applicable only if the <Merge Strategy> property is set to Defragment. This attribute must be present on all FlowFiles with the same value for the fragment.identifier attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of this attribute indicates how many FlowFiles should be expected in the given bundle</td></tr><tr><td>segment.original.filename</td><td>Applicable only if the <Merge Strategy> property is set to Defragment. This attribute must be present on all FlowFiles with the same value for the fragment.identifier attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of this attribute will be used for the filename of the completed merged FlowFile</td></tr><tr><td>tar.permissions</td><td>Applicable only if the <Merge Format> property is set to TAR. The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive) and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute is missing or has an invalid value, the default value of 644 will be used</td></tr></table><h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>When more than 1 file is merged, the filename comes from the segment.original.filename attribute. If that attribute does not exist in the source FlowFiles, then the filename is set to the number of nanoseconds matching system time. Then a filename extension may be applied:if Merge Format is TAR, then the filename will be appended with .tar, if Merge Format is ZIP, then the filename will be appended with .zip, if Merge Format is FlowFileStream, then the filename will be appended with .pkg</td></tr><tr><td>merge.count</td><td>The number of FlowFiles that were merged into this bundle</td></tr><tr><td>merge.bin.age</td><td>The age of the bin, in milliseconds, when it was merged and output. Effectively this is the greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it was output</td></tr></table><h3>See Also:</h3><p><a href="../org.apache.nifi.processors.standard.SegmentContent/index.html">SegmentContent</a></p></body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ModifyBytes/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ModifyBytes/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ModifyBytes/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ModifyBytes/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ModifyBytes</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Keep or discard bytes range from a binary file.</p><h3>Tags: </h3><p>binary, discard, keep</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>Start Offset</strong></td><td id="default-value">0 B</td><td id="allowable-values"></td><td id="description">Number of bytes removed at the beginning of the file.</td></tr><tr><td id="name"><strong>End Offset</strong></td><td id="default-value">0 B</td><td id="allowable-values"></td><td id="description">Number of bytes removed at the end of the file.</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Processed flowfiles.</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.</body></html> \ No newline at end of file Added: incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MonitorActivity/index.html URL: http://svn.apache.org/viewvc/incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MonitorActivity/index.html?rev=1682431&view=auto ============================================================================== --- incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MonitorActivity/index.html (added) +++ incubator/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.MonitorActivity/index.html Fri May 29 11:51:20 2015 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MonitorActivity</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Monitors the flow for activity and sends out an indicator when the flow has not had any data for some specified amount of time and again when the flow's activity is restored</p><h3>Tags: </h3><p>monitor, flow, active, inactive, activity, detection</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>Threshold Duration</strong></td><td id="default-value">5 min</td><td id="allowable-values"></td><td id="description">Determines how much time must elapse before considering the flow to be inactive</td></tr><tr><td id="name"><strong>Continually Send Messages</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 send inactivity indicator continually every Threshold Duration amount of time until activity is restored; if false, will send an indicator only when the flow first becomes inactive</td></tr><tr><td id="name"><strong>Inactivity Message</strong></td><td id="default-value">Lacking activity as of time: ${now():format('yyyy/MM/dd HH:mm:ss')}; flow has been inactive for ${inactivityDura tionMillis:toNumber():divide(60000)} minutes</td><td id="allowable-values"></td><td id="description">The message that will be the content of FlowFiles that are sent to the 'inactive' relationship<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Activity Restored Message</strong></td><td id="default-value">Activity restored at time: ${now():format('yyyy/MM/dd HH:mm:ss')} after being inactive for ${inactivityDurationMillis:toNumber():divide(60000)} minutes</td><td id="allowable-values"></td><td id="description">The message that will be the content of FlowFiles that are sent to 'activity.restored' relationship<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Copy Attributes</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 copy all flow file attributes from the flow file that resumed activity to the newly created indicator flow file</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>inactive</td><td>This relationship is used to transfer an Inactivity indicator when no FlowFiles are routed to 'success' for Threshold Duration amount of time</td></tr><tr><td>success</td><td>All incoming FlowFiles are routed to success</td></tr><tr><td>activity.restored</td><td>This relationship is used to transfer an Activity Restored indicator when FlowFiles are routing to 'success' following a period of inactivity</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>inactivityStartMillis</td><td>The time at which Inactivity began, in the form of milliseconds since Epoch</td></tr><tr><td>inactivityDurationMillis</td><td>The number of milliseconds that the inactivity has spanned</td></tr></table></body></html> \ No newline at end of file
