http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html deleted file mode 100644 index 82f9614..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateJsonPath/index.html +++ /dev/null @@ -1,155 +0,0 @@ -<!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>EvaluateJsonPath</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css"/> -</head> - -<body> -<!-- Processor Documentation ================================================== --> -<h2>Description:</h2> - -<p> - Evaluates one or more JsonPath expressions against the content of a FlowFile. The results of those expressions are - assigned to FlowFile Attributes or are written to the content of the FlowFile itself, depending on configuration of - the Processor. JsonPaths are entered by adding user-defined properties; the name of the property maps to the - Attribute Name into which the result will be placed (if the Destination is flowfile-attribute; otherwise, the - property name is ignored). The value of the property must be a valid JsonPath expression. If the JsonPath evaluates - to a JSON array or JSON object and the Return Type is set to 'scalar' the FlowFile will be unmodified and will be - routed to failure. A Return Type of JSON can return scalar values if the provided JsonPath evaluates to the - specified value and will be routed as a match. If Destination is 'flowfile-content' and the JsonPath does not - evaluate to a defined path, the FlowFile will be routed to 'unmatched' without having its contents modified. If - Destination is flowfile-attribute and the expression matches nothing, attributes will be created with empty - strings as the value, and the FlowFile will always be routed to 'matched.' -</p> - -<p> - <strong>Note:</strong> The underlying JsonPath library loads the entirety of the streamed content into and performs - result evaluations in memory. Accordingly, it is important to consider the anticipated profile of content being - evaluated by this processor and the hardware supporting it especially when working against large JSON documents. -</p> - -<p> - <strong>Properties:</strong> -</p> - -<p> - In the list below, the names of required properties appear in bold. - Any other properties (not in bold) are considered optional. If a - property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated. -</p> - -<p> - <strong>Modifies Attributes:</strong> -</p> - -<p> - This processor adds user-defined attributes if the <Destination> property is set to - <code>flowfile-attribute</code>. -</p> - - -<ul> - <li> - <strong>Destination</strong> - <ul> - <li>Indicates whether the results of the JsonPath evaluation are - written to the FlowFile content or a FlowFile attribute; if using - attribute, the attribute's name must be specified in the value of - the Attribute Name property. - </li> - <li> - Valid values are: - <ul> - <li>flowfile-content</li> - <li>flowfile-attribute</li> - </ul> - </li> - <li>Default value: flowfile-content</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Return Type</strong> - <ul> - <li>Indicates the desired return type of the JsonPath expressions. - Selecting 'auto-detect' will set the return type to 'json' for a - Destination of 'flowfile-content', and 'scalar' for a Destination of - 'flowfile-attribute'.") - </li> - <li> - Valid values are: - <ul> - <li>auto-detect</li> - <li>json</li> - <li>scalar</li> - </ul> - </li> - <li>Default value: auto-detect</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - user-defined properties - <ul> - <li>The name of the attribute to put the JsonPath result into if - flowfile-attribute is used as the value for the Destination - property; if using flowfile-content as the value for the - Destination property, this value is ignored. - </li> - <li>Supports expression language: false</li> - </ul> - </li> -</ul> - -<p> - <strong>Relationships:</strong> -</p> -<ul> - <li> - failure - <ul> - <li>If the JsonPath cannot be evaluated against the content of the - FlowFile, then the FlowFile follows this relationship. For - example, if the FlowFile does not contain valid JSON. - </li> - </ul> - </li> - <li> - matched - <ul> - <li>If the JsonPath is successfully evaluated and the FlowFile is - modified as a result, then the FlowFile follows this - relationship. - </li> - </ul> - </li> - <li> - unmatched - <ul> - <li>If the JsonPath does not match the content of the FlowFile, then - the FlowFile follows this relationship. - </li> - </ul> - </li> -</ul> -</p> -</body> -</html>
http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html index 3d120a4..ae9e6ff 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.EvaluateXQuery/additionalDetails.html @@ -1,55 +1,55 @@ <!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. + <!-- + 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>EvaluateXQuery</title> -<link rel="stylesheet" href="../../css/component-usage.css" - type="text/css" /> -</head> + <head> + <meta charset="utf-8" /> + <title>EvaluateXQuery</title> + <link rel="stylesheet" href="../../css/component-usage.css" + type="text/css" /> + </head> -<body> + <body> - <!-- Processor Documentation ================================================== --> + <!-- Processor Documentation ================================================== --> - <p> - <strong>Modifies Attributes:</strong> - </p> + <p> + <strong>Modifies Attributes:</strong> + </p> - <p> - This processor adds user-defined attributes if the <Destination> - property is set to - <code>flowfile-attribute</code> - . - </p> + <p> + This processor adds user-defined attributes if the <Destination> + property is set to + <code>flowfile-attribute</code> + . + </p> - <p> - <strong>Examples:</strong> - </p> + <p> + <strong>Examples:</strong> + </p> - <p>This processor produces one attribute or FlowFile per - XQueryResult. If only one attribute or FlowFile is desired, the - following examples demonstrate how this can be achieved using the - XQuery language. The examples below reference the following sample - XML:</p> + <p>This processor produces one attribute or FlowFile per + XQueryResult. If only one attribute or FlowFile is desired, the + following examples demonstrate how this can be achieved using the + XQuery language. The examples below reference the following sample + XML:</p> - <pre> + <pre> <code> <?xml version="1.0" encoding="UTF-8"?> <?xml-stylesheet type="text/xsl" href="foo.xsl"?> @@ -85,77 +85,77 @@ </fruit> </ns:fruitbasket> </code> - </pre> + </pre> - <p> - <ul> - <li>XQuery to return all "fruit" nodes individually (7 Results): - <ul> - <li>//fruit</li> - </ul> - </li> - <li>XQuery to return only the first "fruit" node (1 Result): - <ul> - <li>//fruit[1]</li> - </ul> - </li> - <li>XQuery to return only the last "fruit" node (1 Result): - <ul> - <li>//fruit[count(//fruit)]</li> - </ul> - </li> - <li>XQuery to return all "fruit" nodes, wrapped in a "basket" tag - (1 Result): - <ul> - <li><basket>{//fruit}</basket></li> - </ul> - </li> - <li>XQuery to return all "fruit" names individually (7 Results): - <ul> - <li>//fruit/text()</li> - </ul> - </li> - <li>XQuery to return only the first "fruit" name (1 Result): - <ul> - <li>//fruit[1]/text()</li> - </ul> - </li> - <li>XQuery to return only the last "fruit" name (1 Result): - <ul> - <li>//fruit[count(//fruit)]/text()</li> - </ul> - </li> - <li>XQuery to return all "fruit" names as a comma separated list - (1 Result): - <ul> - <li>string-join((for $x in //fruit return $x/name/text()), ', - ')</li> - </ul> - </li> - <li>XQuery to return all "fruit" colors and names as a comma - separated list (1 Result): - <ul> - <li>string-join((for $y in (for $x in //fruit return - string-join(($x/color/text() , $x/name/text()), ' ')) return $y), - ', ')</li> - </ul> - </li> - <li>XQuery to return all "fruit" colors and names as a comma - separated list (1 Result): - <ul> - <li>string-join((for $y in (for $x in //fruit return - string-join(($x/color/text() , $x/name/text()), ' ')) return $y), - ', ')</li> - </ul> - </li> - <li>XQuery to return all "fruit" colors and names as a new line - separated list (1 Result): - <ul> - <li>string-join((for $y in (for $x in //fruit return - string-join(($x/color/text() , $x/name/text()), ' ')) return $y), - '\n')</li> - </ul> - </li> - </ul> -</body> + <p> + <ul> + <li>XQuery to return all "fruit" nodes individually (7 Results): + <ul> + <li>//fruit</li> + </ul> + </li> + <li>XQuery to return only the first "fruit" node (1 Result): + <ul> + <li>//fruit[1]</li> + </ul> + </li> + <li>XQuery to return only the last "fruit" node (1 Result): + <ul> + <li>//fruit[count(//fruit)]</li> + </ul> + </li> + <li>XQuery to return all "fruit" nodes, wrapped in a "basket" tag + (1 Result): + <ul> + <li><basket>{//fruit}</basket></li> + </ul> + </li> + <li>XQuery to return all "fruit" names individually (7 Results): + <ul> + <li>//fruit/text()</li> + </ul> + </li> + <li>XQuery to return only the first "fruit" name (1 Result): + <ul> + <li>//fruit[1]/text()</li> + </ul> + </li> + <li>XQuery to return only the last "fruit" name (1 Result): + <ul> + <li>//fruit[count(//fruit)]/text()</li> + </ul> + </li> + <li>XQuery to return all "fruit" names as a comma separated list + (1 Result): + <ul> + <li>string-join((for $x in //fruit return $x/name/text()), ', + ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a comma + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + ', ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a comma + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + ', ')</li> + </ul> + </li> + <li>XQuery to return all "fruit" colors and names as a new line + separated list (1 Result): + <ul> + <li>string-join((for $y in (for $x in //fruit return + string-join(($x/color/text() , $x/name/text()), ' ')) return $y), + '\n')</li> + </ul> + </li> + </ul> + </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteProcess/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteProcess/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteProcess/index.html deleted file mode 100644 index 3526cd1..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ExecuteProcess/index.html +++ /dev/null @@ -1,100 +0,0 @@ -<!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>ExecuteProcess</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2> Description:</h2> - <p> - Runs an operating system command specified by the user and writes the output of that command to a FlowFile. If the command is expected - to be long-running, the Processor can output the partial data on a specified interval. When this option is used, the output is expected to be in textual - format, as it typically does not make sense to split binary data on arbitrary time-based intervals. - </p> - - <p> - <strong>Properties:</strong> - </p> - <p>In the list below, the names of required properties appear - in bold. Any other properties (not in bold) are considered optional. - If a property has a default value, it is indicated. If a property - supports the use of the NiFi Expression Language (or simply, - "expression language"), that is also indicated.</p> - <ul> - <li><strong>Command</strong> - <ul> - <li>Specifies the command to be executed; if just the name of an executable is provided, it must be in the user's environment PATH.</li> - <li>Default value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Command Arguments - <ul> - <li>The arguments to supply to the executable delimited by white space. White space can be escaped by enclosing it in double-quotes.</li> - <li>Default value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Working Directory - <ul> - <li>The directory to use as the current working directory when executing the command</li> - <li>Default value: none (which means whatever NiFi's root installation directory is)</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Batch Duration - <ul> - <li> - If the process is expected to be long-running and produce textual output, a batch duration can be specified so - that the output will be captured for this amount of time and a FlowFile will then be sent out with the results - and a new FlowFile will be started, rather than waiting for the process to finish before sending out the results. - If no value is provided, the process will run to completion and the entire output of the process will be written - to a single FlowFile. - </li> - <li>Default value: none</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Redirect Error Stream - <ul> - <li> - If true will redirect any error stream output of the process to the output stream. - This is particularly helpful for processes which write extensively to the error stream or for troubleshooting. - </li> - <li>Default value: false</li> - <li>Allowed Values: true, false</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>All FlowFiles that are created are routed to this relationship.</li> - </ul> - </li> - </ul> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html new file mode 100644 index 0000000..17378fb --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/additionalDetails.html @@ -0,0 +1,127 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>HandleHttpRequest</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <h2>Usage Description</h2> + <p> + The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> Processor + provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available + through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a + flow such as: + </p> + + <p> + <a href="index.html">HandleHttpRequest</a> -> + <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> + <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> + </p> + + <p> + The HandleHttpRequest Processor provides several Properties to configure which methods are supported, the paths that are + supported, and SSL configuration. The FlowFiles that are generated by this Processor have the following attributes added to + them, providing powerful routing capabilities and traceability of all data: + </p> + + <table> + <thead> + <tr> + <th>Attribute Name</th> + <th>Attribute Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>http.context.identifier</td> + <td>An identifier that allows the HandleHttpRequest and HandleHttpResponse to coordinate which FlowFile belongs + to which HTTP Request/Response.</td> + </tr> + <tr> + <td>mime.type</td> + <td>The MIME Type of the data, according to the HTTP Header "Content-Type"</td> + </tr> + <tr> + <td>http.servlet.path</td> + <td>The part of the request URL that is considered the Servlet Path</td> + </tr> + <tr> + <td>http.context.path</td> + <td>The part of the request URL that is considered to be the Context Path</td> + </tr> + <tr> + <td>http.method</td> + <td>The HTTP Method that was used for the request, such as GET or POST</td> + </tr> + <tr> + <td>http.query.string</td> + <td>The query string portion of hte Request URL</td> + </tr> + <tr> + <td>http.remote.host</td> + <td>The hostname of the requestor</td> + </tr> + <tr> + <td>http.remote.addr</td> + <td>The hostname:port combination of the requestor</td> + </tr> + <tr> + <td>http.remote.user</td> + <td>The username of the requestor</td> + </tr> + <tr> + <td>http.request.uri</td> + <td>The full Request URL</td> + </tr> + <tr> + <td>http.auth.type</td> + <td>The type of HTTP Authorization used</td> + </tr> + <tr> + <td>http.principal.name</td> + <td>The name of the authenticated user making the request</td> + </tr> + <tr> + <td>http.subject.dn</td> + <td>The Distinguished Name of the requestor. This value will not be populated unless the Processor is + configured to use an SSLContext Service</td> + </tr> + <tr> + <td>http.issuer.dn</td> + <td>The Distinguished Name of the entity that issued the Subject's certificate. This value will not be + populated unless the Processor is configured to use an SSLContext Service</td> + </tr> + <tr> + <td>http.headers.XXX</td> + <td>Each of the HTTP Headers that is received in the request will be added as an attribute, prefixed + with "http.headers." For example, if the request contains an HTTP Header named "x-my-header", + then the value will be added to an attribute named "http.headers.x-my-header"</td> + </tr> + </tbody> + </table> + <p> + <strong>See Also:</strong><br /> + <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a><br /> + <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a><br /> + <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br /> + </p> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/index.html deleted file mode 100644 index d3da666..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpRequest/index.html +++ /dev/null @@ -1,255 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>HandleHttpRequest</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor starts an HTTP server and creates a FlowFile for each HTTP Request that it receives. The Processor leaves - the HTTP Connection open and is intended to be used in conjunction with a - <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> Processor. - </p> - - <p> - The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> Processor - provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available - through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a - flow such as: - </p> - - <p> - <a href="index.html">HandleHttpRequest</a> -> - <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> - <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a> - </p> - - <p> - The HandleHttpRequest Processor provides several Properties to configure which methods are supported, the paths that are - supported, and SSL configuration. The FlowFiles that are generated by this Processor have the following attributes added to - them, providing powerful routing capabilities and traceability of all data: - </p> - - <table> - <thead> - <th>Attribute Name</th> - <th>Attribute Description</th> - </thead> - <tbody> - <tr> - <td>http.context.identifier</td> - <td>An identifier that allows the HandleHttpRequest and HandleHttpResponse to coordinate which FlowFile belongs - to which HTTP Request/Response.</td> - </tr> - <tr> - <td>mime.type</td> - <td>The MIME Type of the data, according to the HTTP Header "Content-Type"</td> - </tr> - <tr> - <td>http.servlet.path</td> - <td>The part of the request URL that is considered the Servlet Path</td> - </tr> - <tr> - <td>http.context.path</td> - <td>The part of the request URL that is considered to be the Context Path</td> - </tr> - <tr> - <td>http.method</td> - <td>The HTTP Method that was used for the request, such as GET or POST</td> - </tr> - <tr> - <td>http.query.string</td> - <td>The query string portion of hte Request URL</td> - </tr> - <tr> - <td>http.remote.host</td> - <td>The hostname of the requestor</td> - </tr> - <tr> - <td>http.remote.addr</td> - <td>The hostname:port combination of the requestor</td> - </tr> - <tr> - <td>http.remote.user</td> - <td>The username of the requestor</td> - </tr> - <tr> - <td>http.request.uri</td> - <td>The full Request URL</td> - </tr> - <tr> - <td>http.auth.type</td> - <td>The type of HTTP Authorization used</td> - </tr> - <tr> - <td>http.principal.name</td> - <td>The name of the authenticated user making the request</td> - </tr> - <tr> - <td>http.subject.dn</td> - <td>The Distinguished Name of the requestor. This value will not be populated unless the Processor is - configured to use an SSLContext Service</td> - </tr> - <tr> - <td>http.issuer.dn</td> - <td>The Distinguished Name of the entity that issued the Subject's certificate. This value will not be - populated unless the Processor is configured to use an SSLContext Service</td> - </tr> - <tr> - <td>http.headers.XXX</td> - <td>Each of the HTTP Headers that is received in the request will be added as an attribute, prefixed - with "http.headers." For example, if the request contains an HTTP Header named "x-my-header", - then the value will be added to an attribute named "http.headers.x-my-header"</td> - </tr> - </tbody> - </table> - - - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>Listening Port</strong> - <ul> - <li>The port to listen on for incoming HTTP Requests</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Hostname - <ul> - <li>The Hostname to bind to. If not specified, will bind to all hosts</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>HTTP Context Map</strong> - <ul> - <li>The HTTP Context Map Controller Service to use for caching the HTTP Request Information</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>SSL Context Service - <ul> - <li>The Controller Service to use for obtaining an SSL Context. The SSL Context controller service is a mechanism for providing all the security properties that allow for secure communications between NiFi extensions and other systems. See the User Guide or the Controller Services documentation via the "help" link in the upper-right corner of the GUI for more information about the StandardSSLContextService. The value for this property is the identifier name that is configured in the StandardSSLContextService.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - - <li><strong>Allowed Paths</strong> - <ul> - <li>A Regular Expression that specifies the valid HTTP Paths that are allowed in the incoming URL Requests. If this value is specified and the path of the HTTP Requests does not match this Regular Expression, the Processor will respond with a 404: NotFound</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow GET</strong> - <ul> - <li>Specifies whether or not to allow HTTP GET Method</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow POST</strong> - <ul> - <li>Specifies whether or not to allow HTTP POST Method</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow PUT</strong> - <ul> - <li>Specifies whether or not to allow HTTP PUT Method</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow DELETE</strong> - <ul> - <li>Specifies whether or not to allow HTTP DELETE Method</li> - <li>Default value: true</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow HEAD</strong> - <ul> - <li>Specifies whether or not to allow HTTP HEAD Method</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Allow OPTIONS</strong> - <ul> - <li>Specifies whether or not to allow HTTP OPTIONS Method</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Additional HTTP Methods - <ul> - <li>A comma-separated list of non-standard HTTP Methods that should be allowed</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Client Authentication</strong> - <ul> - <li>Specifies whether or not the Processor should authenticate clients. This value is ignored if the <SSL Context Service> Property is not specified or the SSL Context provided uses only a KeyStore and not a TrustStore.</li> - <li> - The following values are allowed: - <ul> - <li><b>No Authentication</b> - Processor will not authenticate clients. Anyone can communicate with this Processor anonymously</li> - <li><b>Want Authentication</b> - Processor will try to verify the client but if unable to verify will allow the client to communicate anonymously</li> - <li><b>Need Authentication</b> - Processor will reject communications from any client unless the client provides a certificate that is trusted by the TrustStore specified in the SSL Context Service</li> - </ul> - </li> - <li>Default value: No Authentication</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>All FlowFiles that are created are routed to this relationship.</li> - </ul> - </li> - </ul> - - - <p> - <strong>See Also:</strong><br /> - <a href="../org.apache.nifi.processors.standard.HandleHttpResponse/index.html">HandleHttpResponse</a><br /> - <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a><br /> - <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br /> - </p> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html new file mode 100644 index 0000000..5d8993e --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/additionalDetails.html @@ -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>HandleHttpResponse</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + <h2>Usage Description:</h2> + <p> + The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> Processor + provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available + through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a + flow such as: + </p> + + <p> + <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> -> + <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> + <a href="index.html">HandleHttpResponse</a> + </p> + + <p> + This Processor must be configured with the same <HTTP Context Map> service as the corresponding HandleHttpRequest Processor. + Otherwise, all FlowFiles will be routed to the 'failure' relationship. + </p> + + <p> + All FlowFiles must have an attribute named <code>http.context.identifier</code>. The value of this attribute is used to lookup + the HTTP Response so that the proper message can be sent back to the requestor. If this attribute is missing, the FlowFile + will be routed to 'failure.' + </p> + <p> + <strong>See Also:</strong><br /> + <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a><br /> + <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a><br /> + <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br /> + </p> + + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/index.html deleted file mode 100644 index 70d76a6..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.HandleHttpResponse/index.html +++ /dev/null @@ -1,112 +0,0 @@ -<!DOCTYPE html> -<html lang="en"> - <!-- - Licensed to the Apache Software Foundation (ASF) under one or more - contributor license agreements. See the NOTICE file distributed with - this work for additional information regarding copyright ownership. - The ASF licenses this file to You under the Apache License, Version 2.0 - (the "License"); you may not use this file except in compliance with - the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. - --> - <head> - <meta charset="utf-8" /> - <title>HandleHttpResponse</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor responds to an HTTP request that was received by the - <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> Processor. - </p> - - <p> - The pairing of this Processor with a <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> Processor - provides the ability to use NiFi to visually construct a web server that can carry out any functionality that is available - through the existing Processors. For example, one could construct a Web-based front end to an SFTP Server by constructing a - flow such as: - </p> - - <p> - <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a> -> - <a href="../org.apache.nifi.processors.standard.PutSFTP/index.html">PutSFTP</a> -> - <a href="index.html">HandleHttpResponse</a> - </p> - - <p> - This Processor must be configured with the same <HTTP Context Map> service as the corresponding HandleHttpRequest Processor. - Otherwise, all FlowFiles will be routed to the 'failure' relationship. - </p> - - <p> - All FlowFiles must have an attribute named <code>http.context.identifier</code>. The value of this attribute is used to lookup - the HTTP Response so that the proper message can be sent back to the requestor. If this attribute is missing, the FlowFile - will be routed to 'failure.' - </p> - - - <p> - <strong>Properties:</strong> - </p> - <p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi Expression Language (or simply, "expression language"), that is also indicated. - </p> - <ul> - <li><strong>HTTP Status Code</strong> - <ul> - <li>The HTTP Status Code to use when responding to the HTTP Request. See Section 10 of RFC 2616 for more information.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li><strong>HTTP Context Map</strong> - <ul> - <li>The HTTP Context Map Controller Service to use for caching the HTTP Request Information</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If a message is successfully sent back to the requestor, the FlowFile is routed to this relationship.</li> - </ul> - </li> - - <li>failure - <ul> - <li> - A FlowFile will be routed to failure under the following conditions: - <ul> - <li>The FlowFile does not have an <code>http.context.identifier</code> attribute</li> - <li>The <code>http.context.identifier</code> attribute has a value that cannot be found in the HTTP Context Map</li> - <li>The HTTP Status Code is not a number</li> - <li>There was a communications failure when attempting to write the response to the requestor</li> - </ul> - </li> - </ul> - </li> - </ul> - - <p> - <strong>See Also:</strong><br /> - <a href="../org.apache.nifi.processors.standard.HandleHttpRequest/index.html">HandleHttpRequest</a><br /> - <a href="../org.apache.nifi.http.StandardHttpContextMap/index.html">StandardHttpContextMap</a><br /> - <a href="../org.apache.nifi.ssl.StandardSSLContextService/index.html">StandardSSLContextService</a><br /> - </p> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html index 22ebd1d..f993fee 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html @@ -22,77 +22,23 @@ </head> <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> <p> - This processor attempts to identify the MIME type used for a - FlowFile. If the MIME type can be identified, an attribute with the - name - <code>mime.type</code> - is added to the FlowFile, and its value is the detected MIME type. - Some MIME - types require the processor to read a significant amount of data; for - these MIME types, their identification is optional. (See the - properties Identify ZIP and Identify TAR.) The algorithm may have to - read the entire contents of a file for each type of identification. If - the MIME Type cannot be determined, its mime.type attribute will be - set to - <code>application/octet-stream</code> - . + <strong>Modifies Attributes:</strong> </p> - - <p>The following MIME Types are detected: - </p> - <ul> - <li>application/gzip</li> - <li>application/bzip2</li> - <li>application/flowfile-v3</li> - <li>application/flowfile-v1 (requires Identify TAR be set to true)</li> - <li>application/xml</li> - <li>video/mp4</li> - <li>video/x-m4v</li> - <li>video/mp4a-latm</li> - <li>video/quicktime</li> - <li>video/mpeg</li> - <li>audio/wav</li> - <li>audio/mp3</li> - <li>image/bmp</li> - <li>image/png</li> - <li>image/jpg</li> - <li>image/gif</li> - <li>image/tif</li> - <li>application/vnd.ms-works</li> - <li>application/msexcel</li> - <li>application/mspowerpoint</li> - <li>application/msaccess</li> - <li>application/x-ms-wmv</li> - <li>application/pdf</li> - <li>application/x-rpm</li> - <li>application/tar</li> - <li>application/x-7z-compressed</li> - <li>application/java-archive</li> - <li>application/zip</li> - <li>application/x-lzh</li> - </ul> - - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>mime.type</td> - <td>This Processor sets the FlowFile's mime.type attribute to the detected MIME Type. If unable to detect - the MIME Type, the attribute's value will be set to <code>application/octet-stream</code>.</td> - </tr> - </tbody> - </table> -</body> + <table> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>mime.type</td> + <td>This Processor sets the FlowFile's mime.type attribute to the detected MIME Type. If unable to detect + the MIME Type, the attribute's value will be set to <code>application/octet-stream</code>.</td> + </tr> + </tbody> + </table> + </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html index 1c33360..9a18355 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html @@ -21,7 +21,7 @@ </head> <body> - + <p> <strong>Adds Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html index 0a3b665..d55fcec 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html @@ -23,7 +23,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Modifies Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html index f8b15f9..d193e93 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html @@ -25,7 +25,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Uses Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html index fbece63..d8afa01 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutFTP/additionalDetails.html @@ -22,7 +22,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Optional User-Defined Properties:</strong> </p> @@ -37,30 +37,12 @@ essentially the same as sending quote commands to an FTP server from the command line. </li> <li><strong>NOTE</strong>: While this is the same as sending a quote command, it is very important that - you leave off the �quote� part of the command from the text value you enter in. For example, if you want - to mimic the command line ftp command quote stat you would give the text value of stat. You have the - option of sending a number of commands to the FTP server before the file is sent. If you have only one - command, then the name of the optional parameter will be pre.cmd.1. If you have a second command, then - the next optional parameter you give is pre.cmd.2, and so on. There is no limit to the number of pre - commands you can send. The commands will be sent in the order of their number, so pre.cmd.1 will be sent - first, pre.cmd.2 will be sent next, etc. This is true regardless of what order they are added to the - processor properties. The property names determine the order.</li> - <li><strong>NOTE</strong>: If the optional property name does not follow the pattern pre.cmd.<em>integer</em> - - then the command will not be sent. If a command is given which is not recognized by the server, then - that will be logged.</li> - <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> - </ul> - </li> - <li>post.cmd.# - <ul> - <li>Optional properties of this type can be added by the user and should be used for <strong>VERY - RARE</strong> cases only. You will know when you need to use it when the recipient specifies that you must - send FTP commands after the transfer. Otherwise, do not use it. These are the same as the pre commands. + you leave off the . (See pre commands above) except that these commands are sent after the file transfer. </li> <li>Supports expression language: true. FlowFile attributes can be used in commands using the expression language</li> </ul> </li> </ul> -</body> + </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html index 656e150..93876b6 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PutSFTP/additionalDetails.html @@ -24,11 +24,11 @@ <!-- Processor Documentation ================================================== --> <p> <strong>See Also:</strong> - </p> + </p> <ul> <li> <a href="../org.apache.nifi.processors.standard.GetSFTP/index.html">GetSFTP</a> </li> </ul> -</body> + </body> </html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html index 9bd3c38..92f9f46 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.RouteOnAttribute/additionalDetails.html @@ -22,7 +22,7 @@ </head> <body> - <h2>Description:</h2> + <h2>Usage Example</h2> <p> This processor routes FlowFiles based on their attributes using the NiFi Expression Language. Users add properties with http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html index f8560f2..aff6549 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ScanContent/additionalDetails.html @@ -23,7 +23,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Modifies Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html index 64dd7ba..957913f 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SegmentContent/additionalDetails.html @@ -23,7 +23,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Adds or Modifies Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html index 64d8d7d..683b0fa 100644 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitContent/additionalDetails.html @@ -23,7 +23,7 @@ <body> <!-- Processor Documentation ================================================== --> - + <p> <strong>Modifies Attributes:</strong> </p> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/e9d31f5d/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html deleted file mode 100644 index e3a4b14..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.SplitJson/index.html +++ /dev/null @@ -1,85 +0,0 @@ -<!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>SplitJson</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css"/> -</head> - -<body> -<!-- Processor Documentation ================================================== --> -<h2>Description:</h2> - -<p> - This processor splits a JSON File into multiple, separate FlowFiles for an array element specified by a JsonPath - expression. - Each generated FlowFile is comprised of an element of the specified array and transferred to relationship 'split,' - with the original file transferred to the 'original' relationship. If the specified JsonPath is not found or - does not evaluate to an array element, the original file is routed to 'failure' and no files are generated. -</p> - -<p> - <strong>Note:</strong> The underlying JsonPath library loads the entirety of the streamed content into and performs - result evaluations in memory. Accordingly, it is important to consider the anticipated profile of content being - evaluated by this processor and the hardware supporting it especially when working against large JSON documents. -</p> - -<strong>Properties:</strong> -</p> - -<p> - In the list below, the names of required properties appear in bold. Any other properties (not in bold) are - considered optional. If a property has a default value, it is indicated. If a property supports the use of the NiFi - Expression Language (or simply, "expression language"), that is also indicated. -</p> -<ul> - <li><strong>JsonPath Expression</strong> - <ul> - <li>A JsonPath expression that indicates the array element to split into JSON/scalar fragments.</li> - <li>Supports expression language: false</li> - </ul> - </li> -</ul> - -<p> - <strong>Relationships:</strong> -</p> -<ul> - <li>failure - <ul> - <li>If a FlowFile fails processing for any reason (for example, the FlowFile is not valid JSON or the - specified path does not exist) and does not go down the original relationship. - </li> - </ul> - </li> - <li>original - <ul> - <li>If FlowFiles are successfully split, a copy of the original FlowFile follows this relationship.</li> - </ul> - </li> - <li>split - <ul> - <li>If FlowFiles are successfully split into one or more files, those split files follow this - relationship. - </li> - </ul> - </li> -</ul> - -</body> -</html>
