Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ambari.AmbariReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ambari.AmbariReportingTask/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ambari.AmbariReportingTask/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ambari.AmbariReportingTask/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AmbariReportingTask</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes metrics from NiFi to Ambari Metrics Service (AMS). Due to how the Ambari Metrics Service works, this reporting task should be scheduled to run every 60 seconds. Each iteration it will send the metrics from the previous iteration, and calculate the current metrics to be sent on next iteration. Scheduling this reporting task at a frequency other than 60 seconds may produce unexpected results.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, ambari, metrics</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a hre f="../../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>Metrics Collector URL</strong></td><td id="default-value">http://localhost:6188/ws/v1/timeline/metrics</td><td id="allowable-values"></td><td id="description">The URL of the Ambari Metrics Collector Service<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Application ID</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The Application ID to be included in the metrics sent to Ambari<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The Hostname of this NiFi instance to be included in the metrics sent to Ambari<br/><strong>Supp orts Expression Language: true</strong></td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>AmbariReportingTask</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes metrics from NiFi to Ambari Metrics Service (AMS). Due to how the Ambari Metrics Service works, this reporting task should be scheduled to run every 60 seconds. Each iteration it will send the metrics from the previous iteration, and calculate the current metrics to be sent on next iteration. Scheduling this reporting task at a frequency other than 60 seconds may produce unexpected results.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, ambari, metrics</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a hre f="../../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>Metrics Collector URL</strong></td><td id="default-value">http://localhost:6188/ws/v1/timeline/metrics</td><td id="allowable-values"></td><td id="description">The URL of the Ambari Metrics Collector Service<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Application ID</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">The Application ID to be included in the metrics sent to Ambari<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Hostname</strong></td><td id="default-value">${hostname(true)}</td><td id="allowable-values"></td><td id="description">The Hostname of this NiFi instance to be included in the metrics sent to Ambari<br/><strong>Supp orts Expression Language: true</strong></td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file
Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DataDogReportingTask</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes metrics from NiFi to datadog. For accurate and informative reporting, components should have unique names.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, datadog, metrics</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Metrics prefix</strong></td><td id="default-value">nifi</td><td id=" allowable-values"></td><td id="description">Prefix to be added before every metric<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Environment</strong></td><td id="default-value">dev</td><td id="allowable-values"></td><td id="description">Environment, dataflow is running in. This property will be included as metrics tag.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">API key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Datadog API key. If specified value is 'agent', local Datadog agent will be used.</td></tr><tr><td id="name"><strong>Datadog transport</strong></td><td id="default-value">Datadog HTTP</td><td id="allowable-values"><ul><li>Datadog Agent <img src="../../html/images/iconInfo.png" alt="Metrics will be sent via locally installed Datadog agent. Datadog agent needs to be installed manually before using this option" title="Metrics will be sent via locally inst alled Datadog agent. Datadog agent needs to be installed manually before using this option"></img></li><li>Datadog HTTP <img src="../../html/images/iconInfo.png" alt="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set" title="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set"></img></li></ul></td><td id="description">Transport through which metrics will be sent to Datadog</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DataDogReportingTask</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Publishes metrics from NiFi to datadog. For accurate and informative reporting, components should have unique names.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>reporting, datadog, metrics</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Metrics prefix</strong></td><td id="default-value">nifi</td><td id=" allowable-values"></td><td id="description">Prefix to be added before every metric<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Environment</strong></td><td id="default-value">dev</td><td id="allowable-values"></td><td id="description">Environment, dataflow is running in. This property will be included as metrics tag.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">API key</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Datadog API key. If specified value is 'agent', local Datadog agent will be used.</td></tr><tr><td id="name"><strong>Datadog transport</strong></td><td id="default-value">Datadog HTTP</td><td id="allowable-values"><ul><li>Datadog Agent <img src="../../html/images/iconInfo.png" alt="Metrics will be sent via locally installed Datadog agent. Datadog agent needs to be installed manually before using this option" title="Metrics will be sent via locally inst alled Datadog agent. Datadog agent needs to be installed manually before using this option"></img></li><li>Datadog HTTP <img src="../../html/images/iconInfo.png" alt="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set" title="Metrics will be sent via HTTP transport with no need of Agent installed. Datadog API key needs to be set"></img></li></ul></td><td id="description">Transport through which metrics will be sent to Datadog</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.ganglia.StandardGangliaReporter/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardGangliaReporter</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Reports metrics to Ganglia so that Ganglia can be used for external monitoring of the application. Metrics reported include JVM Metrics (optional); the following 5-minute NiFi statistics: FlowFiles Received, Bytes Received, FlowFiles Sent, Bytes Sent, Bytes Read, Bytes Written, Total Task Duration; and the current values for FlowFiles Queued, Bytes Queued, and number of Active Threads.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>ganglia, stats</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>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The fully-qualified name of the host on which Ganglia is running</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">8649</td><td id="allowable-values"></td><td id="description">The Port on which Ganglia is listening for incoming connections</td></tr><tr><td id="name"><strong>Send JVM Metrics</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not JVM Metrics should be gathered and sent, in addition to NiFi-specific metrics</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardGangliaReporter</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Reports metrics to Ganglia so that Ganglia can be used for external monitoring of the application. Metrics reported include JVM Metrics (optional); the following 5-minute NiFi statistics: FlowFiles Received, Bytes Received, FlowFiles Sent, Bytes Sent, Bytes Read, Bytes Written, Total Task Duration; and the current values for FlowFiles Queued, Bytes Queued, and number of Active Threads.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>ganglia, stats</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>Hostname</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">The fully-qualified name of the host on which Ganglia is running</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">8649</td><td id="allowable-values"></td><td id="description">The Port on which Ganglia is listening for incoming connections</td></tr><tr><td id="name"><strong>Send JVM Metrics</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not JVM Metrics should be gathered and sent, in addition to NiFi-specific metrics</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -29,7 +29,7 @@ <p> When the processor is triggered, it sends the SNMP request and gets the information associated to request OID(s). Once response is received from the SNMP agent, a FlowFile is constructed. The FlowFile content is empty, all the information is written in the FlowFile attributes. - In case of a single GET request, the properties associated to the received PDU are transfered into the FlowFile as attributes. In case of a + In case of a single GET request, the properties associated to the received PDU are transferred into the FlowFile as attributes. In case of a WALK request, only the couples "OID/value" are transferred into the FlowFile as attributes. SNMP attributes names are prefixed with <i>snmp$</i> prefix. </p> Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.GetSNMP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSNMP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves information from SNMP Agent and outputs a FlowFile with information in attributes and without any content</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, get, oid, walk</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable V alues</th><th>Description</th></tr><tr><td id="name"><strong>OID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The OID to request</td></tr><tr><td id="name"><strong>SNMP strategy (GET/WALK)</strong></td><td id="default-value">GET</td><td id="allowable-values"><ul><li>GET</li><li>WALK</li></ul></td><td id="description">SNMP strategy to use (SNMP Get or SNMP Walk)</td></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="descript ion">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><t d id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds ) when requesting the SNMP Agent</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 from the SNMP agent are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot received from the SNMP agent 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 +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetSNMP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves information from SNMP Agent and outputs a FlowFile with information in attributes and without any content</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, get, oid, walk</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable V alues</th><th>Description</th></tr><tr><td id="name"><strong>OID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The OID to request</td></tr><tr><td id="name"><strong>SNMP strategy (GET/WALK)</strong></td><td id="default-value">GET</td><td id="allowable-values"><ul><li>GET</li><li>WALK</li></ul></td><td id="description">SNMP strategy to use (SNMP Get or SNMP Walk)</td></tr><tr><td id="name"><strong>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="descript ion">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Security Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><t d id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li><li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds ) when requesting the SNMP Agent</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 from the SNMP agent are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot received from the SNMP agent are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -28,7 +28,7 @@ </p> <p> The processor constructs SNMP Set requests by extracting information from FlowFile attributes. The processor is looking for attributes - prefixed with <i>snmp$</i>. If such an attribute is found, the attribute name is splitted using the $ character. The second element must + prefixed with <i>snmp$</i>. If such an attribute is found, the attribute name is split using the $ character. The second element must respect the OID format to be considered as a valid OID. If there is a third element, it must represents the SMI Syntax integer value of the type of data associated to the given OID to allow a correct conversion. If there is no third element, the value is considered as a String and the value will be sent as an OctetString object. Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.snmp.processors.SetSNMP/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SetSNMP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Based on incoming FlowFile attributes, the processor will execute SNMP Set requests. When founding attributes with name like snmp$<OID>, the processor will atempt to set the value of attribute to the corresponding OID given in the attribute name</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, set, oid</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the pr operty <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>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Securit y Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li>< li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</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 have been successfully used to perform SNMP Set are routed to this rela tionship</td></tr><tr><td>failure</td><td>All FlowFiles that failed during the SNMP Set care 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 +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SetSNMP</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Based on incoming FlowFile attributes, the processor will execute SNMP Set requests. When founding attributes with name like snmp$<OID>, the processor will atempt to set the value of attribute to the corresponding OID given in the attribute name</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>snmp, set, oid</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the pr operty <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>Host Name</strong></td><td id="default-value">localhost</td><td id="allowable-values"></td><td id="description">Network address of SNMP Agent (e.g., localhost)</td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value">161</td><td id="allowable-values"></td><td id="description">Numeric value identifying Port of SNMP Agent (e.g., 161)</td></tr><tr><td id="name"><strong>SNMP Version</strong></td><td id="default-value">SNMPv1</td><td id="allowable-values"><ul><li>SNMPv1</li><li>SNMPv2c</li><li>SNMPv3</li></ul></td><td id="description">SNMP Version to use</td></tr><tr><td id="name">SNMP Community (v1 & v2c)</td><td id="default-value">public</td><td id="allowable-values"></td><td id="description">SNMP Community to use (e.g., public)</td></tr><tr><td id="name"><strong>SNMP Securit y Level</strong></td><td id="default-value">authPriv</td><td id="allowable-values"><ul><li>noAuthNoPriv</li><li>authNoPriv</li><li>authPriv</li></ul></td><td id="description">SNMP Security Level to use</td></tr><tr><td id="name">SNMP Security name / user name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Security name used for SNMP exchanges</td></tr><tr><td id="name"><strong>SNMP Authentication Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>MD5</li><li>SHA</li><li></li></ul></td><td id="description">SNMP Authentication Protocol to use</td></tr><tr><td id="name">SNMP Authentication pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP authentication protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>SNMP Private Protocol</strong></td><td id="default-value"></td><td id="allowable-values"><ul><li>DES</li>< li>3DES</li><li>AES128</li><li>AES192</li><li>AES256</li><li></li></ul></td><td id="description">SNMP Private Protocol to use</td></tr><tr><td id="name">SNMP Private protocol pass phrase</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Pass phrase used for SNMP private protocol<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name"><strong>Number of retries</strong></td><td id="default-value">0</td><td id="allowable-values"></td><td id="description">Set the number of retries when requesting the SNMP Agent</td></tr><tr><td id="name"><strong>Timeout (ms)</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">Set the timeout (in milliseconds) when requesting the SNMP Agent</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 have been successfully used to perform SNMP Set are routed to this rela tionship</td></tr><tr><td>failure</td><td>All FlowFiles that failed during the SNMP Set care routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/additionalDetails.html Tue Nov 29 12:33:21 2016 @@ -35,7 +35,7 @@ In this case NiFi simply plays the role of the runtime host.</li> <li><i>One way (NiFi -> Spring or Spring -> NiFi). </i> - This depends on existence of pre-defined message channel in Spring Application Context. The name of the channel should be âfromNiFiâ and the type <i>org.springframework.messaging.MessageChannel.</i></li> - <li><i>By-directional (NiFi -> Spring -> Nifi or Spring -> NiFi -> Spring)</i> - This depends on existence of two channels + <li><i>By-directional (NiFi -> Spring -> NiFi or Spring -> NiFi -> Spring)</i> - This depends on existence of two channels in Spring Application Context. One channel receives messages from NiFi with name âfromNiFiâ and type <i>org.springframework.messaging.MessageChannel</i>i> and another is to receive messages from Spring with name âtoNiFiâ and type <i>org.springframework.messaging.PollableChannel.</i></li> </ul> @@ -87,7 +87,7 @@ Defaults to 0 (don't wait). FlowFiles that were successfully sent to Spring will be removed from session while FlowFiles that could not be sent to Spring will be routed to <i>failure</i> relationship.</li> <li><i>Receive Timeout</i> - [OPTIONAL] - the wait time for receiving messages from Spring Application Context. Only required if NiFi plans to receive data from Spring. - Defaults to 0 (don't wait). FlowFile is created if and only if a message is successfully received from Spring. It is then transfered to <i>success</i> relationship.</li> + Defaults to 0 (don't wait). FlowFile is created if and only if a message is successfully received from Spring. It is then transferred to <i>success</i> relationship.</li> </ul> </p> </body> Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.spring.SpringContextProcessor/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SpringContextProcessor</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>A Processor that supports sending and receiving data from application defined in Spring Application Context via predefined in/out MessageChannels.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Spring, Message, Get, Put, Integration</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>Application Context config path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path to the Sp ring Application Context configuration file relative to the classpath</td></tr><tr><td id="name"><strong>Application Context class path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the directory with resources (i.e., JARs, configuration files etc.) required to be on the classpath of the ApplicationContext.</td></tr><tr><td id="name">Send Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for sending data to Spring Application Context. Defaults to 0.</td></tr><tr><td id="name">Receive Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for receiving date from Spring context. Defaults to 0.</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 successfully received from Spring Application Context are routed to this relationship</td></ tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to Spring Application Context 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 +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SpringContextProcessor</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>A Processor that supports sending and receiving data from application defined in Spring Application Context via predefined in/out MessageChannels.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Spring, Message, Get, Put, Integration</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>Application Context config path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The path to the Sp ring Application Context configuration file relative to the classpath</td></tr><tr><td id="name"><strong>Application Context class path</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the directory with resources (i.e., JARs, configuration files etc.) required to be on the classpath of the ApplicationContext.</td></tr><tr><td id="name">Send Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for sending data to Spring Application Context. Defaults to 0.</td></tr><tr><td id="name">Receive Timeout</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Timeout for receiving date from Spring context. Defaults to 0.</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 successfully received from Spring Application Context are routed to this relationship</td></ tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to Spring Application Context are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Modified: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ssl.StandardSSLContextService/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ssl.StandardSSLContextService/index.html?rev=1771896&r1=1771895&r2=1771896&view=diff ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ssl.StandardSSLContextService/index.html (original) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.ssl.StandardSSLContextService/index.html Tue Nov 29 12:33:21 2016 @@ -1 +1 @@ -<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardSSLContextService</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Standard implementation of the SSLContextService. Provides the ability to configure keystore and/or truststore properties once and reuse that configuration throughout the application</p><h3>Tags: </h3><p>ssl, secure, certificate, keystore, truststore, jks, p12, pkcs12, pkcs</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Keystore Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the Keystore</td></tr><tr><td id="name">Keystore Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the Keystore<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Key Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the key. If this is not specified, but the Keystore Filename, Password, and Type are specified, then the Keystore Password will be assumed to be the same as the Key Password.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Keystore Type</td><td id="default-value"></td><td id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td id="description" >The Type of the Keystore</td></tr><tr><td id="name">Truststore >Filename</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The fully-qualified filename of the >Truststore</td></tr><tr><td id="name">Truststore Password</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The password for the Truststore<br/><strong>Sensitive >Property: true</strong></td></tr><tr><td id="name">Truststore Type</td><td >id="default-value"></td><td >id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td >id="description">The Type of the Truststore. Either JKS or >PKCS12</td></tr><tr><td id="name">SSL Protocol</td><td >id="default-value">TLS</td><td >id="allowable-values"><ul><li>SSL</li><li>SSLv2Hello</li><li>SSLv3</li><li>TLS</li><li>TLSv1</li><li>TLSv1.1</li><li>TLSv1.2</li></ul></td><td > id="description">The algorithm to use for this SSL >context</td></tr></table></body></html> \ No newline at end of file +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardSSLContextService</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Standard implementation of the SSLContextService. Provides the ability to configure keystore and/or truststore properties once and reuse that configuration throughout the application</p><h3>Tags: </h3><p>ssl, secure, certificate, keystore, truststore, jks, p12, pkcs12, pkcs</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name">Keystore Filename</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The fully-qualified filename of the Keystore</td></tr><tr><td id="name">Keystore Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the Keystore<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Key Password</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The password for the key. If this is not specified, but the Keystore Filename, Password, and Type are specified, then the Keystore Password will be assumed to be the same as the Key Password.<br/><strong>Sensitive Property: true</strong></td></tr><tr><td id="name">Keystore Type</td><td id="default-value"></td><td id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td id="description" >The Type of the Keystore</td></tr><tr><td id="name">Truststore >Filename</td><td id="default-value"></td><td id="allowable-values"></td><td >id="description">The fully-qualified filename of the >Truststore</td></tr><tr><td id="name">Truststore Password</td><td >id="default-value"></td><td id="allowable-values"></td><td >id="description">The password for the Truststore<br/><strong>Sensitive >Property: true</strong></td></tr><tr><td id="name">Truststore Type</td><td >id="default-value"></td><td >id="allowable-values"><ul><li>JKS</li><li>PKCS12</li></ul></td><td >id="description">The Type of the Truststore. Either JKS or >PKCS12</td></tr><tr><td id="name">SSL Protocol</td><td >id="default-value">TLS</td><td >id="allowable-values"><ul><li>SSL</li><li>SSLv2Hello</li><li>SSLv3</li><li>TLS</li><li>TLSv1</li><li>TLSv1.1</li><li>TLSv1.2</li></ul></td><td > id="description">The algorithm to use for this SSL >context</td></tr></table><h3>State management: </h3>This processor has no >state management.<h3>Rest ricted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketClient/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketClient/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketClient/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketClient/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JettyWebSocketClient</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Implementation of WebSocketClientService. This service uses Jetty WebSocket client module to provide WebSocket session management throughout the application.</p><h3>Tags: </h3><p>WebSocket, Jetty, 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, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Buffer Size</strong></td><td id="default-value">4 kb</td><td id="allowable-values"></td>< td id="description">The size of the input (read from network layer) buffer size.</td></tr><tr><td id="name"><strong>Max Text Message Size</strong></td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a text message during parsing/generating.</td></tr><tr><td id="name"><strong>Max Binary Message Size</strong></td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a binary message during parsing/generating.</td></tr><tr><td id="name"><strong>WebSocket URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The WebSocket URI this client connects to.<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 to use in order to secure the server. If specified, the server will accept only WSS requests; otherwise, the server will accept only WS requests</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">3 sec</td><td id="allowable-values"></td><td id="description">The timeout to connect the WebSocket URI.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html?rev=1771896&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.websocket.jetty.JettyWebSocketServer/index.html Tue Nov 29 12:33:21 2016 @@ -0,0 +1 @@ +<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JettyWebSocketServer</title><link rel="stylesheet" href="../../css/component-usage.css" type="text/css"></link></head><body><h2>Description: </h2><p>Implementation of WebSocketServerService. This service uses Jetty WebSocket server module to provide WebSocket session management throughout the application.</p><h3>Tags: </h3><p>WebSocket, Jetty, server</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property supports the <a href="../../html/expression-language-guide.html">NiFi Expression Language</a>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>Input Buffer Size</strong></td><td id="default-value">4 kb</td><td id="allowable-values"></td>< td id="description">The size of the input (read from network layer) buffer size.</td></tr><tr><td id="name"><strong>Max Text Message Size</strong></td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a text message during parsing/generating.</td></tr><tr><td id="name"><strong>Max Binary Message Size</strong></td><td id="default-value">64 kb</td><td id="allowable-values"></td><td id="description">The maximum size of a binary message during parsing/generating.</td></tr><tr><td id="name"><strong>Listen Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port number on which this WebSocketServer listens to.<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="../or g.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 WSS requests; otherwise, the server will accept only WS requests</td></tr><tr><td id="name"><strong>Client Authentication</strong></td><td id="default-value">no</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 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 Context Service> Property is not specified or the SSL Context provided uses only a KeyStore and not a TrustStore.</td></tr></table><h3>State management: </h3>This processor has no state management.<h3>Restricted: </h3></body></html> \ No newline at end of file
