nifi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jsto...@apache.org
Subject svn commit: r1811008 [10/43] - in /nifi/site/trunk/docs: ./ nifi-docs/ nifi-docs/components/ nifi-docs/components/org.apache.nifi/ nifi-docs/components/org.apache.nifi/nifi-ambari-nar/ nifi-docs/components/org.apache.nifi/nifi-ambari-nar/1.4.0/ nifi-do...
Date Tue, 03 Oct 2017 13:30:27 GMT
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.4.0/org.apache.nifi.processors.hl7.RouteHL7/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.4.0/org.apache.nifi.processors.hl7.RouteHL7/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.4.0/org.apache.nifi.processors.hl7.RouteHL7/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hl7-nar/1.4.0/org.apache.nifi.processors.hl7.RouteHL7/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RouteHL7</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">RouteHL7</h1><h2>Description: </h2><p>Routes incoming HL7 data according to user-defined queries. To add a query, add a new property to the processor. The name of the property will become a new relationship for the processor, and the value is an HL7 Query Language query. If a FlowFile matches the query, a copy of the FlowFile will be routed to the associated relationship.</p><h3>Tags: </h3><p>HL7, healthcare, route, Health Level 7</p><h3>Properties: </h3><p>In the list below, the names of required properties appear in <strong>bold</strong>. Any other properties (not in bold) are considered optional. Th
 e table also indicates any default values, 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>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The Character Encoding that is used to encode the HL7 data<br/><strong>Supports Expression Language: true</strong></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">Name of a Relationship</td><td id="value">An HL7 Query Language query</td><td>If a FlowFile matches the query, it will be routed to a relationship with the name of the property</td></tr></table></p><h3>Relationships: 
 </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Any FlowFile that cannot be parsed as HL7 will be routed to this relationship</td></tr><tr><td>original</td><td>The original FlowFile that comes into this processor will be routed to this relationship, unless it is routed to 'failure'</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>RouteHL7.Route</td><td>The name of the relationship to which the FlowFile was routed</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.</body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.GetHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.GetHTMLElement/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.GetHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.GetHTMLElement/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetHTMLElement</h1><h2>Description: </h2><p>Extracts HTML element values from the incoming flowfile's content using a CSS selector. The incoming HTML is first converted into a HTML Document Object Model so that HTML elements may be selected in the similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string. The result of "querying" the HTML DOM may produce 0-N results. If no results are found the flowfile will be transferred to the "element not found" relationship to indicate so to the end user. If N resul
 ts are found a new flowfile will be created and emitted for each result. The query result will either be placed in the content of the new flowfile or as an attribute of the new flowfile. By default the result is written to an attribute. This can be controlled by the "Destination" property. Resulting query values may also have data prepended or appended to them by setting the value of property "Prepend Element Value" or "Append Element Value". Prepended and appended values are treated as string values and concatenated to the result retrieved from the HTML DOM query operation. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>get, html, dom, css, element</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 proper
 ty 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>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Base URL for the HTML page being parsed. This URL will be used to resolve an absolute URL when an attribute value is extracted from a HTML element.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selector syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of 
 the input HTML</td></tr><tr><td id="name"><strong>Output Type</strong></td><td id="default-value">HTML</td><td id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li><li>Data</li></ul></td><td id="description">Controls the type of DOM value that is retrieved from the HTML element.</td></tr><tr><td id="name"><strong>Destination</strong></td><td id="default-value">flowfile-attribute</td><td id="allowable-values"><ul><li>flowfile-attribute</li><li>flowfile-content</li></ul></td><td id="description">Control if element extracted is written as a flowfile attribute or as flowfile content.</td></tr><tr><td id="name">Prepend Element Value</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Prepends the specified value to the resulting Element<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Append Element Value</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Appends the specif
 ied value to the resulting Element<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Attribute Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When getting the value of a HTML element attribute this value is used as the key to determine which attribute on the selected element should be retrieved. This value is used when the "Output Type" is set to "Attribute". If this value is prefixed with 'abs:', then the extracted attribute value will be converted into an absolute URL form using the specified base URL.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><t
 d>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</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>HTMLElement</td><td>Flowfile attribute where the element result parsed from the HTML using the CSS selector syntax are placed if the destination is a flowfile attribute.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a>, <a href="../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.ModifyHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.ModifyHTMLElement/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.ModifyHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.ModifyHTMLElement/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ModifyHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ModifyHTMLElement</h1><h2>Description: </h2><p>Modifies the value of an existing HTML element. The desired element to be modified is located by using CSS selector syntax. The incoming HTML is first converted into a HTML Document Object Model so that HTML elements may be selected in the similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string to find the element the user desires to modify. If the HTML element is found the element's value is updated in the DOM using the value specified "Modified Value"
  property. All DOM elements that match the CSS selector will be updated. Once all of the DOM elements have been updated the DOM is rendered to HTML and the result replaces the flowfile content with the updated HTML. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>modify, html, dom, css, element</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>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selec
 tor syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of the input HTML</td></tr><tr><td id="name"><strong>Output Type</strong></td><td id="default-value">HTML</td><td id="allowable-values"><ul><li>HTML</li><li>Text</li><li>Attribute</li></ul></td><td id="description">Controls whether the HTML element is output as HTML,Text or Data</td></tr><tr><td id="name"><strong>Modified Value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value to update the found HTML elements with<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Attribute Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">When modifying the value of an element attribute thi
 s value is used as the key to determine which attribute on the selected element will be modified with the new value.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</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>NumElementsModified</td><td>Total number of HTML element modifications made</td></tr></table><h3>State management: </h3>This component do
 es not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.GetHTMLElement/index.html">GetHTMLElement</a>, <a href="../org.apache.nifi.PutHTMLElement/index.html">PutHTMLElement</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.PutHTMLElement/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.PutHTMLElement/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.PutHTMLElement/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-html-nar/1.4.0/org.apache.nifi.PutHTMLElement/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutHTMLElement</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutHTMLElement</h1><h2>Description: </h2><p>Places a new HTML element in the existing HTML DOM. The desired position for the new HTML element is specified by using CSS selector syntax. The incoming HTML is first converted into a HTML Document Object Model so that HTML DOM location may be located in a similar manner that CSS selectors are used to apply styles to HTML. The resulting HTML DOM is then "queried" using the user defined CSS selector string to find the position where the user desires to add the new HTML element. Once the new HTML element is added to the DOM it is rendered to HTML and the
  result replaces the flowfile content with the updated HTML. A more thorough reference for the CSS selector syntax can be found at "http://jsoup.org/apidocs/org/jsoup/select/Selector.html"</p><h3>Tags: </h3><p>put, html, dom, css, element</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>CSS Selector</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">CSS selector syntax string used to extract the desired HTML element(s).<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>HTML
  Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">Character encoding of the input HTML</td></tr><tr><td id="name"><strong>Element Insert Location Type</strong></td><td id="default-value">append-html</td><td id="allowable-values"><ul><li>append-html</li><li>prepend-html</li></ul></td><td id="description">Controls whether the new element is prepended or appended to the children of the Element located by the CSS selector. EX: prepended value '&lt;b&gt;Hi&lt;/b&gt;' inside of Element (using CSS Selector 'p') '&lt;p&gt;There&lt;/p&gt;' would result in '&lt;p&gt;&lt;b&gt;Hi&lt;/b&gt;There&lt;/p&gt;'. Appending the value would result in '&lt;p&gt;There&lt;b&gt;Hi&lt;/b&gt;&lt;/p&gt;'</td></tr><tr><td id="name"><strong>Put Value</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Value used when creating the new Element. Value should be a valid HTML element. The text should be suppli
 ed unencoded: characters like '&lt;', '&gt;', etc will be properly HTML encoded in the resulting output.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>element not found</td><td>Element could not be found in the HTML document. The original HTML input will remain in the FlowFile content unchanged. Relationship 'original' will not be invoked in this scenario.</td></tr><tr><td>success</td><td>Successfully parsed HTML element</td></tr><tr><td>original</td><td>The original HTML input</td></tr><tr><td>invalid html</td><td>The input HTML syntax is invalid</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p
 ><a href="../org.apache.nifi.GetHTMLElement/index.html">GetHTMLElement</a>, <a href="../org.apache.nifi.ModifyHTMLElement/index.html">ModifyHTMLElement</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.4.0/org.apache.nifi.http.StandardHttpContextMap/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.4.0/org.apache.nifi.http.StandardHttpContextMap/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.4.0/org.apache.nifi.http.StandardHttpContextMap/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-http-context-map-nar/1.4.0/org.apache.nifi.http.StandardHttpContextMap/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>StandardHttpContextMap</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">StandardHttpContextMap</h1><h2>Description: </h2><p>Provides the ability to store and retrieve HTTP requests and responses external to a Processor, so that multiple Processors can interact with the same HTTP request.</p><h3>Tags: </h3><p>http, request, response</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>Maximum Outstanding Requests</strong></td><td id="default-value">5000</td><td id="allowable-values"></td><td id="description">The maximum number of HTTP requests that can be outstanding at any one time. Any attempt to register an additional HTTP Request will cause an error</td></tr><tr><td id="name"><strong>Request Expiration</strong></td><td id="default-value">1 min</td><td id="allowable-values"></td><td id="description">Specifies how long an HTTP Request should be left unanswered before being evicted from the cache and being responded to with a Service Unavailable status code</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../../../nifi-standard-nar/1.4.0/org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a>, <a href="../../../nifi-standard-nar/1.4.0/org.apache.nifi.processors.standard.HandleHttpResponse/inde
 x.html">HandleHttpResponse</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.4.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.4.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.4.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-hwx-schema-registry-nar/1.4.0/org.apache.nifi.schemaregistry.hortonworks.HortonworksSchemaRegistry/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>HortonworksSchemaRegistry</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">HortonworksSchemaRegistry</h1><h2>Description: </h2><p>Provides a Schema Registry Service that interacts with a Hortonworks Schema Registry, available at https://github.com/hortonworks/registry</p><h3>Tags: </h3><p>schema, registry, avro, hortonworks, hwx</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 Langua
 ge</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>Schema Registry URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URL of the schema registry that this Controller Service should connect to, including version. For example, http://localhost:9090/api/v1<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Cache Size</strong></td><td id="default-value">1000</td><td id="allowable-values"></td><td id="description">Specifies how many Schemas should be cached from the Hortonworks Schema Registry</td></tr><tr><td id="name"><strong>Cache Expiration</strong></td><td id="default-value">1 hour</td><td id="allowable-values"></td><td id="description">Specifies how long a Schema that is cached should remain in the cache. Once this time period elapses, a cached version of a schema will no longer be used, and the servi
 ce will have to communicate with the Hortonworks Schema Registry again in order to obtain the schema.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.</body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.GetIgniteCache/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GetIgniteCache</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">GetIgniteCache</h1><h2>Description: </h2><p>Get the byte array from Ignite Cache and adds it as the content of a FlowFile.The processor uses the value of FlowFile attribute (Ignite cache entry key) as the cache key lookup. If the entry corresponding to the key is not found in the cache an error message is associated with the FlowFile Note - The Ignite Kernel periodically outputs node performance statistics to the logs. This message  can be turned off by setting the log level for logger 'org.apache.ignite' to WARN in the logback.xml configuration file.</p><h3>Tags: </h3><p>Ignite, get, read, cache
 , key</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">Ignite Spring Properties Xml File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Ignite spring configuration file, &lt;path&gt;/&lt;ignite-configuration&gt;.xml. If the configuration file is not provided, default Ignite configuration configuration is used which binds to 127.0.0.1:47500..47509</td></tr><tr><td id="name">Ignite Cache Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the ignite cache</td></tr><tr><td id="name
 "><strong>Ignite Cache Entry Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining Ignite cache key for the Flow File content<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are written to Ignite cache are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Ignite cache are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>ignite.cache.get.failed.reason</td><td>The reason for getting entry from cache</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not
  restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html">PutIgniteCache</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-ignite-nar/1.4.0/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PutIgniteCache</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PutIgniteCache</h1><h2>Description: </h2><p>Stream the contents of a FlowFile to Ignite Cache using DataStreamer. The processor uses the value of FlowFile attribute (Ignite cache entry key) as the cache key and the byte array of the FlowFile as the value of the cache entry value.  Both the string key and a  non-empty byte array value are required otherwise the FlowFile is transferred to the failure relation. Note - The Ignite Kernel periodically outputs node performance statistics to the logs. This message  can be turned off by setting the log level for logger 'org.apache.ignite' to WARN in the l
 ogback.xml configuration file.</p><h3>Tags: </h3><p>Ignite, insert, update, stream, write, put, cache, key</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">Ignite Spring Properties Xml File</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Ignite spring configuration file, &lt;path&gt;/&lt;ignite-configuration&gt;.xml. If the configuration file is not provided, default Ignite configuration configuration is used which binds to 127.0.0.1:47500..47509</td></tr><tr><td id="name">Ignite Cache Name</td><td id="default-value"></td><td i
 d="allowable-values"></td><td id="description">The name of the ignite cache</td></tr><tr><td id="name"><strong>Batch Size For Entries</strong></td><td id="default-value">250</td><td id="allowable-values"></td><td id="description">Batch size for entries (1-500).</td></tr><tr><td id="name"><strong>Ignite Cache Entry Identifier</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A FlowFile attribute, or attribute expression used for determining Ignite cache key for the Flow File content<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Data Streamer Per Node Parallel Operations</strong></td><td id="default-value">5</td><td id="allowable-values"></td><td id="description">Data streamer per node parallelism</td></tr><tr><td id="name"><strong>Data Streamer Per Node Buffer Size</strong></td><td id="default-value">250</td><td id="allowable-values"></td><td id="description">Data streamer per node buffer size (1-
 500).</td></tr><tr><td id="name"><strong>Data Streamer Auto Flush Frequency in millis</strong></td><td id="default-value">10</td><td id="allowable-values"></td><td id="description">Data streamer flush interval in millis seconds</td></tr><tr><td id="name"><strong>Data Streamer Allow Override</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to override values already in the cache</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 written to Ignite cache are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to Ignite cache are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3>None specified.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>ignite.cache.batch.flow.fi
 le.total.count</td><td>The total number of FlowFile in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.item.number</td><td>The item number of FlowFile in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.successful.number</td><td>The successful FlowFile item number</td></tr><tr><td>ignite.cache.batch.flow.file.successful.count</td><td>The number of successful FlowFiles</td></tr><tr><td>ignite.cache.batch.flow.file.failed.number</td><td>The failed FlowFile item number</td></tr><tr><td>ignite.cache.batch.flow.file.failed.count</td><td>The total number of failed FlowFiles in the batch</td></tr><tr><td>ignite.cache.batch.flow.file.failed.reason</td><td>The failed reason attribute key</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.ignite.cache.GetIgniteC
 ache/index.html">GetIgniteCache</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/additionalDetails.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1,56 @@
+<!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>JMSConnectionFactoryProvider</title>
+        <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+    </head>
+
+    <body>
+        <h2>Description:</h2>
+        <p>
+            This ControllerService serves as a general factory service to serving vendor specific 
+            instances of the <i>javax.jms.ConnectionFactory</i>. It does so by allowing user to 
+            configure vendor specific properties as well as point to the location of the vendor 
+            provided JMS client libraries so the correct implementation of the <i>javax.jms.ConnectionFactory</i>
+            can be found, loaded, instantiated and served to the dependent Processors (see PublishJMS, ConsumeJMS).
+        </p>
+        <p>
+            To accommodate variety of JMS vendors and their implementation of the <i>ConnectionFactory</i> 
+            this ControllerService exposes only 3 static configuration properties that are common across many implementations 
+            of the <i>ConnectionFactory</i>. The rest of the configuration properties are set following 
+            <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm">Java Beans</a> convention (see below).
+	    </p>
+	    <p>
+        The 3 static configuration properties are:
+        <ul>
+  		  <li><b>MQ ConnectionFactory Implementation</b> - A fully qualified name of the JMS ConnectionFactory implementation 
+  		         class (i.e., org.apache.activemq.ActiveMQConnectionFactory)</li>
+          <li><b>MQ Client Libraries path</b> - Path to the directory with additional resources (i.e., JARs, configuration files etc.) to be added 
+							to the classpath. Such resources typically represent target MQ client libraries for the ConnectionFactory 
+							implementation. It is optional if you are using Apache ActiveMQ since its libraries are distributed with this component.</li>
+          <li><b>Broker URI</b> - URI pointing to the network location of the JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or simply 'myhost:1414'.</li>
+        </ul>
+        The rest of the properties are set as Dynamic Properties following <a href="http://docstore.mik.ua/orelly/java-ent/jnut/ch06_02.htm">Java Beans</a> 
+        convention where a property name is derived from the <i>set*</i> method of the vendor specific ConnectionFactory's implementation.
+        For example, <i>com.ibm.mq.jms.MQConnectionFactory.setChannel(String)</i> would imply 'channel' property and 
+        <i>com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)</i> would imply 'transportType' property.
+        For the list of available properties please consult vendor provided documentation. Here is an example for 
+        <a href="https://www-01.ibm.com/support/knowledgecenter/SSFKSJ_8.0.0/com.ibm.mq.javadoc.doc/WMQJMSClasses/com/ibm/mq/jms/MQQueueConnectionFactory.html">IBM's com.ibm.mq.jms.MQConnectionFactory</a>
+        </p>
+    </body>
+</html>

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>JMSConnectionFactoryProvider</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">JMSConnectionFactoryProvider</h1><h2>Description: </h2><p>Provides a generic service to create vendor specific javax.jms.ConnectionFactory implementations. ConnectionFactory can be served once this service is configured successfully</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, messaging, integration, queue, topic, publish, subscribe</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>MQ ConnectionFactory Implementation</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A fully qualified name of the JMS ConnectionFactory implementation class (i.e., org.apache.activemq.ActiveMQConnectionFactory)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>MQ Client Libraries path (i.e., /usr/jms/lib)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to the directory with additional resources (i.e., JARs, configuration files etc.) to be added to the classpath. Such resources typically represent target MQ client libraries for the ConnectionFactory implementation.<br/><strong>S
 upports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Broker URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">URI pointing to the network location of the JMS Message broker. For example, 'tcp://myhost:61616' for ActiveMQ or 'myhost:1414' for IBM MQ<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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.4.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.4.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL
  connections.</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">The name of a Connection Factory configuration property.</td><td id="value">The value of a given Connection Factory configuration property.</td><td>The properties that are set following Java Beans convention where a property name is derived from the 'set*' method of the vendor specific ConnectionFactory's implementation. For example, 'com.ibm.mq.jms.MQConnectionFactory.setChannel(String)' would imply 'channel' property and 'com.ibm.mq.jms.MQConnectionFactory.setTransportType(int)' would imply 'transportType' property.</td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>See Also:</h3><p><a href="../../../nifi-jms-processors-nar/1.4.0/org.apache.nifi
 .jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../../../nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/index.html">PublishJMS</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/additionalDetails.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1,61 @@
+<!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>ConsumeJMS</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+    This processor consumes messages from JMS compliant messaging system and converts them to a FlowFile to be routed to the next component in the flow.
+</p>
+<p>
+    This processor does two things. It constructs FlowFile by extracting information from the consumed JMS message including body, standard 
+    <a href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html">JMS Headers</a> and Properties. 
+    The message body is written to a FlowFile while standard JMS Headers and Properties are set as FlowFile attributes.
+</p>
+
+<h2>Configuration Details</h2>
+<p>
+    At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. 
+    Other properties will be defined later as this component progresses.
+    Configuring ConsumeJMS:
+</p>
+<ol>
+    <li><b>User Name</b> - [OPTIONAL] User Name used for authentication and authorization when this processor obtains <i>javax.jms.Connection</i> 
+    from the pre-configured <i>javax.jms.ConnectionFactory</i> (see below).
+    </li>
+    <li><b>Password</b> - [OPTIONAL] Password used in conjunction with <b>User Name</b>.
+    </li>
+    <li><b>Destination Name</b> - [REQUIRED] the name of the <i>javax.jms.Destination</i>. 
+    Usually provided by administrator (e.g., 'topic://myTopic'). 
+    </li>
+    <li><b>Destination Type</b> - [OPTIONAL] the type of the <i>javax.jms.Destination</i>. Could be one of 'QUEUE' or 'TOPIC'
+    Usually provided by the administrator. Defaults to 'TOPIC'. 
+    </li>
+    <li><b>Session Cache size</b> - [OPTIONAL] Specify the desired size for the JMS Session cache (per JMS Session type). This cache 
+    size is the maximum limit for the number of cached Sessions.
+    Usually provided by the administrator (e.g., '2453'). Defaults to '1'.
+    </li>
+    <li><b>Connection Factory Service</b> - [REQUIRED] link to a pre-configured instance of org.apache.nifi.jms.cf.JMSConnectionFactoryProvider.
+    </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.ConsumeJMS/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeJMS</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ConsumeJMS</h1><h2>Description: </h2><p>Consumes JMS Message of type BytesMessage or TextMessage transforming its content to a FlowFile and transitioning it to 'success' relationship. JMS attributes such as headers and properties will be copied as FlowFile attributes.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, get, message, receive, consume</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>Connection Factory Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation: </strong><a href="../../../nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td id="description">The Controller Service that is used to obtain ConnectionFactory</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 Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'TOPIC</td></tr><tr><td id="name">User Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name 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</s
 trong></td></tr><tr><td id="name">Connection Client ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The client id to be set on the connection, if set. For durable non shared consumer this is mandatory, for all others it is optional, typically with shared consumers it is undesirable to be set. Please see JMS spec for further details<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum limit for the number of cached Sessions.</td></tr><tr><td id="name"><strong>Acknowledgement Mode</strong></td><td id="default-value">2</td><td id="allowable-values"><ul><li>AUTO_ACKNOWLEDGE (1) <img src="../../../../../html/images/iconInfo.png" alt="Automatically acknowledges a client's receipt of a message, regardless if NiFi session has been commited. Can result in data loss in the event where NiFi abru
 ptly stopped before session was commited." title="Automatically acknowledges a client's receipt of a message, regardless if NiFi session has been commited. Can result in data loss in the event where NiFi abruptly stopped before session was commited."></img></li><li>CLIENT_ACKNOWLEDGE (2) <img src="../../../../../html/images/iconInfo.png" alt="(DEFAULT) Manually acknowledges a client's receipt of a message after NiFi Session was commited, thus ensuring no data loss" title="(DEFAULT) Manually acknowledges a client's receipt of a message after NiFi Session was commited, thus ensuring no data loss"></img></li><li>DUPS_OK_ACKNOWLEDGE (3) <img src="../../../../../html/images/iconInfo.png" alt="This acknowledgment mode instructs the session to lazily acknowledge the delivery of messages. May result in both data duplication and data loss while achieving the best throughput." title="This acknowledgment mode instructs the session to lazily acknowledge the delivery of messages. May result in b
 oth data duplication and data loss while achieving the best throughput."></img></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">Durable subscription</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If destination is Topic if present then make it the consumer durable. @see https://docs.oracle.com/javaee/7/api/javax/jms/Session.html#createDurableConsumer-javax.jms.Topic-java.lang.String-<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Shared subscription</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">If destination is Topic if present then make it the consumer shared. @see https://docs.oracle.com/javaee/7/api/javax/jms/Session
 .html#createSharedConsumer-javax.jms.Topic-java.lang.String-<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name">Subscription Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the subscription to use if destination is Topic and is shared or durable.<br/><strong>Supports Expression Language: true</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All FlowFiles that are received from the JMS Destination 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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.PublishJMS/index.html
 ">PublishJMS</a>, <a href="../../../nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/additionalDetails.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1,64 @@
+<!DOCTYPE html>
+<html lang="en">
+<!--
+  Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+      http://www.apache.org/licenses/LICENSE-2.0
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+-->
+<head>
+    <meta charset="utf-8" />
+    <title>PublishJMS</title>
+    <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+
+<body>
+<h2>Summary</h2>
+<p>
+    This processor publishes the contents of the incoming FlowFile to a JMS compliant messaging system.
+</p>
+<p>
+    This processor does two things. It constructs JMS Message by extracting FlowFile contents (both body and attributes). 
+    Once message is constructed it is sent to a pre-configured JMS Destination.
+    Standard <a href="http://docs.spring.io/spring-integration/api/org/springframework/integration/jms/JmsHeaders.html">JMS Headers</a> 
+    will be extracted from the FlowFile and set on <i>javax.jms.Message</i> as JMS headers while other 
+    FlowFile attributes will be set as properties of <i>javax.jms.Message</i>. Upon success the incoming FlowFile is transferred
+    to the <i>success</i> Relationship and upon failure FlowFile is
+    penalized and transferred to the <i>failure</i> Relationship.
+</p>
+<h2>Configuration Details</h2>
+<p>
+    At the time of writing this document it only defines the essential configuration properties which are suitable for most cases. 
+    Other properties will be defined later as this component progresses.
+    Configuring PublishJMS:
+</p>
+<ol>
+    <li><b>User Name</b> - [OPTIONAL] User Name used for authentication and authorization when this processor obtains <i>javax.jms.Connection</i> 
+    from the pre-configured <i>javax.jms.ConnectionFactory</i> (see below).
+    </li>
+    <li><b>Password</b> - [OPTIONAL] Password used in conjunction with <b>User Name</b>.
+    </li>
+    <li><b>Destination Name</b> - [REQUIRED] the name of the <i>javax.jms.Destination</i>. 
+    Usually provided by administrator (e.g., 'topic://myTopic'). 
+    </li>
+    <li><b>Destination Type</b> - [OPTIONAL] the type of the <i>javax.jms.Destination</i>. Could be one of 'QUEUE' or 'TOPIC'
+    Usually provided by the administrator. Defaults to 'TOPIC'. 
+    </li>
+    <li><b>Session Cache size</b> - [OPTIONAL] Specify the desired size for the JMS Session cache (per JMS Session type). This cache 
+    size is the maximum limit for the number of cached Sessions.
+    Usually provided by the administrator (e.g., '2453'). Defaults to '1'.
+    </li>
+    <li><b>Connection Factory Service</b> - [REQUIRED] link to a pre-configured instance of org.apache.nifi.jms.cf.JMSConnectionFactoryProvider.
+    </li>
+</ol>
+
+</body>
+</html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-jms-processors-nar/1.4.0/org.apache.nifi.jms.processors.PublishJMS/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PublishJMS</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">PublishJMS</h1><h2>Description: </h2><p>Creates a JMS Message from the contents of a FlowFile and sends it to a JMS Destination (queue or topic) as JMS BytesMessage. FlowFile attributes will be added as JMS headers and/or properties to the outgoing JMS message.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>jms, put, message, send, publish</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>Connection Factory Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>JMSConnectionFactoryProviderDefinition<br/><strong>Implementation: </strong><a href="../../../nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></td><td id="description">The Controller Service that is used to obtain ConnectionFactory</td></tr><tr><td id="nam
 e"><strong>Destination Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the JMS Destination. Usually provided by the administrator (e.g., 'topic://myTopic' or 'myTopic').<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Destination Type</strong></td><td id="default-value">QUEUE</td><td id="allowable-values"><ul><li>QUEUE</li><li>TOPIC</li></ul></td><td id="description">The type of the JMS Destination. Could be one of 'QUEUE' or 'TOPIC'. Usually provided by the administrator. Defaults to 'TOPIC</td></tr><tr><td id="name">User Name</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">User Name 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">Connection Client ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The client id to be set on the connection, if set. For durable non shared consumer this is mandatory, for all others it is optional, typically with shared consumers it is undesirable to be set. Please see JMS spec for further details<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Session Cache size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum limit for the number of cached Sessions.</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 sent to the JMS destination are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be sent to JMS destination 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 component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.jms.processors.ConsumeJMS/index.html">ConsumeJMS</a>, <a href="../../../nifi-jms-cf-service-nar/1.4.0/org.apache.nifi.jms.cf.JMSConnectionFactoryProvider/index.html">JMSConnectionFactoryProvider</a></p></body></html>
\ No newline at end of file

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/additionalDetails.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/additionalDetails.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1,142 @@
+<!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>ConsumeKafka</title>
+        <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+    </head>
+
+    <body>
+        <!-- Processor Documentation ================================================== -->
+        <h2>Description:</h2>
+        <p>
+            This Processor polls <a href="http://kafka.apache.org/">Apache Kafka</a>
+            for data using KafkaConsumer API available with Kafka 0.10.x. When a message is received 
+            from Kafka, the message will be deserialized using the configured Record Reader, and then
+            written to a FlowFile by serializing the message with the configured Record Writer.
+        </p>
+        <h2>Security Configuration:</h2>
+        <p>
+            The Security Protocol property allows the user to specify the protocol for communicating
+            with the Kafka broker. The following sections describe each of the protocols in further detail.
+        </p>
+        <h3>PLAINTEXT</h3>
+        <p>
+            This option provides an unsecured connection to the broker, with no client authentication and no encryption.
+            In order to use this option the broker must be configured with a listener of the form:
+        <pre>
+    PLAINTEXT://host.name:port
+            </pre>
+        </p>
+        <h3>SSL</h3>
+        <p>
+            This option provides an encrypted connection to the broker, with optional client authentication. In order
+            to use this option the broker must be configured with a listener of the form:
+        <pre>
+    SSL://host.name:port
+            </pre>
+        In addition, the processor must have an SSL Context Service selected.
+        </p>
+        <p>
+            If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will
+            not be required to present a certificate. In this case, the SSL Context Service selected may specify only
+            a truststore containing the public key of the certificate authority used to sign the broker's key.
+        </p>
+        <p>
+            If the broker specifies ssl.client.auth=required then the client will be required to present a certificate.
+            In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to
+            a truststore as described above.
+        </p>
+        <h3>SASL_PLAINTEXT</h3>
+        <p>
+            This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this
+            option the broker must be configured with a listener of the form:
+        <pre>
+    SASL_PLAINTEXT://host.name:port
+            </pre>
+        In addition, the Kerberos Service Name must be specified in the processor.
+        </p>
+        <h4>SASL_PLAINTEXT - GSSAPI</h4>
+        <p>
+            If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The
+            JAAS configuration can be provided by specifying the java.security.auth.login.config system property in
+            NiFi's bootstrap.conf, such as:
+        <pre>
+    java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf
+            </pre>
+        </p>
+        <p>
+            An example of the JAAS config file would be the following:
+        <pre>
+    KafkaClient {
+        com.sun.security.auth.module.Krb5LoginModule required
+        useKeyTab=true
+        storeKey=true
+        keyTab="/path/to/nifi.keytab"
+        serviceName="kafka"
+        principal="nifi@YOURREALM.COM";
+    };
+            </pre>
+        <b>NOTE:</b> The serviceName in the JAAS file must match the Kerberos Service Name in the processor.
+        </p>
+        <p>
+            Alternatively, starting with Apache NiFi 1.2.0 which uses the Kafka 0.10.2 client, the JAAS
+            configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab
+            directly in the processor properties. This will dynamically create a JAAS configuration like above, and
+            will take precedence over the java.security.auth.login.config system property.
+        </p>
+        <h4>SASL_PLAINTEXT - PLAIN</h4>
+        <p>
+            If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but
+            the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would
+            be the following:
+        <pre>
+    KafkaClient {
+      org.apache.kafka.common.security.plain.PlainLoginModule required
+      username="nifi"
+      password="nifi-password";
+    };
+            </pre>
+        </p>
+        <p>
+            <b>NOTE:</b> It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit
+            the username and password unencrypted.
+        </p>
+        <p>
+            <b>NOTE:</b> Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making
+            it visible to components in other NARs that may access the providers. There is currently a known issue
+            where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work.
+        </p>
+        <h3>SASL_SSL</h3>
+        <p>
+            This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this
+            option the broker must be configured with a listener of the form:
+        <pre>
+    SASL_SSL://host.name:port
+            </pre>
+        </p>
+        <p>
+            See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration
+            depending on the SASL mechanism (GSSAPI or PLAIN).
+        </p>
+        <p>
+            See the SSL section for a description of how to configure the SSL Context Service based on the
+            ssl.client.auth property.
+        </p>
+
+    </body>
+</html>

Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/index.html?rev=1811008&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-kafka-0-10-nar/1.4.0/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_10/index.html Tue Oct  3 13:30:16 2017
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ConsumeKafkaRecord_0_10</title><link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css"></link></head><script type="text/javascript">window.onload = function(){if(self==top) { document.getElementById('nameHeader').style.display = "inherit"; } }</script><body><h1 id="nameHeader" style="display: none;">ConsumeKafkaRecord_0_10</h1><h2>Description: </h2><p>Consumes messages from Apache Kafka specifically built against the Kafka 0.10.x Consumer API. The complementary NiFi processor for sending messages is PublishKafka_0_10. Please note that, at this time, the Processor assumes that all records that are retrieved from a given partition have the same schema. If any of the Kafka messages are pulled but cannot be parsed or written with the configured Record Reader or Record Writer, the contents of the message will be written to a separate FlowFile, and that FlowFile will be transferred to the
  'parse.failure' relationship. Otherwise, each FlowFile is sent to the 'success' relationship and may contain many individual messages within the single FlowFile. A 'record.count' attribute is added to indicate how many messages are contained in the FlowFile.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>Kafka, Get, Record, csv, avro, json, Ingest, Ingress, Topic, PubSub, Consume, 0.10.x</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>Kafka Brokers</strong></td><td id="default-value">localhost:9092</td><td id="allo
 wable-values"></td><td id="description">A comma-separated list of known Kafka Brokers in the format &lt;host&gt;:&lt;port&gt;<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Topic Name(s)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the Kafka Topic(s) to pull from. More than one can be supplied if comma separated.<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td id="name"><strong>Topic Name Format</strong></td><td id="default-value">names</td><td id="allowable-values"><ul><li>names <img src="../../../../../html/images/iconInfo.png" alt="Topic is a full topic name or comma separated list of names" title="Topic is a full topic name or comma separated list of names"></img></li><li>pattern <img src="../../../../../html/images/iconInfo.png" alt="Topic is a regex using the Java Pattern syntax" title="Topic is a regex using the Java Pattern syntax"></img></li></ul>
 </td><td id="description">Specifies whether the Topic(s) provided are a comma separated list of names or a single regular expression</td></tr><tr><td id="name"><strong>Record Reader</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordReaderFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><
 a href="../../../nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedReader/index.html">ScriptedReader</a></td><td id="description">The Record Reader to use for incoming FlowFiles</td></tr><tr><td id="name"><strong>Record Writer</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RecordSetWriterFactory<br/><strong>Implementations: </strong><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.json.JsonRecordSetWriter/index.html">JsonRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.text.FreeFormTextRecordSetWriter/index.html">FreeFormTextRecordSetWriter</a><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.avro.AvroRecordSetWriter/index.html">AvroRecordSetWriter</a><br/><a href="../../../nifi-scripting-nar/1.4.0/org.apache.nifi.record.script.ScriptedRecordSetWriter/index.html">ScriptedRecordSetWriter</a
 ><br/><a href="../../../nifi-record-serialization-services-nar/1.4.0/org.apache.nifi.csv.CSVRecordSetWriter/index.html">CSVRecordSetWriter</a></td><td id="description">The Record Writer to use in order to serialize the data before sending to Kafka</td></tr><tr><td id="name"><strong>Security Protocol</strong></td><td id="default-value">PLAINTEXT</td><td id="allowable-values"><ul><li>PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="PLAINTEXT" title="PLAINTEXT"></img></li><li>SSL <img src="../../../../../html/images/iconInfo.png" alt="SSL" title="SSL"></img></li><li>SASL_PLAINTEXT <img src="../../../../../html/images/iconInfo.png" alt="SASL_PLAINTEXT" title="SASL_PLAINTEXT"></img></li><li>SASL_SSL <img src="../../../../../html/images/iconInfo.png" alt="SASL_SSL" title="SASL_SSL"></img></li></ul></td><td id="description">Protocol used to communicate with brokers. Corresponds to Kafka's 'security.protocol' property.</td></tr><tr><td id="name">Kerberos Service Name</td><t
 d id="default-value"></td><td id="allowable-values"></td><td id="description">The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. Corresponds to Kafka's 'security.protocol' property.It is ignored unless one of the SASL options of the &lt;Security Protocol&gt; are selected.</td></tr><tr><td id="name">Kerberos Principal</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kerberos principal that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defined in the bootstrap.conf file. This principal will be set into 'sasl.jaas.config' Kafka's property.</td></tr><tr><td id="name">Kerberos Keytab</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The Kerberos keytab that will be used to connect to brokers. If not set, it is expected to set a JAAS configuration file in the JVM properties defi
 ned in the bootstrap.conf file. This principal will be set into 'sasl.jaas.config' Kafka's property.</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>Implementations: </strong><a href="../../../nifi-ssl-context-service-nar/1.4.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.4.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a></td><td id="description">Specifies the SSL Context Service to use for communicating with Kafka.</td></tr><tr><td id="name"><strong>Group ID</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A Group ID is used to identify consumers that are within the same consumer group. Corresponds to Kafka's 'group.id' property.</td></tr><tr><td id="nam
 e"><strong>Offset Reset</strong></td><td id="default-value">latest</td><td id="allowable-values"><ul><li>earliest <img src="../../../../../html/images/iconInfo.png" alt="Automatically reset the offset to the earliest offset" title="Automatically reset the offset to the earliest offset"></img></li><li>latest <img src="../../../../../html/images/iconInfo.png" alt="Automatically reset the offset to the latest offset" title="Automatically reset the offset to the latest offset"></img></li><li>none <img src="../../../../../html/images/iconInfo.png" alt="Throw exception to the consumer if no previous offset is found for the consumer's group" title="Throw exception to the consumer if no previous offset is found for the consumer's group"></img></li></ul></td><td id="description">Allows you to manage the condition when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted). Corresponds to Kafka's 'auto.offse
 t.reset' property.</td></tr><tr><td id="name">Max Poll Records</td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">Specifies the maximum number of records Kafka should return in a single poll.</td></tr><tr><td id="name">Max Uncommitted Time</td><td id="default-value">1 secs</td><td id="allowable-values"></td><td id="description">Specifies the maximum amount of time allowed to pass before offsets must be committed. This value impacts how often offsets will be committed.  Committing offsets less often increases throughput but also increases the window of potential data duplication in the event of a rebalance or JVM restart between commits.  This value is also related to maximum poll records and the use of a message demarcator.  When using a message demarcator we can have far more uncommitted messages than when we're not as there is much less for us to keep track of in memory.</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">The name of a Kafka configuration property.</td><td id="value">The value of a given Kafka configuration property.</td><td>These properties will be added on the Kafka configuration after loading any provided configuration properties. In the event a dynamic property represents a property that was already set, its value will be ignored and WARN message logged. For the list of available Kafka properties please refer to: http://kafka.apache.org/documentation.html#configuration. </td></tr></table></p><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles received from Kafka.  Depending on demarcation strategy it is a flow file per message or a bundle of messages grouped by topic and partition.</td></tr><tr><td>parse.failure</td><td>If a message from Kafka ca
 nnot be parsed using the configured Record Reader, the contents of the message will be routed to this Relationship as its own individual FlowFile.</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>record.count</td><td>The number of records received</td></tr><tr><td>mime.type</td><td>The MIME Type that is provided by the configured Record Writer</td></tr><tr><td>kafka.partition</td><td>The partition of the topic the records are from</td></tr><tr><td>kafka.topic</td><td>The topic records are from</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component does not allow an incoming relationship.<h3>See Also:</h3><p><a href="../org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html">ConsumeKafka_0_10</a>, <a href="../org.apache.nifi.processor
 s.kafka.pubsub.PublishKafka_0_10/index.html">PublishKafka_0_10</a>, <a href="../org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_10/index.html">PublishKafkaRecord_0_10</a></p></body></html>
\ No newline at end of file



Mime
View raw message