Author: jpercivall
Date: Tue Aug 30 03:55:02 2016
New Revision: 1758322
URL: http://svn.apache.org/viewvc?rev=1758322&view=rev
Log:
NIFI-2676 updating components to 1.0.0
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.ignite.cache.PutIgniteCache/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GenerateTableFetch/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.GenerateTableFetch/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListDatabaseTables/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.standard.ListDatabaseTables/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.windows.event.log.ConsumeWindowsEventLog/index.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/additionalDetails.html
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.reporting.datadog.DataDogReportingTask/index.html
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.FetchElasticsearchHttp/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>FetchElasticsearchHttp</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Retrieves a
document from Elasticsearch using the specified connection properties and the
identifier of the document to retrieve. Note that the full body of the document
will be read into memory before being written to a Flow File for
transfer.</p><h3>Tags: </h3><p>elasticsearch, fetch, read, get,
http</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 propert
y, 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>Elasticsearch
URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Elasticsearch URL which will be connected to, including
scheme, host, port, path. The default port for the REST API is
9200.</td></tr><tr><td id="name">SSL Context Service</td><td
id="default-value"></td><td id="allowable-values"><strong>Controller Service
API:
</strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td
id="description">The SSL Context Service used to provide client certificate
information for TLS/SSL connections. This service only applies if the
Elasticsearch endpoint(s)
have been secured with TLS/SSL.</td></tr><tr><td id="name">Username</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Username to access the Elasticsearch cluster</td></tr><tr><td
id="name">Password</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Password to access the
Elasticsearch cluster<br/><strong>Sensitive Property:
true</strong></td></tr><tr><td id="name"><strong>Connection
Timeout</strong></td><td id="default-value">5 secs</td><td
id="allowable-values"></td><td id="description">Max wait time for the
connection to the Elasticsearch REST API.</td></tr><tr><td
id="name"><strong>Response Timeout</strong></td><td id="default-value">15
secs</td><td id="allowable-values"></td><td id="description">Max wait time for
a response from the Elasticsearch REST API.</td></tr><tr><td
id="name"><strong>Document Identifier</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
identi
fier of the document to be fetched<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Index</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
name of the index to read from<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Type</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
(optional) type of this document, used by Elasticsearch for indexing and
searching. If the property is empty or set to _all, the first document matching
the identifier across all types will be retrieved.<br/><strong>Supports
Expression Language: true</strong></td></tr><tr><td id="name">Fields</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">A
comma-separated list of fields to retrieve from the document. If the Fields
property is left blank, then the entire document's source will be
retrieved.<br/><strong>Supports Express
ion Language: true</strong></td></tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>A
FlowFile is routed to this relationship if the document cannot be fetched but
attempting the operation again may succeed. Note that if the processor has no
incoming connections, flow files may still be sent to this relationship based
on the processor properties and the results of the fetch
operation.</td></tr><tr><td>success</td><td>All FlowFiles that are read from
Elasticsearch are routed to this
relationship.</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be
read from Elasticsearch are routed to this relationship. Note that only
incoming flow files will be routed to failure.</td></tr><tr><td>not
found</td><td>A FlowFile is routed to this relationship if the specified
document does not exist in the Elasticsearch cluster. Note that if the
processor has no incoming connections, flow files may still be sent to this
relationship based on the processor properties and the results of the fetch
operation.</td></tr></table><h3>Reads Attributes: </h3>None
specified.<h3>Writes Attributes: </h3><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The
filename attribute is set to the document
identifier</td></tr><tr><td>es.index</td><td>The Elasticsearch index containing
the document</td></tr><tr><td>es.type</td><td>The Elasticsearch document
type</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.elasticsearch.PutElasticsearchHttp/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PutElasticsearchHttp</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Writes the
contents of a FlowFile to Elasticsearch, using the specified parameters such as
the index to insert into and the type of the document.</p><h3>Tags:
</h3><p>elasticsearch, insert, update, upsert, delete, write, put,
http</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 t
he 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>Elasticsearch
URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Elasticsearch URL which will be connected to, including
scheme, host, port, path. The default port for the REST API is
9200.</td></tr><tr><td id="name">SSL Context Service</td><td
id="default-value"></td><td id="allowable-values"><strong>Controller Service
API:
</strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td
id="description">The SSL Context Service used to provide client certificate
information for TLS/SSL connections. This service only applies if the
Elasticsearch endpoint(s) have been secured with TLS/SSL.</td></tr><tr><td
id="name">Username</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Username to access the Elasticsearch cluster</td></tr><tr><td
id="name">Password</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Password to access the
Elasticsearch cluster<br/><strong>Sensitive Property:
true</strong></td></tr><tr><td id="name"><strong>Connection
Timeout</strong></td><td id="default-value">5 secs</td><td
id="allowable-values"></td><td id="description">Max wait time for the
connection to the Elasticsearch REST API.</td></tr><tr><td
id="name"><strong>Response Timeout</strong></td><td id="default-value">15
secs</td><td id="allowable-values"></td><td id="description">Max wait time for
a response from the Elasticsearch REST API.</td></tr><tr><td
id="name">Identifier Attribute</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The name of the FlowFile
attribute containing the identifier for the document. If the Index Operation
is "index", this property may be left empty or evaluate to an empty value, in
which case the document's identifier will be auto-generated by Elasticsearch.
For all other Index Operations, the attribute must evaluate to a non-empty
value.</td></tr><tr><td id="name"><strong>Index</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
name of the index to insert into<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Type</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
type of this document (used by Elasticsearch for indexing and
searching)<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Character Set</strong></td><td
id="default-value">UTF-8</td><td id="allowable-values"></td><td
id="description">Specifies the character set of the document
data.</td></tr><tr><td id="name"><strong>Batch Size</strong></td><td id="d
efault-value">100</td><td id="allowable-values"></td><td id="description">The
preferred number of flow files to put to the database in a single transaction.
Note that the contents of the flow files will be stored in memory until the
bulk operation is performed. Also the results should be returned in the same
order the flow files were received.</td></tr><tr><td id="name"><strong>Index
Operation</strong></td><td id="default-value">index</td><td
id="allowable-values"></td><td id="description">The type of the operation used
to index (index, update, upsert, delete)<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>retry</td><td>A
FlowFile is routed to this relationship if the database cannot be updated but
attempting the operation again may succeed</td></tr><tr><td>success</td><td>All
FlowFiles that are written to Elasticsearch are routed to this
relationship</td></t
r><tr><td>failure</td><td>All FlowFiles that cannot be written to
Elasticsearch are routed to this relationship</td></tr></table><h3>Reads
Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None
specified.</body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/additionalDetails.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1,58 @@
+<!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>ConsumeIMAP</title>
+<link rel="stylesheet" href="../../css/component-usage.css"
+ type="text/css" />
+</head>
+
+<body>
+ <!-- Processor Documentation
================================================== -->
+ <h2>Description:</h2>
+ <p>This Processor consumes email messages via IMAP protocol and sends
the content of an email message as content of the Flow File.
+ Content of the incoming email message is written as raw bytes to the
content of the outgoing Flow File.
+ </p>
+
+ <p>Different email providers may require additional Java Mail
properties which could be provided as dynamic properties.
+ For example, below is a sample configuration for GMail:
+
+ </p>
+ <p>
+ <b>Processor's static properties:</b>
+ <ul>
+ <li><b>Host Name</b> - imap.gmail.com</li>
+ <li><b>Port</b> - 993</li>
+ <li><b>User Name</b> - <i>[your user name]</i></li>
+ <li><b>Password</b> - <i>[your password]</i></li>
+ <li><b>Folder</b> - INBOX</li>
+ </ul>
+ <b>Processor's dynamic properties:</b>
+ <ul>
+ <li><b>mail.imap.socketFactory.class</b> -
javax.net.ssl.SSLSocketFactory</li>
+ <li><b>mail.imap.socketFactory.fallback</b> - false</li>
+ <li><b>mail.store.protocol</b> - imaps</li>
+ </ul>
+ </p>
+ <p>
+ Another useful property is <b>mail.debug</b> which allows Java Mail API
to print protocol messages to the console helping you to both understand what's
going on as well as debug issues.
+ </p>
+ <p>
+ For the full list of available Java Mail properties please refer to <a
href="http://connector.sourceforge.net/doc-files/Properties.html";>here</a>
+ </p>
+</body>
+</html>
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumeIMAP/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConsumeIMAP</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Consumes messages
from Email Server using IMAP protocol. The raw-bytes of each received email
message are written as contents of the FlowFile</p><p><a
href="additionalDetails.html">Additional Details...</a></p><h3>Tags:
</h3><p>Email, Imap, Get, Ingest, Ingress, Message, 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.pro
perties</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>Host
Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Network address of Email server
(e.g., pop.gmail.com, imap.gmail.com . . .)<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td
id="name"><strong>Port</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Numeric value identifying Port
of Email server (e.g., 993)<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>User Name</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">User Name used for authentication and authorization with Email
server.<br/><strong>Supports Expression Language: true</strong></td></tr><tr>
<td id="name"><strong>Password</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Password used for
authentication and authorization with Email server.<br/><strong>Sensitive
Property: true</strong><br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td
id="default-value">INBOX</td><td id="allowable-values"></td><td
id="description">Email folder to retrieve messages from (e.g.,
INBOX)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td
id="name"><strong>Fetch Size</strong></td><td id="default-value">10</td><td
id="allowable-values"></td><td id="description">Specify the maximum number of
Messages to fetch per call to Email Server.<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name"><strong>Delete
Messages</strong></td><td id="default-value">false</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="descripti
on">Specify whether mail messages should be deleted after
retrieval.</td></tr><tr><td id="name"><strong>Connection
timeout</strong></td><td id="default-value">30 sec</td><td
id="allowable-values"></td><td id="description">The amount of time to wait to
connect to Email server<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Mark Messages as
Read</strong></td><td id="default-value">false</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td
id="description">Specify if messages should be marked as read after
retrieval.</td></tr><tr><td id="name"><strong>Use SSL</strong></td><td
id="default-value">true</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td
id="description">Specifies if IMAP connection must be obtained via SSL
encrypted connection (i.e., IMAPS)</td></tr></table><h3>Relationships:
</h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All
messages t
hat are the are successfully received from Email server and converted to
FlowFiles are routed to this relationship</td></tr></table><h3>Reads
Attributes: </h3>None specified.<h3>Writes Attributes: </h3>None
specified.</body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/additionalDetails.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1,57 @@
+<!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>ConsumePOP3</title>
+<link rel="stylesheet" href="../../css/component-usage.css"
+ type="text/css" />
+</head>
+
+<body>
+ <!-- Processor Documentation
================================================== -->
+ <h2>Description:</h2>
+ <p>This Processor consumes email messages via POP3 protocol and sends
the content of an email message as content of the Flow File.
+ Content of the incoming email message is written as raw bytes to the
content of the outgoing Flow File.
+ </p>
+
+ <p>Since different serves may require different Java Mail
+ properties such properties could be provided via dynamic
properties.
+ For example, below is a sample configuration for GMail:
+ </p>
+ <p>
+ <b>Processor's static properties:</b>
+ <ul>
+ <li><b>Host Name</b> - pop.gmail.com</li>
+ <li><b>Port</b> - 995</li>
+ <li><b>User Name</b> - <i>[your user name]</i></li>
+ <li><b>Password</b> - <i>[your password]</i></li>
+ <li><b>Folder</b> - INBOX</li>
+ </ul>
+ <b>Processor's dynamic properties:</b>
+ <ul>
+ <li><b>mail.pop3.socketFactory.class</b> -
javax.net.ssl.SSLSocketFactory</li>
+ <li><b>mail.pop3.socketFactory.fallback</b> - false</li>
+ </ul>
+ </p>
+ <p>
+ Another useful property is <b>mail.debug</b> which allows Java
Mail API to print protocol messages to the console helping you to both
understand what's going on as well as debug issues.
+ </p>
+ <p>
+ For the full list of available Java Mail properties please refer to <a
href="http://connector.sourceforge.net/doc-files/Properties.html";>here</a>
+ </p>
+</body>
+</html>
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ConsumePOP3/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConsumePOP3</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Consumes messages
from Email Server using POP3 protocol. The raw-bytes of each received email
message are written as contents of the FlowFile</p><p><a
href="additionalDetails.html">Additional Details...</a></p><h3>Tags:
</h3><p>Email, POP3, Get, Ingest, Ingress, Message, 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.pro
perties</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>Host
Name</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Network address of Email server
(e.g., pop.gmail.com, imap.gmail.com . . .)<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td
id="name"><strong>Port</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Numeric value identifying Port
of Email server (e.g., 993)<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>User Name</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">User Name used for authentication and authorization with Email
server.<br/><strong>Supports Expression Language: true</strong></td></tr><tr>
<td id="name"><strong>Password</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Password used for
authentication and authorization with Email server.<br/><strong>Sensitive
Property: true</strong><br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Folder</strong></td><td
id="default-value">INBOX</td><td id="allowable-values"></td><td
id="description">Email folder to retrieve messages from (e.g.,
INBOX)<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td
id="name"><strong>Fetch Size</strong></td><td id="default-value">10</td><td
id="allowable-values"></td><td id="description">Specify the maximum number of
Messages to fetch per call to Email Server.<br/><strong>Supports Expression
Language: true</strong></td></tr><tr><td id="name"><strong>Delete
Messages</strong></td><td id="default-value">false</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="descripti
on">Specify whether mail messages should be deleted after
retrieval.</td></tr><tr><td id="name"><strong>Connection
timeout</strong></td><td id="default-value">30 sec</td><td
id="allowable-values"></td><td id="description">The amount of time to wait to
connect to Email server<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
messages that are the are successfully received from Email server and
converted to FlowFiles are routed to this
relationship</td></tr></table><h3>Reads Attributes: </h3>None
specified.<h3>Writes Attributes: </h3>None specified.</body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailAttachments/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ExtractEmailAttachments</title><link
rel="stylesheet" href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Extract
attachments from a mime formatted email file, splitting them into individual
flowfiles.</p><h3>Tags: </h3><p>split, email</p><h3>Properties: </h3><p>This
component has no required or optional properties.</p><h3>Relationships:
</h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>failure</td><td>Flowfiles
that could not be parsed</td></tr><tr><td>original</td><td>The original
file</td></tr><tr><td>attachments</td><td>Each individual attachment will be
routed to the attachments relationship</td></tr></table><h3>Reads Attributes:
</h3>None specified.<h3>Writes Attributes: </h3><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename
</td><td>The filename of the attachment</td></tr><tr><td>email.atta
chment.parent.filename </td><td>The filename of the parent
FlowFile</td></tr><tr><td>email.attachment.parent.uuid</td><td>The UUID of the
original FlowFile.</td></tr><tr><td>mime.type</td><td>The mime type of the
attachment.</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ExtractEmailHeaders/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ExtractEmailHeaders</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Using the flowfile
content as source of data, extract header from an RFC compliant email file
adding the relevant attributes to the flowfile. This processor does not perform
extensive RFC validation but still requires a bare minimum compliance with RFC
2822</p><h3>Tags: </h3><p>split, email</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">Additional Header
List</td><td id="default-value">x-mailer</td><td id="allowable-values"></td><td
id="description">COLON separated l
ist of additional headers to be extracted from the flowfile content.NOTE the
header key is case insensitive and will be matched as lower-case. Values will
respect email contents.</td></tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Extraction
was successful</td></tr><tr><td>failure</td><td>Flowfiles that could not be
parsed as a RFC-2822 compliant message</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>email.headers.bcc.*</td><td>Each
individual BCC recipient (if
available)</td></tr><tr><td>email.headers.cc.*</td><td>Each individual CC
recipient (if available)</td></tr><tr><td>email.headers.from.*</td><td>Each
individual mailbox contained in the From of the Email (array as per
RFC-2822)</td></tr><tr><td>email.headers.message-id</td><td>The value of the
Message-ID header (if available)</
td></tr><tr><td>email.headers.received_date</td><td>The Received-Date of the
message (if available)</td></tr><tr><td>email.headers.sent_date</td><td>Date
the message was sent</td></tr><tr><td>email.headers.subject</td><td>Subject of
the message (if available)</td></tr><tr><td>email.headers.to.*</td><td>Each
individual TO recipient (if
available)</td></tr><tr><td>email.attachment_count</td><td>Number of
attachments of the message</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.email.ListenSMTP/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ListenSMTP</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>This processor
implements a lightweight SMTP server to an arbitrary port, allowing nifi to
listen for incoming email. Note this server does not perform any email
validation. If direct exposure to the internet is sought, it may be a better
idea to use the combination of NiFi and an industrial scale MTA (e.g. Postfix).
Threading for this processor is managed by the underlying smtp server used so
the processor need not support more than one thread.</p><h3>Tags:
</h3><p>listen, email, smtp</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>Allowabl
e Values</th><th>Description</th></tr><tr><td id="name"><strong>Listening
Port</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The TCP port the ListenSMTP
processor will bind to.NOTE that on Unix derivative operating systems this
port must be higher than 1024 unless NiFi is running as with root user
permissions.</td></tr><tr><td id="name"><strong>Maximum number of SMTP
connection</strong></td><td id="default-value">1</td><td
id="allowable-values"></td><td id="description">The maximum number of
simultaneous SMTP connections.</td></tr><tr><td id="name"><strong>SMTP
connection timeout</strong></td><td id="default-value">60 seconds</td><td
id="allowable-values"></td><td id="description">The maximum time to wait for an
action of SMTP client.</td></tr><tr><td id="name"><strong>SMTP Maximum Message
Size</strong></td><td id="default-value">20 MB</td><td
id="allowable-values"></td><td id="description">The maximum number of bytes the
server will a
ccept.</td></tr><tr><td id="name">SSL Context Service</td><td
id="default-value"></td><td id="allowable-values"><strong>Controller Service
API:
</strong><br/>SSLContextService<br/><strong>Implementation:</strong><br/><a
href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td
id="description">The Controller Service to use in order to obtain an SSL
Context. If this property is set, messages will be received over a secure
connection.</td></tr><tr><td id="name">Client Auth</td><td
id="default-value"></td><td
id="allowable-values"><ul><li>NONE</li><li>REQUIRED</li></ul></td><td
id="description">The client authentication policy to use for the SSL Context.
Only used if an SSL Context Service is provided.</td></tr><tr><td
id="name">SMTP hostname</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">The hostname to be embedded
into the banner displayed when an SMTP client connects to the processor TCP
port .</td><
/tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>All
new messages will be routed as FlowFiles 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>smtp.helo</td><td>The
value used during HELO</td></tr><tr><td>smtp.certificates.*.serial</td><td>The
serial numbers for each of the certificates used by an TLS
peer</td></tr><tr><td>smtp.certificates.*.principal</td><td>The principal for
each of the certificates used by an TLS
peer</td></tr><tr><td>smtp.src</td><td>The source IP and port of the SMTP
connection</td></tr><tr><td>smtp.from</td><td>The value used during MAIL FROM
(i.e. envelope)</td></tr><tr><td>smtp.recipient.*</td><td>The values used
during RCPT TO (i.e. envelope)</td></tr><tr><td>mime.type</td><td>Mime type of
the message</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.enrich.QueryDNS/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>QueryDNS</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>A powerful DNS
query processor primary designed to enrich DataFlows with DNS based APIs (e.g.
RBLs, ShadowServer's ASN lookup) but that can be also used to perform regular
DNS lookups.</p><h3>Tags: </h3><p>dns, enrich, ip</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>Lookup value</strong></td><td id="default-value"></td><td
id="allowable-values"></td><td
id="description">The value that should be used to populate the
query<br/><strong>Supports Expression Language: true</strong></td></tr><tr><td
id="name"><strong>Results Parser</strong></td><td
id="default-value">None</td><td id="allowable-values"><ul><li>Split <img
src="../../html/images/iconInfo.png" alt="Use a delimiter character or RegEx
to split the results into attributes" title="Use a delimiter character or RegEx
to split the results into attributes"></img></li><li>RegEx <img
src="../../html/images/iconInfo.png" alt="Use a regular expression to split the
results into attributes " title="Use a regular expression to split the results
into attributes "></img></li><li>None <img src="../../html/images/iconInfo.png"
alt="Do not split results" title="Do not split
results"></img></li></ul></td><td id="description">The method used to slice the
results into attribute groups</td></tr><tr><td id="name">Parser RegEx</td><td
id="default-value"></td><td id="allowable-values"></td><td id="de
scription">Choice between a splitter and regex matcher used to parse the
results of the query into attribute groups</td></tr><tr><td
id="name"><strong>DNS Query Retries</strong></td><td
id="default-value">1</td><td id="allowable-values"></td><td
id="description">The number of attempts before giving up and moving
on</td></tr><tr><td id="name"><strong>DNS Query Timeout</strong></td><td
id="default-value">1500 ms</td><td id="allowable-values"></td><td
id="description">The amount of time to wait until considering a query as
failed</td></tr><tr><td id="name">DNS Servers</td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">A
comma separated list of DNS servers to be used. (Defaults to system wide if
none is used)</td></tr><tr><td id="name"><strong>DNS Query
Type</strong></td><td id="default-value">TXT</td><td
id="allowable-values"></td><td id="description">The DNS query type to be used
by the processor (e.g. TXT, A)</td></tr></table><h3>Relationships: </h3>
<table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>not
found</td><td>Where to route flow files if data enrichment query rendered no
results</td></tr><tr><td>found</td><td>Where to route flow files after
successfully enriching attributes with data</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>enrich.dns.record*.group*</td><td>The
captured fields of the DNS query response for each of the records
received</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/additionalDetails.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1,91 @@
+<!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>ParseEvtx</title>
+
+ <link rel="stylesheet" href="../../css/component-usage.css"
type="text/css" />
+ </head>
+
+ <body>
+ <!-- Processor Documentation
================================================== -->
+ <h2>Description:</h2>
+ <p>This processor is used to parse Windows event logs in the binary
evtx format. The input flow files' content should be evtx files. The processor
has 4 outputs:
+ <ul>
+ <li>The original unmodified FlowFile</li>
+ <li>The XML resulting from parsing at the configured
granularity</li>
+ <li>Failed parsing with partial output</li>
+ <li>Malformed chunk in binary form</li>
+ </ul>
+ </p>
+ <h2>Output XML Example:</h2>
+ <p>
+ <pre>
+<?xml version="1.0"?>
+<Events>
+ <Event
xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
+ <System>
+ <Provider Name="Service Control Manager"
Guid="{555908d1-a6d7-4695-8e1e-26931d2012f4}" Ev
+entSourceName="Service Control Manager"/>
+ <EventID Qualifiers="16384">7036</EventID>
+ <Version>0</Version>
+ <Level>4</Level>
+ <Task>0</Task>
+ <Opcode>0</Opcode>
+ <Keywords>0x8080000000000000</Keywords>
+ <TimeCreated SystemTime="2016-01-08 16:49:47.518"/>
+ <EventRecordID>780</EventRecordID>
+ <Correlation ActivityID=""
RelatedActivityID=""/>
+ <Execution ProcessID="480" ThreadID="596"/>
+ <Channel>System</Channel>
+ <Computer>win7-pro-vm</Computer>
+ <Security UserID=""/>
+ </System>
+ <EventData>
+ <Data Name="param1">Workstation</Data>
+ <Data Name="param2">running</Data>
+
<Binary>TABhAG4AbQBhAG4AVwBvAHIAawBzAHQAYQB0AGkAbwBuAC8ANAAAAA==</Binary>
+ </EventData>
+ </Event>
+ <Event
xmlns="http://schemas.microsoft.com/win/2004/08/events/event">
+ <System>
+ <Provider Name="Service Control Manager"
Guid="{555908d1-a6d7-4695-8e1e-26931d2012f4}"
EventSourceName="Service Control Manager"/>
+ <EventID Qualifiers="16384">7036</EventID>
+ <Version>0</Version>
+ <Level>4</Level>
+ <Task>0</Task>
+ <Opcode>0</Opcode>
+ <Keywords>0x8080000000000000</Keywords>
+ <TimeCreated SystemTime="2016-01-08 16:49:47.535"/>
+ <EventRecordID>781</EventRecordID>
+ <Correlation ActivityID=""
RelatedActivityID=""/>
+ <Execution ProcessID="480" ThreadID="576"/>
+ <Channel>System</Channel>
+ <Computer>win7-pro-vm</Computer>
+ <Security UserID=""/>
+ </System>
+ <EventData>
+ <Data Name="param1">Cryptographic Services</Data>
+ <Data Name="param2">running</Data>
+ <Binary>QwByAHkAcAB0AFMAdgBjAC8ANAAAAA==</Binary>
+ </EventData>
+ </Event>
+</Events>
+ </pre>
+ </p>
+</body>
+</html>
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.evtx.ParseEvtx/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ParseEvtx</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Parses the
contents of a Windows Event Log file (evtx) and writes the resulting XML to the
FlowFile</p><p><a href="additionalDetails.html">Additional
Details...</a></p><h3>Tags: </h3><p>logs, windows, event, evtx, message,
file</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>Granularity</strong></td><td id="default-value">Chunk</td><td
id="allowable-values"><ul><li>Record</li><li>Chunk</li><li>File</li></ul></td><td
id="description">Output flow file for each Record, Chunk
, or File encountered in the event log</td></tr></table><h3>Relationships:
</h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Any
FlowFile that was successfully converted from evtx to
XML</td></tr><tr><td>failure</td><td>Any FlowFile that encountered an exception
during conversion will be transferred to this relationship with as much parsing
as possible done</td></tr><tr><td>original</td><td>The unmodified input
FlowFile will be transferred to this relationship</td></tr><tr><td>bad
chunk</td><td>Any bad chunks of records will be transferred to this
relationship in their original binary form</td></tr></table><h3>Reads
Attributes: </h3><table
id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The
filename of the evtx file</td></tr></table><h3>Writes Attributes: </h3><table
id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>filename</td><td>The
output filename</td></tr><tr><td>mime
.type</td><td>The output filetype (application/xml for success and failure
relationships, original value for bad chunk and original
relationships)</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hadoop.DeleteHDFS/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>DeleteHDFS</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Deletes a file
from HDFS. The file can be provided as an attribute from an incoming FlowFile,
or a statically set file that is periodically removed. If this processor has an
incoming connection, itwill ignore running on a periodic basis and instead rely
on incoming FlowFiles to trigger a delete. Optionally, you may specify use a
wildcard character to match multiple files or directories.</p><h3>Tags:
</h3><p>hadoop, HDFS, delete, remove, filesystem</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">Hadoop Configuration Resources</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">A file or comma separated list
of files which contains the Hadoop file system configuration. Without this,
Hadoop will search the classpath for a 'core-site.xml' and 'hdfs-site.xml' file
or will revert to a default configuration.</td></tr><tr><td id="name">Kerberos
Principal</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">Kerberos principal to authenticate as. Requires
nifi.kerberos.krb5.file to be set in your nifi.properties</td></tr><tr><td
id="name">Kerberos Keytab</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">Kerberos keytab associated with
the principal. Requires nifi.kerberos.krb5.file to be set in your
nifi.properties</td></tr><tr><td id="name">Kerberos Relo
gin Period</td><td id="default-value">4 hours</td><td
id="allowable-values"></td><td id="description">Period of time which should
pass before attempting a kerberos relogin</td></tr><tr><td
id="name"><strong>File or Directory</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
HDFS file or directory to delete. A wildcard expression may be used to only
delete certain files<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name"><strong>Recursive</strong></td><td
id="default-value">true</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td
id="description">Remove contents of a non-empty directory
recursively</td></tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles
will be routed here if the delete command was
successful</td></tr><tr><td>failure</td><td>FlowFiles will be routed here if
the delete command was un
successful</td></tr></table><h3>Reads Attributes: </h3>None
specified.<h3>Writes Attributes: </h3>None specified.</body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.ConvertAvroToORC/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConvertAvroToORC</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Converts an Avro
record into ORC file format. This processor provides a direct mapping of an
Avro record to an ORC record, such that the resulting ORC file will have the
same hierarchical structure as the Avro document. If an incoming FlowFile
contains a stream of multiple Avro records, the resultant FlowFile will contain
a ORC file containing all of the Avro records. If an incoming FlowFile does
not contain any records, an empty ORC file is the output.</p><h3>Tags:
</h3><p>avro, orc, hive, convert</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/e
xpression-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">ORC Configuration
Resources</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">A file or comma separated list of files which contains the ORC
configuration (hive-site.xml, e.g.). Without this, Hadoop will search the
classpath for a 'hive-site.xml' file or will revert to a default configuration.
Please see the ORC documentation for more details.</td></tr><tr><td
id="name"><strong>Stripe Size</strong></td><td id="default-value">64 MB</td><td
id="allowable-values"></td><td id="description">The size of the memory buffer
(in bytes) for writing stripes to an ORC file</td></tr><tr><td
id="name"><strong>Buffer Size</strong></td><td id="default-value">10 KB</td><td
id="allowable-values"></td><td id="description">The maximum size of the memory
buffers (in bytes) used fo
r compressing and storing a stripe in memory. This is a hint to the ORC
writer, which may choose to use a smaller buffer size based on stripe size and
number of columns for efficient stripe writing and memory
utilization.</td></tr><tr><td id="name"><strong>Compression
Type</strong></td><td id="default-value">NONE</td><td
id="allowable-values"><ul><li>NONE</li><li>ZLIB</li><li>SNAPPY</li><li>LZO</li></ul></td><td
id="description">No Description Provided.</td></tr><tr><td id="name">Hive
Table Name</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">An optional table name to insert into the hive.ddl attribute.
The generated DDL can be used by a PutHiveQL processor (presumably after a
PutHDFS processor) to create a table backed by the converted ORC file. If this
property is not provided, the full name (including namespace) of the incoming
Avro record will be normalized and used as the table name.<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>A
> FlowFile is routed to this relationship after it has been converted to ORC
>format.</td></tr><tr><td>failure</td><td>A FlowFile is routed to this
>relationship if it cannot be parsed as Avro or cannot be converted to ORC for
>any reason</td></tr></table><h3>Reads Attributes: </h3>None
>specified.<h3>Writes Attributes: </h3><table
>id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mime.type</td><td>Sets
> the mime type to
>application/octet-stream</td></tr><tr><td>filename</td><td>Sets the filename
>to the existing filename with the extension replaced by / added to by
>.orc</td></tr><tr><td>record.count</td><td>Sets the number of records in the
>ORC file.</td></tr><tr><td>hive.ddl</td><td>Creates a partial Hive DDL
>statement for creating a table in Hive from this ORC file. This can be used
>in ReplaceText for setting the content to the DDL. To
make it valid DDL, add "LOCATION '<path_to_orc_file_in_hdfs>'", where
the path is the directory that contains this ORC file on HDFS. For example,
ConvertAvroToORC can send flow files to a PutHDFS processor to send the file to
HDFS, then to a ReplaceText to set the content to this DDL (plus the LOCATION
clause as described), then to PutHiveQL processor to create the table if it
doesn't exist.</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.hive.PutHiveStreaming/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>PutHiveStreaming</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>This processor
uses Hive Streaming to send flow file data to an Apache Hive table. The
incoming flow file is expected to be in Avro format and the table must exist in
Hive. Please see the Hive documentation for requirements on the Hive table
(format, partitions, etc.). The partition values are extracted from the Avro
record based on the names of the partition columns as specified in the
processor.</p><h3>Tags: </h3><p>hive, streaming, put, database,
store</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 Expressio
n 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>Hive Metastore URI</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
URI location for the Hive Metastore. Note that this is not the location of the
Hive Server. The default port for the Hive metastore is 9043.</td></tr><tr><td
id="name">Hive Configuration Resources</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">A file or comma separated list
of files which contains the Hive configuration (hive-site.xml, e.g.). Without
this, Hadoop will search the classpath for a 'hive-site.xml' file or will
revert to a default configuration. Note that to enable authentication with
Kerberos e.g., the appropriate properties must be set in the configuration
files. Please see the Hive documentation for more details.</td></tr><tr><td
id="name"><strong>Database Name</s
trong></td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">The name of the database in which to put the
data.</td></tr><tr><td id="name"><strong>Table Name</strong></td><td
id="default-value"></td><td id="allowable-values"></td><td id="description">The
name of the database table in which to put the data.</td></tr><tr><td
id="name">Partition Columns</td><td id="default-value"></td><td
id="allowable-values"></td><td id="description">A comma-delimited list of
column names on which the table has been partitioned. The order of values in
this list must correspond exactly to the order of partition columns specified
during the table creation.</td></tr><tr><td id="name"><strong>Auto-Create
Partitions</strong></td><td id="default-value">true</td><td
id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td
id="description">Flag indicating whether partitions should be automatically
created</td></tr><tr><td id="name"><strong>Max Open Connections</strong>
</td><td id="default-value">8</td><td id="allowable-values"></td><td
id="description">The maximum number of open connections that can be allocated
from this pool at the same time, or negative for no limit.</td></tr><tr><td
id="name"><strong>Heartbeat Interval</strong></td><td
id="default-value">60</td><td id="allowable-values"></td><td
id="description">Indicates that a heartbeat should be sent when the specified
number of seconds has elapsed. A value of 0 indicates that no heartbeat should
be sent.</td></tr><tr><td id="name"><strong>Transactions per
Batch</strong></td><td id="default-value">100</td><td
id="allowable-values"></td><td id="description">A hint to Hive Streaming
indicating how many transactions the processor task will need. This value must
be greater than 1.<br/><strong>Supports Expression Language:
true</strong></td></tr><tr><td id="name">Kerberos Principal</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Kerberos principal to authenti
cate as. Requires nifi.kerberos.krb5.file to be set in your
nifi.properties</td></tr><tr><td id="name">Kerberos Keytab</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Kerberos keytab associated with the principal. Requires
nifi.kerberos.krb5.file to be set in your
nifi.properties</td></tr></table><h3>Relationships: </h3><table
id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>retry</td><td>The
incoming FlowFile is routed to this relationship if its records cannot be
transmitted to Hive. Note that some records may have been processed
successfully, they will be routed (as JSON flow files) to the success
relationship. The combination of the retry, success, and failure relationships
indicate how many records succeeded and/or failed. This can be used to provide
a retry capability since full rollback is not
possible.</td></tr><tr><td>success</td><td>A FlowFile containing the JSON
contents of a record is routed to this relationship aft
er the record has been successfully transmitted to
Hive.</td></tr><tr><td>failure</td><td>A FlowFile containing the JSON contents
of a record is routed to this relationship if the record could not be
transmitted to Hive.</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>hivestreaming.record.count</td><td>This
attribute is written on the flow files routed to the 'success' and 'failure'
relationships, and contains the number of records from the incoming flow file
written successfully and unsuccessfully,
respectively.</td></tr></table></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/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.processors.ignite.cache.PutIgniteCache/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.ignite.cache.PutIgniteCache/index.html
Tue Aug 30 03:55:02 2016
@@ -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><body><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 transfered 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 logback.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, <path>/<ignite-configuration>.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>Batch Size For
Entries</strong></td><td id="default-value">250</td><td
id="allowable-values"></td><td id="description">Ba
tch 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.file.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.num
ber</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></body></html>
\ No newline at end of file
Added:
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html
URL:
http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html?rev=1758322&view=auto
==============================================================================
---
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html
(added)
+++
nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/index.html
Tue Aug 30 03:55:02 2016
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta
charset="utf-8"></meta><title>ConsumeKafka_0_10</title><link rel="stylesheet"
href="../../css/component-usage.css"
type="text/css"></link></head><body><h2>Description: </h2><p>Consumes messages
from Apache Kafka specifically built against the Kafka 0.10 Consumer API.
Please note there are cases where the publisher can get into an indefinite
stuck state. We are closely monitoring how this evolves in the Kafka community
and will take advantage of those fixes as soon as we can. In the mean time it
is possible to enter states where the only resolution will be to restart the
JVM NiFi runs on.</p><h3>Tags: </h3><p>Kafka, Get, Ingest, Ingress, Topic,
PubSub, Consume, 0.10</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/expr
ession-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="allowable-values"></td><td id="description">A comma-separated list of known
Kafka Brokers in the format <host>:<port><br/><strong>Supports
Expression Language: true</strong></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><td 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 <Security Protocol> are
>selected.</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">Specifies the SSL Context Service to use for communicating
>with Kafka.</td></tr><tr><td id="name"><strong>Topic Name(s)</strong></td><td
>id="d
efault-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
seperated.<br/><strong>Supports Expression Language:
true</strong></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="name"><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.offset.reset' property.</td></tr><tr><td
id="name"><strong>Key Attribute Encoding</strong></td><td
id="default-value">utf-8</td><td id="allowable-values"><ul><li>UTF-8 Encoded
<img src="../../html/images/iconInfo.png" alt="The key is interpreted as a
UTF-8 Encoded string." title="The key is interpreted as a UTF-8 Encoded
string."></img></li><li>Hex Encoded <img src="../../html/images/iconInfo.png"
alt="The key is interpreted as arbitrary binary data and is encoded using
hexadecimal characters with uppercase letters
" title="The key is interpreted as arbitrary binary data and is encoded using
hexadecimal characters with uppercase letters"></img></li></ul></td><td
id="description">FlowFiles that are emitted have an attribute named
'kafka.key'. This property dictates how the value of the attribute should be
encoded.</td></tr><tr><td id="name">Message Demarcator</td><td
id="default-value"></td><td id="allowable-values"></td><td
id="description">Since KafkaConsumer receives messages in batches, you have an
option to output FlowFiles which contains all Kafka messages in a single batch
for a given topic and partition and this property allows you to provide a
string (interpreted as UTF-8) to use for demarcating apart multiple Kafka
messages. This is an optional property and if not provided each Kafka message
received will result in a single FlowFile which time it is triggered. To enter
special character such as 'new line' use CTRL+Enter or Shift+Enter depending on
the OS<br/><strong>Supports Expressi
on Language: true</strong></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></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: </h
3><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></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>kafka.count</td><td>The
number of messages written if more than
one</td></tr><tr><td>kafka.key</td><td>The key of message if present and if
single message. How the key is encoded depends on the value of the 'Key
Attribute Encoding' property.</td></tr><tr><td>kafka.offset</td><td>The offset
of the message in the partition of the
topic.</td></tr><tr><td>kafka.partition</td><td>The partition of the topic the
message or message bundle is from</td></tr><tr><td>kafka.topic</td><td>The
topic the message or message bundle is from</td></tr></table></body></html>
\ No newline at end of file
