You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@nifi.apache.org by al...@apache.org on 2018/06/27 00:37:52 UTC
svn commit: r1834461 [18/42] - in /nifi/site/trunk/docs: ./ nifi-docs/
nifi-docs/components/org.apache.nifi/nifi-ambari-nar/1.7.0/
nifi-docs/components/org.apache.nifi/nifi-ambari-nar/1.7.0/org.apache.nifi.reporting.ambari.AmbariReportingTask/
nifi-doc...
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.controller.livy.LivySessionController/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.controller.livy.LivySessionController/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.controller.livy.LivySessionController/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.controller.livy.LivySessionController/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>LivySessionController</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;">LivySessionController</h1><h2>Description: </h2><p>Manages pool of Spark sessions over HTTP</p><h3>Tags: </h3><p>Livy, REST, Spark, 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, 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>Livy Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname (or IP address) of the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Livy Port</strong></td><td id="default-value">8998</td><td id="allowable-values"></td><td id="description">The port number for the Livy server.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Pool Size</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">Number of sessions to keep open<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Session Type</strong></td><td id="default-value">spark</td><td id="allowable-values"><ul><li>spark</li><li>pysp
ark</li><li>pyspark3</li><li>sparkr</li></ul></td><td id="description">The type of Spark session to start (spark, pyspark, pyspark3, sparkr, e.g.)</td></tr><tr><td id="name"><strong>Session Manager Status Interval</strong></td><td id="default-value">2 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between requesting session information updates.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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.7.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.7.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextServ
ice</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL (https) connections.</td></tr><tr><td id="name"><strong>Connection Timeout</strong></td><td id="default-value">5 secs</td><td id="allowable-values"></td><td id="description">Max wait time for connection to remote service.</td></tr><tr><td id="name">Session JARs</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">JARs to be used in the Spark session.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Session Files</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Files to be used in the Spark session.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Kerberos Credentials Service</td><td id="default-value"></td><td id="allowable-values"><strong>C
ontroller Service API: </strong><br/>KerberosCredentialsService<br/><strong>Implementation: </strong><a href="../../../nifi-kerberos-credentials-service-nar/1.7.0/org.apache.nifi.kerberos.KeytabCredentialsService/index.html">KeytabCredentialsService</a></td><td id="description">Specifies the Kerberos Credentials Controller Service that should be used for authenticating with Kerberos</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-livy-nar/1.7.0/org.apache.nifi.processors.livy.ExecuteSparkInteractive/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExecuteSparkInteractive</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;">ExecuteSparkInteractive</h1><h2>Description: </h2><p>Execute Spark Code over a Livy-managed HTTP session to a live Spark context. Supports cached RDD sharing.</p><h3>Tags: </h3><p>spark, livy, http, execute</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>Livy Controller Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>LivySessionService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.controller.livy.LivySessionController/index.html">LivySessionController</a></td><td id="description">The controller service to use for Livy-managed session(s).</td></tr><tr><td id="name">Code</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The code to execute in the session. This property can be empty, a constant value, or built from attributes using Expression Language. If this property is specified, it will be used regardless of the content of incoming flowfiles. If this property is empty, the content of the incoming flow file is expected to contain valid code to be issued by the processor to the session. Note that Expression Langua
ge is not evaluated for flow file contents.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</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">The character set encoding for the incoming flow file.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Status Check Interval</strong></td><td id="default-value">1 sec</td><td id="allowable-values"></td><td id="description">The amount of time to wait between checking the status of an operation.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>FlowFiles that a
re successfully processed are sent to this relationship</td></tr><tr><td>wait</td><td>FlowFiles that are waiting on an available Spark session will be sent to this relationship</td></tr><tr><td>failure</td><td>FlowFiles are routed to this relationship when they cannot be parsed</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>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.CSVRecordLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>CSVRecordLookupService</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;">CSVRecordLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service. When the lookup key is found in the CSV file, the columns are returned as a Record. All returned fields will be strings.</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, key, value, record</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>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file that will serve as the data source.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>InformixUnloadCsv</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li></ul></td><td id="description">Specifies which "format" the CSV data is in.</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">The Character Encoding that is used to decode the CSV file.<br/><strong>Supports E
xpression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The field in the CSV file that will serve as the lookup key. This is the field that will be matched against the property specified in the lookup processor.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.DistributedMapCacheLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DistributedMapCacheLookupService</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;">DistributedMapCacheLookupService</h1><h2>Description: </h2><p>Allows to choose a distributed map cache client to retrieve the value associated to a key. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value, map, cache, distributed</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>Distributed Cache Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>DistributedMapCacheClient<br/><strong>Implementations: </strong><a href="../../../nifi-distributed-cache-services-nar/1.7.0/org.apache.nifi.distributed.cache.client.DistributedMapCacheClientService/index.html">DistributedMapCacheClientService</a><br/><a href="../../../nifi-redis-nar/1.7.0/org.apache.nifi.redis.service.RedisDistributedMapCacheClientService/index.html">RedisDistributedMapCacheClientService</a><br/><a href="../../../nifi-hbase_1_1_2-client-service-nar/1.7.0/org.apache.nifi.hbase.HBase_1_1_2_ClientMapCacheService/index.html">HBase_1_1_2_ClientMapCacheService</a><br/><a href="../../../nifi-couchbase-nar/1.7.0/org.apache.nifi.couchbase.CouchbaseMapCacheClient/index.html">CouchbaseMapCacheClient</a></td><td id="description">The Controller Service that is used to ge
t the cached values.</td></tr><tr><td id="name"><strong>Character Encoding</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"><ul><li>ISO-8859-1</li><li>UTF-8</li><li>UTF-16</li><li>UTF-16LE</li><li>UTF-16BE</li><li>US-ASCII</li></ul></td><td id="description">Specifies a character encoding to use.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.PropertiesFileLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>PropertiesFileLookupService</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;">PropertiesFileLookupService</h1><h2>Description: </h2><p>A reloadable properties file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, properties, reloadable, key, value</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>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/additionalDetails.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1,65 @@
+<!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>RestLookupService</title>
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+</head>
+<body>
+ <h2>General</h2>
+ <p>This lookup service has the following optional lookup coordinate keys:</p>
+ <ul>
+ <li>request.method; defaults to 'get', valid values:
+ <ul>
+ <li>delete</li>
+ <li>get</li>
+ <li>post</li>
+ <li>put</li>
+ </ul>
+ </li>
+ <li>body; contains a string representing JSON, XML, etc. to be sent with any
+ of those methods except for "get".</li>
+ <li>mime.type; specifies media type of the request body, required when 'body' is passed.</li>
+ <li>*; any other keys can be configured to pass variables to resolve target URLs. See 'Dynamic URLs' section below.</li>
+ </ul>
+ <p>The record reader is used to consume the response of the REST service call and turn it into one or more records. The record path property
+ is provided to allow for a lookup path to either a nested record or a single point deep in the REST response. Note: a valid schema must be
+ built that encapsulates the REST response accurately in order for this service to work.</p>
+ <h2>Headers</h2>
+ <p>Headers are supported using dynamic properties. Just add a dynamic property and the name will be the header name and the value will be the value for the header. Expression language
+ powered by input from the variable registry is supported.</p>
+ <h2>Dynamic URLs</h2>
+ <p>The URL property supports expression language through the lookup key/value pairs configured on the component using this lookup service (e.g. LookupRecord processor). The configuration specified by the user will be passed
+ through to the expression language engine for evaluation. Note: flowfile attributes will be disregarded here for this property.</p>
+ <p>Ex. URL: <em>http://example.com/service/${user.name}/friend/${friend.id}</em>, combined with example record paths at LookupRecord processor:</p>
+ <ul>
+ <li>user.name => "/example/username"</li>
+ <li>friend.id => "/example/first_friend"</li>
+ </ul>
+ <p>Would dynamically produce an endpoint of <em>http://example.com/service/john.smith/friend/12345</em></p>
+
+ <h3>Using Variable Registry with URLs</h3>
+
+ <p>In addition to the lookup key/value pairs, Variable Registry can be referred from expression languages configured at the URL property.</p>
+ <p>Ex. URL: <em>http://${apiServerHostname}:${apiServerPort}/service/${user.name}/friend/${friend.id}</em>, combined with the previous example record paths, and variable registry:</p>
+ <ul>
+ <li>apiServerHostname => "test.example.com"</li>
+ <li>apiServerPort => "8080"</li>
+ </ul>
+ <p>Would dynamically produce an endpoint of <em>http://test.example.com:8080/service/john.smith/friend/12345</em></p>
+</body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.RestLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>RestLookupService</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;">RestLookupService</h1><h2>Description: </h2><p>Use a REST service to look up values.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>rest, lookup, json, xml, 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 t
hat its value will be encrypted. Before entering a value in a sensitive property, ensure that the <strong>nifi.properties</strong> file has an entry for the property <strong>nifi.sensitive.props.key</strong>.</p><table id="properties"><tr><th>Name</th><th>Default Value</th><th>Allowable Values</th><th>Description</th></tr><tr><td id="name"><strong>URL</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The URL for the REST endpoint. Expression language is evaluated against the lookup key/value pairs, not flowfile attributes.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></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-scripting-nar/1.7.0/org.apache.nifi.record.script.ScriptedReader/index.html">
ScriptedReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.grok.GrokReader/index.html">GrokReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.json.JsonPathReader/index.html">JsonPathReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.json.JsonTreeReader/index.html">JsonTreeReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.avro.AvroReader/index.html">AvroReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.xml.XMLReader/index.html">XMLReader</a><br/><a href="../../../nifi-record-serialization-services-nar/1.7.0/org.apache.nifi.csv.CSVReader/index.html">CSVReader</a></td><td id="description">The record reader to use for loading the payload and handling it as a record set.</td></tr><tr><td id="name">Record Path</td><td id="default-value"></td><td id="allowable-values"></td><td
id="description">An optional record path that can be used to define where in a record to get the real data to merge into the record set to be enriched. See documentation for examples of when this might be useful.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</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.7.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.7.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Proxy Configurati
on Service</td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>ProxyConfigurationService<br/><strong>Implementation: </strong><a href="../../../nifi-proxy-configuration-nar/1.7.0/org.apache.nifi.proxy.StandardProxyConfigurationService/index.html">StandardProxyConfigurationService</a></td><td id="description">Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN, SOCKS</td></tr><tr><td id="name">Basic Authentication Username</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The username to be used by the client to authenticate against the Remote URL. Cannot include control characters (0-31), ':', or DEL (127).<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Basic Authentication Password</td><td id
="default-value"></td><td id="allowable-values"></td><td id="description">The password to be used by the client to authenticate against the Remote URL.<br/><strong>Sensitive Property: true</strong><br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name">Use Digest Authentication</td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Whether to communicate with the website using Digest Authentication. 'Basic Authentication Username' and 'Basic Authentication Password' are used for authentication.</td></tr></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">*</td><td id="value">*</td><td>All dynamic properties are added as HTTP headers with the name as the header name
and the value as the header value.<br/><strong>Supports Expression Language: false</strong></td></tr></table></p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleCsvFileLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleCsvFileLookupService</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;">SimpleCsvFileLookupService</h1><h2>Description: </h2><p>A reloadable CSV file-based lookup service</p><h3>Tags: </h3><p>lookup, cache, enrich, join, csv, reloadable, key, value</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>A
llowable Values</th><th>Description</th></tr><tr><td id="name"><strong>CSV File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>CSV Format</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Excel</li><li>MySQL</li><li>TDF</li><li>InformixUnloadCsv</li><li>Default</li><li>RFC4180</li><li>InformixUnload</li></ul></td><td id="description">Specifies which "format" the CSV data is in, or specifies if custom formatting should be used.</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">The Character Encoding that is used to decode the CSV file.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="nam
e"><strong>Lookup Key Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup key column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Value Column</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Lookup value column.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Ignore Duplicates</strong></td><td id="default-value">true</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Ignore duplicate keys for records in the CSV file.</td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.SimpleKeyValueLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>SimpleKeyValueLookupService</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;">SimpleKeyValueLookupService</h1><h2>Description: </h2><p>Allows users to add key/value pairs as User-defined Properties. Each property that is added can be looked up by Property Name. The coordinates that are passed to the lookup must contain the key 'key'.</p><h3>Tags: </h3><p>lookup, enrich, key, value</p><h3>Properties: </h3><p>This component has no required or optional properties.</p><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.XMLFileLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.XMLFileLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.XMLFileLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.XMLFileLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>XMLFileLookupService</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;">XMLFileLookupService</h1><h2>Description: </h2><p>A reloadable XML file-based lookup service. This service uses Apache Commons Configuration. Example XML configuration file and how to access specific configuration can be found at http://commons.apache.org/proper/commons-configuration/userguide/howto_hierarchical.html</p><h3>Tags: </h3><p>lookup, cache, enrich, join, xml, reloadable, key, value</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>Configuration File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A configuration file<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/additionalDetails.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1,179 @@
+<!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>IPLookupService</title>
+
+ <link rel="stylesheet" href="../../../../../css/component-usage.css" type="text/css" />
+ </head>
+
+ <body>
+ <p>
+ The IPLookupService is powered by a MaxMind database and can return several different types of enrichment information
+ about a given IP address. Below is the schema of the Record that is returned by this service (in Avro Schema format).
+ The schema is for a single record that consists of several fields: <code>geo</code>, <code>isp</code>,
+ <code>domainName</code>, <code>connectionType</code>, and <code>anonymousIp</code>. Each of these fields is nullable
+ and will be populated only if the IP address that is searched for has the relevant information in the MaxMind database
+ and if the Controller Service is configured to return such information. Because each of the fields requires a separate
+ lookup in the database, it is advisable to retrieve only those fields that are of value.
+ </p>
+
+<code>
+<pre>
+{
+ "name": "enrichmentRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ {
+ "name": "geo",
+ "type": ["null", {
+ "name": "cityGeo",
+ "type": "record",
+ "fields": [
+ { "name": "city", "type": ["null", "string"] },
+ { "name": "accuracy", "type": ["null", "int"], "doc": "The radius, in kilometers, around the given location, where the IP address is believed to be" },
+ { "name": "metroCode", "type": ["null", "int"] },
+ { "name": "timeZone", "type": ["null", "string"] },
+ { "name": "latitude", "type": ["null", "double"] },
+ { "name": "longitude", "type": ["null", "double"] },
+ { "name": "country", "type": ["null", {
+ "type": "record",
+ "name": "country",
+ "fields": [
+ { "name": "name", "type": "string" },
+ { "name": "isoCode", "type": "string" }
+ ]
+ }] },
+ { "name": "subdivisions", "type": {
+ "type": "array",
+ "items": {
+ "type": "record",
+ "name": "subdivision",
+ "fields": [
+ { "name": "name", "type": "string" },
+ { "name": "isoCode", "type": "string" }
+ ]
+ }
+ }
+ },
+ { "name": "continent", "type": ["null", "string"] },
+ { "name": "postalCode", "type": ["null", "string"] }
+ ]
+ }]
+ },
+ {
+ "name": "isp",
+ "type": ["null", {
+ "name": "ispEnrich",
+ "type": "record",
+ "fields": [
+ { "name": "name", "type": ["null", "string"] },
+ { "name": "organization", "type": ["null", "string"] },
+ { "name": "asn", "type": ["null", "int"] },
+ { "name": "asnOrganization", "type": ["null", "string"] }
+ ]
+ }]
+ },
+ {
+ "name": "domainName",
+ "type": ["null", "string"]
+ },
+ {
+ "name": "connectionType",
+ "type": ["null", "string"],
+ "doc": "One of 'Dialup', 'Cable/DSL', 'Corporate', 'Cellular'"
+ },
+ {
+ "name": "anonymousIp",
+ "type": ["null", {
+ "name": "anonymousIpType",
+ "type": "record",
+ "fields": [
+ { "name": "anonymous", "type": "boolean" },
+ { "name": "anonymousVpn", "type": "boolean" },
+ { "name": "hostingProvider", "type": "boolean" },
+ { "name": "publicProxy", "type": "boolean" },
+ { "name": "torExitNode", "type": "boolean" }
+ ]
+ }]
+ }
+ ]
+}
+</pre>
+</code>
+
+
+ <p>
+ While this schema is fairly complex, it is a single record with 5 fields. This makes it quite easy to update
+ an existing schema to allow for this record, by adding a new field to an existing schema and pasting in the schema
+ above as the type.
+ </p>
+
+ <p>
+ For example, suppose that we have an existing schema that is as simple as:
+ </p>
+
+<pre>
+<code>
+<span style="color: #808080;">
+{
+ "name": "ipRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ { "name": "ip", "type": "string" }
+ ]
+}
+</span>
+</code>
+</pre>
+
+ <p>
+ Now, let's suppose that we want to add a new field named <code>enrichment</code> to the above schema.
+ Further, let's say that we want the new <code>enrichment</code> field to be nullable.
+ We can do so by copying and pasting our enrichment schema from above thus:
+ </p>
+
+<pre>
+<code>
+<span style="color: #808080;">
+{
+ "name": "ipRecord",
+ "namespace": "nifi",
+ "type": "record",
+ "fields": [
+ { "name": "ip", "type": "string" },</span><span style="color: #191970;">
+ { "name": "enrichment", "type": ["null",
+</span>
+
+ <span style="color: #000000"><Paste Enrichment Schema Here></span>
+
+<span style="color: #191970;">
+ ]</span><span style="color: #808080;">
+ }
+ ]
+}
+</span>
+</code>
+</pre>
+
+
+
+
+ </body>
+</html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lookup-services-nar/1.7.0/org.apache.nifi.lookup.maxmind.IPLookupService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>IPLookupService</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;">IPLookupService</h1><h2>Description: </h2><p>A lookup service that provides several types of enrichment information for IP addresses. The service is configured by providing a MaxMind Database file and specifying which types of enrichment should be provided for an IP Address or Hostname. Each type of enrichment is a separate lookup, so configuring the service to provide all of the available enrichment data may be slower than returning only a portion of the available enrichments. In order to use this service, a lookup must be performed using key of 'ip' and a value that is a valid IP address or ho
stname. View the Usage of this component and choose to view Additional Details for more information, such as the Schema that pertains to the information that is returned.</p><p><a href="additionalDetails.html">Additional Details...</a></p><h3>Tags: </h3><p>lookup, enrich, ip, geo, ipgeo, maxmind, isp, domain, cellular, anonymous, tor</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>MaxMind Database File</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Path to Maxmind IP Enrichment Database File<br/><strong>Suppo
rts Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Lookup Geo Enrichment</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 whether or not information about the geographic information, such as cities, corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup ISP</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Information Service Provider corresponding to the IP address should be returned</td></tr><tr><td id="name"><strong>Lookup Domain Name</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Domain Name corresponding to the IP add
ress should be returned. If true, the lookup will contain second-level domain information, such as foo.com but will not contain bar.foo.com</td></tr><tr><td id="name"><strong>Lookup Connection Type</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about the Connection Type corresponding to the IP address should be returned. If true, the lookup will contain a 'connectionType' field that (if populated) will contain a value of 'Dialup', 'Cable/DSL', 'Corporate', or 'Cellular'</td></tr><tr><td id="name"><strong>Lookup Anonymous IP Information</strong></td><td id="default-value">false</td><td id="allowable-values"><ul><li>true</li><li>false</li></ul></td><td id="description">Specifies whether or not information about whether or not the IP address belongs to an anonymous network should be returned.</td></tr></table><h3>State management: </h3>This component does not stor
e state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.7.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.7.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.7.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-lumberjack-nar/1.7.0/org.apache.nifi.processors.lumberjack.ListenLumberjack/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ListenLumberjack</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;">ListenLumberjack</h1><h2>Description: </h2><p>This processor is deprecated and may be removed in the near future. Listens for Lumberjack messages being sent to a given port over TCP. Each message will be acknowledged after successfully writing the message to a FlowFile. Each FlowFile will contain data portion of one or more Lumberjack frames. In the case where the Lumberjack frames contain syslog messages, the output of this processor can be sent to a ParseSyslog processor for further processing. </p><h3>Tags: </h3><p>listen, lumberjack, tcp, logs</p><h3>Properties: </h3><p>In the list below, t
he 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">Local Network Interface</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of a local network interface to be used to restrict listening to a specific LAN.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port to listen on for communication.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry
only)</strong></td></tr><tr><td id="name"><strong>Receive Buffer Size</strong></td><td id="default-value">65507 B</td><td id="allowable-values"></td><td id="description">The size of each buffer used to receive messages. Adjust this value appropriately based on the expected size of the incoming messages.</td></tr><tr><td id="name"><strong>Max Size of Message Queue</strong></td><td id="default-value">10000</td><td id="allowable-values"></td><td id="description">The maximum size of the internal queue used to buffer messages being transferred from the underlying channel to the processor. Setting this value higher allows more messages to be buffered in memory during surges of incoming messages, but increases the total memory used by the processor.</td></tr><tr><td id="name"><strong>Max Size of Socket Buffer</strong></td><td id="default-value">1 MB</td><td id="allowable-values"></td><td id="description">The maximum size of the socket buffer that should be used. This is a suggestion to the
Operating System to indicate how big the socket buffer should be. If this value is set too low, the buffer may fill up before the data can be read, and incoming data will be dropped.</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 received data.</td></tr><tr><td id="name"><strong>Max Batch Size</strong></td><td id="default-value">1</td><td id="allowable-values"></td><td id="description">The maximum number of messages to add to a single FlowFile. If multiple messages are available, they will be concatenated along with the <Message Delimiter> up to this configured maximum number of messages</td></tr><tr><td id="name"><strong>Batching Message Delimiter</strong></td><td id="default-value">\n</td><td id="allowable-values"></td><td id="description">Specifies the delimiter to place between messages when multiple messages are bundled together (see <
Max Batch Size> property).</td></tr><tr><td id="name"><strong>Max Number of TCP Connections</strong></td><td id="default-value">2</td><td id="allowable-values"></td><td id="description">The maximum number of concurrent TCP connections to accept.</td></tr><tr><td id="name"><strong>SSL Context Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>RestrictedSSLContextService<br/><strong>Implementation: </strong><a href="../../../nifi-ssl-context-service-nar/1.7.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</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. Note that as Lumberjack client requirestwo-way SSL authentication, the controller MUST have a truststore and a keystore to workproperly.</td></tr></table><h3>Relationships: </h3><table id
="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>success</td><td>Messages received successfully will be sent out 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>lumberjack.sender</td><td>The sending host of the messages.</td></tr><tr><td>lumberjack.port</td><td>The sending port the messages were received over.</td></tr><tr><td>lumberjack.sequencenumber</td><td>The sequence number of the message. Only included if <Batch Size> is 1.</td></tr><tr><td>lumberjack.*</td><td>The keys and respective values as sent by the lumberjack producer. Only included if <Batch Size> is 1.</td></tr><tr><td>mime.type</td><td>The mime.type of the content which is text/plain</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 co
mponent does not allow an incoming relationship.<h3>System Resource Considerations:</h3>None specified.<h3>See Also:</h3><p><a href="../../../nifi-standard-nar/1.7.0/org.apache.nifi.processors.standard.ParseSyslog/index.html">ParseSyslog</a></p></body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ExtractImageMetadata/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ExtractImageMetadata/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ExtractImageMetadata/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ExtractImageMetadata/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractImageMetadata</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;">ExtractImageMetadata</h1><h2>Description: </h2><p>Extract the image metadata from flowfiles containing images. This processor relies on this metadata extractor library https://github.com/drewnoakes/metadata-extractor. It extracts a long list of metadata types including but not limited to EXIF, IPTC, XMP and Photoshop fields. For the full list visit the library's website.NOTE: The library being used loads the images into memory so extremely large images may cause problems.</p><h3>Tags: </h3><p>Exif, Exchangeable, image, file, format, JPG, GIF, PNG, BMP, metadata, IPTC, XMP</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">Max Number of Attributes</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Specify the max number of attributes to add to the flowfile. There is no guarantee in what order the tags will be processed. By default it will process all of them.</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 successfully has image metadata extracted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that fails to have image metadata extracted will be routed to failure</td></tr></table><h3>Reads Attributes: </h3>None specifi
ed.<h3>Writes Attributes: </h3><table id="writes-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td><directory name>.<tag name></td><td>The extracted image metadata will be inserted with the attribute name "<directory name>.<tag name>". </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>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ResizeImage/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ResizeImage/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ResizeImage/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.image.ResizeImage/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ResizeImage</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;">ResizeImage</h1><h2>Description: </h2><p>Resizes an image to user-specified dimensions. This Processor uses the image codecs registered with the environment that NiFi is running in. By default, this includes JPEG, PNG, BMP, WBMP, and GIF images.</p><h3>Tags: </h3><p>resize, image, jpg, jpeg, png, bmp, wbmp, gif</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>Image Width (in pixels)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The desired number of pixels for the image's width<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Image Height (in pixels)</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The desired number of pixels for the image's height<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Scaling Algorithm</strong></td><td id="default-value">Default</td><td id="allowable-values"><ul><li>Default <img src="../../../../../html/images/ic
onInfo.png" alt="Use the default algorithm" title="Use the default algorithm"></img></li><li>Scale Fast <img src="../../../../../html/images/iconInfo.png" alt="Emphasize speed of the scaling over smoothness" title="Emphasize speed of the scaling over smoothness"></img></li><li>Scale Smooth <img src="../../../../../html/images/iconInfo.png" alt="Emphasize smoothness of the scaling over speed" title="Emphasize smoothness of the scaling over speed"></img></li><li>Replicate Scale Filter <img src="../../../../../html/images/iconInfo.png" alt="Use the Replicate Scale Filter algorithm" title="Use the Replicate Scale Filter algorithm"></img></li><li>Area Averaging <img src="../../../../../html/images/iconInfo.png" alt="Use the Area Averaging scaling algorithm" title="Use the Area Averaging scaling algorithm"></img></li></ul></td><td id="description">Specifies which algorithm should be used to resize the image</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</t
h><th>Description</th></tr><tr><td>success</td><td>A FlowFile is routed to this relationship if it is successfully resized</td></tr><tr><td>failure</td><td>A FlowFile is routed to this relationship if it is not in the specified format</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>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-media-nar/1.7.0/org.apache.nifi.processors.media.ExtractMediaMetadata/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>ExtractMediaMetadata</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;">ExtractMediaMetadata</h1><h2>Description: </h2><p>Extract the content metadata from flowfiles containing audio, video, image, and other file types. This processor relies on the Apache Tika project for file format detection and parsing. It extracts a long list of metadata types for media files including audio, video, and print media formats.NOTE: the attribute names and content extracted may vary across upgrades because parsing is performed by the external Tika tools which in turn depend on other projects for metadata extraction. For the more details and the list of supported file types,
visit the library's website at http://tika.apache.org/.</p><h3>Tags: </h3><p>media, file, format, metadata, audio, video, image, document, pdf</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">Max Number of Attributes</td><td id="default-value">100</td><td id="allowable-values"></td><td id="description">Specify the max number of attributes to add to the flowfile. There is no guarantee in what order the tags will be processed. By default it will process all of them.</td></tr><tr><td id="name"><strong>Max Attribute Length</strong></td><td id="default-value">100</td>
<td id="allowable-values"></td><td id="description">Specifies the maximum length of a single attribute value. When a metadata item has multiple values, they will be merged until this length is reached and then ", ..." will be added as an indicator that additional values where dropped. If a single value is longer than this, it will be truncated and "(truncated)" appended to indicate that truncation occurred.</td></tr><tr><td id="name">Metadata Key Filter</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">A regular expression identifying which metadata keys received from the parser should be added to the flowfile attributes. If left blank, all metadata keys parsed will be added to the flowfile attributes.</td></tr><tr><td id="name">Metadata Key Prefix</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">Text to be prefixed to metadata keys as the are added to the flowfile attributes. It is recommended to end with with
a separator character like '.' or '-', this is not automatically added by the processor.<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></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 successfully has media metadata extracted will be routed to success</td></tr><tr><td>failure</td><td>Any FlowFile that fails to have media metadata extracted will be 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><Metadata Key Prefix><attribute></td><td>The extracted content metadata will be inserted with the attribute name "<Metadata Key Prefix><attribute>", or "<attribute>" if "Metadata Key Prefix" is not provided.</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>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>GraphiteMetricReporterService</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;">GraphiteMetricReporterService</h1><h2>Description: </h2><p>A controller service that provides metric reporters for graphite. Used by MetricsReportingTask.</p><h3>Tags: </h3><p>metrics, reporting, graphite</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>Host</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The hostname of the carbon listener<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Port</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The port on which carbon listens<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Charset</strong></td><td id="default-value">UTF-8</td><td id="allowable-values"></td><td id="description">The charset used by the graphite server</td></tr><tr><td id="name"><strong>Metric Name Prefix</strong></td><td id="default-value">nifi</td><td id="allowable-values"></td><td id="description">A prefix that will be used for all metric names sent
by reporters provided by this service.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr></table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-metrics-reporting-nar/1.7.0/org.apache.nifi.metrics.reporting.task.MetricsReportingTask/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>MetricsReportingTask</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;">MetricsReportingTask</h1><h2>Description: </h2><p>This reporting task reports a set of metrics regarding the JVM and the NiFi instanceto a reporter. The reporter is provided by a MetricReporterService. It can be optionally used for a specificprocess group if a property with the group id is provided.</p><h3>Tags: </h3><p>metrics, reporting</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>Metric Reporter Service</strong></td><td id="default-value"></td><td id="allowable-values"><strong>Controller Service API: </strong><br/>MetricReporterService<br/><strong>Implementation: </strong><a href="../org.apache.nifi.metrics.reporting.reporter.service.GraphiteMetricReporterService/index.html">GraphiteMetricReporterService</a></td><td id="description">The service that provides a reporter for the gathered metrics</td></tr><tr><td id="name">Process Group ID</td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The id of the process group to report. If not specified, metrics of the root process groupare reported.<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr>
</table><h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file
Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.7.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html
URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.7.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html?rev=1834461&view=auto
==============================================================================
--- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.7.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html (added)
+++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-mongodb-nar/1.7.0/org.apache.nifi.processors.mongodb.DeleteMongo/index.html Wed Jun 27 00:37:46 2018
@@ -0,0 +1 @@
+<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"></meta><title>DeleteMongo</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;">DeleteMongo</h1><h2>Description: </h2><p>Executes a delete query against a MongoDB collection. The query is provided in the body of the flowfile and the user can select whether it will delete one or many documents that match it.</p><h3>Tags: </h3><p>delete, mongo, mongodb</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 Lan
guage</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>Mongo URI</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">MongoURI, typically of the form: mongodb://host1[:port1][,host2[:port2],...]<br/><strong>Supports Expression Language: true (will be evaluated using variable registry only)</strong></td></tr><tr><td id="name"><strong>Mongo Database Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the database to use<br/><strong>Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)</strong></td></tr><tr><td id="name"><strong>Mongo Collection Name</strong></td><td id="default-value"></td><td id="allowable-values"></td><td id="description">The name of the collection to use<br/><strong>Supports Expression Language: true (will be evaluated using
flow file attributes and variable registry)</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.7.0/org.apache.nifi.ssl.StandardRestrictedSSLContextService/index.html">StandardRestrictedSSLContextService</a><br/><a href="../../../nifi-ssl-context-service-nar/1.7.0/org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a></td><td id="description">The SSL Context Service used to provide client certificate information for TLS/SSL connections.</td></tr><tr><td id="name">Client Auth</td><td id="default-value">REQUIRED</td><td id="allowable-values"><ul><li>WANT</li><li>REQUIRED</li><li>NONE</li></ul></td><td id="description">Client authentication policy when connecting to secure (TLS/SSL) cluster. Possible values are REQUIRED, WANT, NONE. This prope
rty is only used when an SSL Context has been defined and enabled.</td></tr><tr><td id="name">Delete Mode</td><td id="default-value">one</td><td id="allowable-values"><ul><li>Delete One <img src="../../../../../html/images/iconInfo.png" alt="Delete only the first document that matches the query." title="Delete only the first document that matches the query."></img></li><li>Delete Many <img src="../../../../../html/images/iconInfo.png" alt="Delete every document that matches the query." title="Delete every document that matches the query."></img></li><li>Use 'mongodb.delete.mode' attribute <img src="../../../../../html/images/iconInfo.png" alt="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'" title="Read the 'mongodb.delete.mode attribute and use that mode. Acceptable values are 'many' and 'one.'"></img></li></ul></td><td id="description">Choose between deleting one document by query or many documents by query.</td></tr><tr><td id="n
ame">Fail When Nothing Is Deleted</td><td id="default-value">true</td><td id="allowable-values"><ul><li>True <img src="../../../../../html/images/iconInfo.png" alt="Fail when no documents are deleted." title="Fail when no documents are deleted."></img></li><li>False <img src="../../../../../html/images/iconInfo.png" alt="Do not fail when nothing is deleted." title="Do not fail when nothing is deleted."></img></li></ul></td><td id="description">Determines whether to send the flowfile to the success or failure relationship if nothing is successfully deleted.</td></tr><tr><td id="name"><strong>Write Concern</strong></td><td id="default-value">ACKNOWLEDGED</td><td id="allowable-values"><ul><li>ACKNOWLEDGED</li><li>UNACKNOWLEDGED</li><li>FSYNCED</li><li>JOURNALED</li><li>REPLICA_ACKNOWLEDGED</li><li>MAJORITY</li></ul></td><td id="description">The write concern to use</td></tr></table><h3>Relationships: </h3><table id="relationships"><tr><th>Name</th><th>Description</th></tr><tr><td>succe
ss</td><td>All FlowFiles that are written to MongoDB are routed to this relationship</td></tr><tr><td>failure</td><td>All FlowFiles that cannot be written to MongoDB are routed to this relationship</td></tr></table><h3>Reads Attributes: </h3><table id="reads-attributes"><tr><th>Name</th><th>Description</th></tr><tr><td>mongodb.delete.mode</td><td>Configurable parameter for controlling delete mode on a per-flowfile basis. The process must be configured to use this option. Acceptable values are 'one' and 'many.'</td></tr></table><h3>Writes Attributes: </h3>None specified.<h3>State management: </h3>This component does not store state.<h3>Restricted: </h3>This component is not restricted.<h3>Input requirement: </h3>This component requires an incoming relationship.<h3>System Resource Considerations:</h3>None specified.</body></html>
\ No newline at end of file