http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/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 new file mode 100644 index 0000000..1fb5566 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html @@ -0,0 +1,98 @@ +<!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>IdentifyMimeType</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </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> + . + </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 border="1"> + <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/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html deleted file mode 100644 index 120b69c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.IdentifyMimeType/index.html +++ /dev/null @@ -1,136 +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>IdentifyMimeType</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </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> - . - </p> - - <p>The following MIME Types are detected: - <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> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <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> - - <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>Identify ZIP</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to attempt in depth identification - of ZIP MIME types.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Identify TAR</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to attempt in depth identification - of TAR MIME types.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - -</ul> -<p> - <strong>Relationships:</strong> -</p> -<ul> - <li>success - <ul> - <li>All FlowFiles follow this relationship, regardless of - whether the MIME type was detected.</li> - </ul> - </li> -</ul> - -</body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/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 new file mode 100644 index 0000000..f7f06a0 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/additionalDetails.html @@ -0,0 +1,64 @@ +<!DOCTYPE html> +<html lang="en"> + <!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + --> + <head> + <meta charset="utf-8" /> + <title>InvokeHTTP - a swiss army http client processor</title> + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + + <p> + <strong>Adds Attributes:</strong> + </p> + + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>invokehttp.status.code</td> + <td>The status code that is returned.</td> + </tr> + <tr> + <td>invokehttp.status.message</td> + <td>The status message that is returned.</td> + </tr> + <tr> + <td>invokehttp.response.body</td> + <td>The response body.</td> + </tr> + <tr> + <td>invokehttp.request.url</td> + <td>The request URL.</td> + </tr> + <tr> + <td>invokehttp.tx.id</td> + <td>The transaction ID that is returned after reading the response.</td> + </tr> + <tr> + <td>invokehttp.remote.dn</td> + <td>The DN of the remote server.</td> + </tr> + </tbody> + </table> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html deleted file mode 100644 index 2907034..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.InvokeHTTP/index.html +++ /dev/null @@ -1,181 +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>InvokeHTTP - a swiss army http client processor</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <h2>Description:</h2> - <p> - Making requests to remote HTTP servers. Supporting common HTTP methods. - Storing results as new flowfiles upon success. Routing to failure on error. - </p> - <p> - An HTTP client processor that converts FlowFile attributes to HTTP headers with configurable HTTP method, URL, etc. - <p> - - <p> - <strong>Adds Attributes:</strong> - </p> - - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>invokehttp.status.code</td> - <td>The status code that is returned.</td> - </tr> - <tr> - <td>invokehttp.status.message</td> - <td>The status message that is returned.</td> - </tr> - <tr> - <td>invokehttp.response.body</td> - <td>The response body.</td> - </tr> - <tr> - <td>invokehttp.request.url</td> - <td>The request URL.</td> - </tr> - <tr> - <td>invokehttp.tx.id</td> - <td>The transaction ID that is returned after reading the response.</td> - </tr> - <tr> - <td>invokehttp.remote.dn</td> - <td>The DN of the remote server.</td> - </tr> - </tbody> - </table> - - <p> - <strong>Properties:</strong> - </p> - <ul> - <li> - <strong>HTTP Method</strong> - <ul> - <li>The HTTP request method (e.g., GET, POST, PUT, DELETE, HEAD, OPTIONS)</li> - <li>Default value: GET</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Remote URL</strong> - <ul> - <li>The remote URL that will be conneted to, including scheme, host, port, and path.</li> - <li>Default value: no default</li> - <li>Supports expression language: true</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>Connection Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while creating a connection.</li> - <li>Default value: 5 secs</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Read Timeout</strong> - <ul> - <li>The amount of time to wait before timing out while waiting for a response from the remote service.</li> - <li>Default value: 15 secs</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Include Data Header</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to include an RFC-2616 date header in the request.</li> - <li>Default value: True</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Follow Redirects</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to follow HTTP redirects issued by the remote server.</li> - <li>Default value: True</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Attributes to Send - <ul> - <li>A regular expression that defines which attributes to send as HTTP headers in the request. If not defined, no attributes are sent as headers.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - </ul> - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - <strong>Original</strong> - <ul> - <li>Original FlowFile will be routed upon success (2xx status codes).</li> - </ul> - </li> - <li> - <strong>Response</strong> - <ul> - <li>Response FlowFile will be routed upon success (2xx status codes).</li> - </ul> - </li> - <li> - <strong>Retry</strong> - <ul> - <li>FlowFile will be routed on any status code that can be retried (5xx status codes).</li> - </ul> - </li> - <li> - <strong>No Retry</strong> - <ul> - <li>FlowFile will be routed on any status code that should NOT be retried (1xx, 3xx, 4xx status codes).</li> - </ul> - </li> - <li> - <strong>Failure</strong> - <ul> - <li>FlowFile will be routed on any type of connection failure, timeout or general exception.</li> - </ul> - </li> - </ul> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html deleted file mode 100644 index 49e85cc..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenHTTP/index.html +++ /dev/null @@ -1,86 +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>ListenHTTP</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 service that is used to receive FlowFiles from remote sources. The URL of the service is http://{hostname}:{port}/contentListener. - </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>Listening Port</strong> - <ul> - <li>The port to listen on for incoming connections.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Max Data to Receive per Second</strong> - <ul> - <li>The maximum amount of data to receive per second; this allows the bandwidth to be throttled to a specified data rate. If not specified, the data rate is not throttled.</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>Authorized DN Pattern</strong> - <ul> - <li>A regular expression to apply against the distinguished anme (DN) of incoming connections. If the pattern does not match the DN, the connection is refused.</li> - <li>Default value: .*</li> - <li>Supports expression language: false</li> - </ul></li> - <li>HTTP Headers to receive as Attributes (Regex) - <ul> - <li>Specifies the Regular Expression that determines the names of HTTP Headers that should be passed along as FlowFile attributes</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Max Unconfirmed FlowFile Time</strong> - <ul> - <li>The maximum amount of time to wait for a FlowFile to be confirmed before it is removed from the cache.</li> - <li>Default value: 60 secs</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If the processor successfully receives files via an HTTP service, then the FlowFiles follow this relationship.</li> - </ul></li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html deleted file mode 100644 index c50e79d..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ListenUDP/index.html +++ /dev/null @@ -1,144 +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>ListenUDP</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor listens for Datagram Packets on a given port and concatenates the contents of - those packets together generating FlowFiles roughly as often as the internal buffer fills up or until - no more data is currently available. - </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>Port</strong> - <ul> - <li>The port to listen on for data packets. Must be known by senders of Datagrams. May be a system - property or environment variable.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Receive Timeout</strong> - <ul> - <li>The time out period when waiting to receive data from the socket. Specify units.</li> - <li>Default value: 5 secs</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Max Buffer Size</strong> - <ul> - <li>Determines the size each receive buffer may be. Specify units.</li> - <li>Default value: 1 MB</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>FlowFile Size Trigger</strong> - <ul> - <li>Determines the (almost) upper bound size at which a flow file would be generated. A flow file will get made even if - this value isn't reached if there is no more data streaming in and this value may be exceeded by the size of a - single packet. Specify units.</li> - <li>Default value: 1 MB </li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Max size of UDP Buffer</strong> - <ul> - <li>The maximum UDP buffer size that should be used. This is a suggestion to the Operating System - to indicate how big the udp socket buffer should be. Specify units.</li> - <li>Default value: 1 MB</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Receive Buffer Count</strong> - <ul> - <li>Number of receiving buffers to be used to accept data from the socket. Higher numbers means more - ram is allocated but can allow better throughput.</li> - <li>Default value: 4</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>Channel Reader Interval</strong> - <ul> - <li>Scheduling interval for each read channel. Specify units.</li> - <li>Default value: 50 millisecs</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - <strong>FlowFiles Per Session</strong> - <ul> - <li>The number of flow files per session. Higher number is more efficient, but will lose more data - if a problem occurs that causes a rollback of a session.</li> - <li>Default value: 10</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li> - Sending Host - <ul> - <li>IP, or name, of a remote host. Only Datagrams from the specified Sending Host Port and this host - will be accepted. Improves Performance. May be a system property or an environment variable. If - this is specified, the Sending Host Port must be specified as well.</li> - <li>Default value: none</li> - <li>Supports expression language: true</li> - </ul> - </li> - <li> - Sending Host Port - <ul> - <li>Port being used by remote host to send Datagrams. Only Datagrams from the specified Sending Host - and this port will be accepted. Improves Performance. May be a system property or an environment - variable.If this is specified, the Sending Host must be specified as well.</li> - <li>Default value: none</li> - <li>Supports expression language: true</li> - </ul> - </li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li> - success - <ul> - <li>Used when file is successfully created and filled with UDP packets.</li> - </ul> - </li> - </ul> - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html deleted file mode 100644 index 33ab03c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.LogAttribute/index.html +++ /dev/null @@ -1,80 +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>LogAttribute</title> - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor reads the attributes on incoming FlowFiles and prints those attributes and their values to the log at the logging level specified by the user.</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>Attributes to Ignore - <ul> - <li>A comma-separated list of attributes to ignore. If not specified, no attributes will be ignored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Attributes to Log - <ul> - <li>A comma-separated list of attributes to log. If not specified, all attributes are logged.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Log Payload</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to log the payload of incoming FlowFiles.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Log Level</strong> - <ul> - <li>The log level at which to log the attributes. Acceptable values are: - <ul> - <li>trace</li> - <li>debug</li> - <li>info</li> - </ul></li> - <li>Default value: info</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>All outgoing FlowFiles follow this relationship.</li> - </ul></li> - </ul> - - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html new file mode 100644 index 0000000..68f7007 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/additionalDetails.html @@ -0,0 +1,115 @@ +<!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>MergeContent</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Uses Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>fragment.identifier</td> + <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. + All FlowFiles with the same value for this attribute will be bundled together. + </td> + </tr> + <tr> + <td>fragment.index</td> + <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. + This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> + attribute and must be a unique integer between 0 and the value of the <code>fragment.count</code> attribute. + This attribute indicates the order in which the fragments should be assembled. + </td> + </tr> + <tr> + <td>fragment.count</td> + <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. + This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> + attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of + this attribute indicates how many FlowFiles should be expected in the given bundle. + </td> + </tr> + <tr> + <td>segment.original.filename</td> + <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. + This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> + attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of + this attribute will be used for the filename of the completed merged FlowFile. + </td> + </tr> + <tr> + <td>tar.permissions</td> + <td>Applicable only if the <Merge Format> property is set to <code>TAR</code>. + The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive) + and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute + is missing or has an invalid value, the default value of 644 will be used. + </td> + </tr> + </tbody> + </table> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>filename</td> + <td>When more than 1 file is merged, the filename comes from the segment.original.filename attribute. + If that attribute does not exist in the source FlowFiles, then the filename is set to the number of + nanoseconds matching system time. Then a filename extension may be applied: + <ul> + <li>if Merge Format is TAR, then the filename will be appended with .tar</li> + <li>if Merge Format is ZIP, then the filename will be appended with .zip</li> + <li>if Merge Format is FlowFileStream, then the filename will be appended with .pkg</li> + </ul> + </td> + </tr> + <tr> + <td>merge.count</td> + <td>The number of FlowFiles that were merged into this bundle.</td> + </tr> + <tr> + <td>merge.bin.age</td> + <td>The age of the bin, in milliseconds, when it was merged and output. Effectively this is the + greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it + was output.</td> + </tr> + </tbody> + </table> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html deleted file mode 100644 index 3e02b81..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MergeContent/index.html +++ /dev/null @@ -1,347 +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>MergeContent</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor merges a group of FlowFiles together into a - "Bundle" based on a user-defined strategy and packages them into a - single FlowFile. It is recommended that the processor be configured - with only a single incoming connection, as groups of FlowFiles will - not be created from FlowFiles in different connections. This processor - updates the mime.type attribute as appropriate. After files have been merged by this processor, they can be - unpackaged later using the UnpackContent processor.</p> - - <p> - <strong>Uses Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>fragment.identifier</td> - <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. - All FlowFiles with the same value for this attribute will be bundled together. - </td> - </tr> - <tr> - <td>fragment.index</td> - <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. - This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> - attribute and must be a unique integer between 0 and the value of the <code>fragment.count</code> attribute. - This attribute indicates the order in which the fragments should be assembled. - </td> - </tr> - <tr> - <td>fragment.count</td> - <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. - This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> - attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of - this attribute indicates how many FlowFiles should be expected in the given bundle. - </td> - </tr> - <tr> - <td>segment.original.filename</td> - <td>Applicable only if the <Merge Strategy> property is set to <code>Defragment</code>. - This attribute must be present on all FlowFiles with the same value for the <code>fragment.identifier</code> - attribute. All FlowFiles in the same bundle must have the same value for this attribute. The value of - this attribute will be used for the filename of the completed merged FlowFile. - </td> - </tr> - <tr> - <td>tar.permissions</td> - <td>Applicable only if the <Merge Format> property is set to <code>TAR</code>. - The value of this attribute must be 3 characters; each character must be in the range 0 to 7 (inclusive) - and indicates the file permissions that should be used for the FlowFile's TAR entry. If this attribute - is missing or has an invalid value, the default value of 644 will be used. - </td> - </tr> - </tbody> - </table> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>filename</td> - <td>When more than 1 file is merged, the filename comes from the segment.original.filename attribute. - If that attribute does not exist in the source FlowFiles, then the filename is set to the number of - nanoseconds matching system time. Then a filename extension may be applied: - <ul> - <li>if Merge Format is TAR, then the filename will be appended with .tar</li> - <li>if Merge Format is ZIP, then the filename will be appended with .zip</li> - <li>if Merge Format is FlowFileStream, then the filename will be appended with .pkg</li> - </ul> - </td> - </tr> - <tr> - <td>merge.count</td> - <td>The number of FlowFiles that were merged into this bundle.</td> - </tr> - <tr> - <td>merge.bin.age</td> - <td>The age of the bin, in milliseconds, when it was merged and output. Effectively this is the - greatest amount of time that any FlowFile in this bundle remained waiting in this processor before it - was output.</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>Merge Strategy</strong> - <ul> - <li>Specifies the algorithm used to merge content. The - following Merge Strategies are available: - <ul> - <li><b>Bin-Packing Algorithm</b> - This strategy uses the - <Minimum Number of Entries> and <Maximum Number of - Entries> properties to determine how many FlowFiles should be - used to create a Bundle.</li> - <li><b>Defragment</b> - This strategy is used when - recombining a set of FlowFiles that have been broken apart - previously. When using this value, the <Minimum Number of - Entries> and <Maximum Number of Entries> properties are - ignored. In lieu of using these properties, the pocessor - determines the number of FlowFiles to use for a bundle by - examining the <code>fragment.count</code> attribute of the - FlowFiles.</li> - </ul> - </li> - <li>Default value: Bin-Packing Algorithm</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Merge Format</strong> - <ul> - <li>Determines the format that will be used to merge the - content. Options include the following values: - <ul> - <li><b>Binary Concatenation</b> - FlowFiles will be combined - by concatenating their content. The ordering of the FlowFiles is - non-deterministic.</li> - - <li><b>TAR</b> - FlowFiles will be combined by creating a TAR - file. If the <Keep Path> property is set to <code>true</code>, - the FlowFiles' paths will determine the folder in the TAR file - where the FlowFile's content will be stored. Otherwise, all - FlowFiles' content will be stored in the TAR file's root - directory. If a FlowFile that is to be bundled has an attribute - with the name <code>tar.permissions</code> and that attribute's - value is a 3-digit number (with each number in the range of 0-7), - the value will be applied as the File Permissions for that TAR - entry.</li> - - <li><b>ZIP</b> - FlowFiles will be combined by creating a ZIP - file. If the <Keep Path> property is set to <code>true</code>, - the FlowFiles' paths will determine the folder in the ZIP file - where the FlowFile's content will be stored. Otherwise, all - FlowFiles' content will be stored in the ZIP file's root - directory. The <Compression Level> property can be used to - determine the Compression Level to use, from 0 (no compression) - to 9 (highest compression).</li> - - <li><b>FlowFileStream, v3</b> - This format would be used if the merged files - are to be sent to another NiFi system that is running NiFi version 3.0 or later. - When this format is selected, FlowFiles will be combined - into a FlowFileStream, which includes both FlowFile Attributes - and Content for all FlowFiles.</li> - - <li><b>FlowFileStream, v2</b> - This format would be used if the merged files - are to be sent to another NiFi system that is running a NiFi version older than NiFi-3.0. - When this format is selected, FlowFiles will be combined - into a FlowFileStream, which includes both FlowFile Attributes - and Content for all FlowFiles. Only use this if required for backward compatibility.</li> - - <li><b>FlowFile Tar, v1</b> - This format would be used if the merged files - are to be sent to another NiFi system that is running a much older NiFi version that does not support a FlowFileStream. - When this format is selected, FlowFiles will be combined - into a FlowFile Tar, which includes both FlowFile Attributes - and Content for all FlowFiles. Only use this if required for backward compatibility.</li> - </ul> - <li>Default value: Binary Concatenation</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Attribute Strategy</strong> - <ul> - <li>Determines which FlowFile attributes should be added to - the bundle. If 'Keep All Unique Attributes' is selected, any - attribute on any FlowFile that gets bundled will be kept unless - its value conflicts with the value from another FlowFile. If - 'Keep Only Common Attributes' is selected, only the attributes - that exist on all FlowFiles in the bundle with the same value - will be preserved.</li> - <li>Default value: Keep Only Common Attributes</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Correlation Attribute Name - <ul> - <li>If specified, like FlowFiles will be binned together, - where 'like FlowFiles' means FlowFiles that have the same value - for this attribute. If not specified, and Merge Strategy is Defragment, - then the fragment.identifier attribute is automatically used. Otherwise, - FlowFiles are bundled by the order in which they are pulled from the queue.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Minimum Number of Entries</strong> - <ul> - <li>The minimum number of files to include in a bundle.</li> - <li>Default value: 1</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum Number of Entries - <ul> - <li>The maximum number of files to include in a bundle. If - not specified, there is no maximum.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Minimum Group Size</strong> - <ul> - <li>The minimum size for each bundle.</li> - <li>Default value: 0 B</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Maximum Group Size - <ul> - <li>The maximum size for each bundle. If not specified, there - is no maximum.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Max Bin Age - <ul> - <li>The maximum age of a bin that will trigger the bin to be - considered complete. The expected format for this value is a - positive integer and a time unit, such as seconds, minutes, - hours.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Maximum Number of Bins</strong> - <ul> - <li>The maximum number of bins that can be held in memory at - any one time.</li> - <li>Default value: 100</li> - <li>Supports expression language: false</li> - </ul></li> - <li>Header File - <ul> - <li>The local file path to a file that should be used as a header - on the merged file. If not supplied, no header is used. This property is - valid only when using Binary Concatenation as the Merge Format; - otherwise, it is ignored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Footer File - <ul> - <li>The local file path to a file that should be used as a footer - on the merged file. If not supplied, no footer is used. This property is - valid only when using Binary Concatenation as the Merge Format; - otherwise, it is ignored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li>Demarcator File - <ul> - <li>The local file path the file that specifies the - demarcator to use. If not specified, no demarcator is supplied. - This property is valid only when using Binary Concatenation as - the Merge Format; otherwise, it is ignored.</li> - <li>Default value: no default</li> - <li>Supports expression language: false</li> - </ul> - </li> - <li><strong>Compression Level</strong> - <ul> - <li>Specifies the compression level to use when using the ZIP - merge format. If not using the zip merge format, this value is - ignored.</li> - <li>Default value: 1</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Keep Path</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to keep - the FlowFiles' file paths in their entry names if using the ZIP - or TAR merge strategies. If not using one of those strategies, - this value is ignored.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>failure - <ul> - <li>If something prevents the processor from bundling the - incoming files, then they follow this relationship.</li> - </ul> - </li> - <li>merged - <ul> - <li>If the merging was successful, then the FlowFile - containing the merged content follows this relationship.</li> - </ul> - </li> - <li>original - <ul> - <li>If the merging was successful, then an original copy of - each file that was used to create a bundle follows this - relationship.</li> - </ul> - </li> - </ul> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html deleted file mode 100644 index 285814c..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.ModifyBytes/index.html +++ /dev/null @@ -1,64 +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>ModifyBytes</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p> - This processor updates the content of a FlowFile by removing bytes from start or end of a file. - </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>Start Offset</strong> - <ul> - <li>Number of bytes removed at the beginning of the file. - </li> - <li>Default value: 0 B </li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>End Offset</strong> - <ul> - <li>Number of bytes removed at the end of the file. - </li> - <li>Default value: 0 B </li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>success - <ul> - <li>If FlowFiles are successfully updated, then they follow this relationship.</li> - </ul> - </li> - </ul> - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/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 new file mode 100644 index 0000000..e05db70 --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/additionalDetails.html @@ -0,0 +1,49 @@ +<!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>MonitorActivity</title> + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Modifies Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>inactivityStartMillis</td> + <td>The time at which Inactivity began, in the form of milliseconds since Epoch.</td> + </tr> + <tr> + <td>inactivityDurationMillis</td> + <td>The number of milliseconds that the inactivity has spanned.</td> + </tr> + </tbody> + </table> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html ---------------------------------------------------------------------- diff --git a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html deleted file mode 100644 index d57c640..0000000 --- a/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.MonitorActivity/index.html +++ /dev/null @@ -1,143 +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>MonitorActivity</title> - - <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> - </head> - - <body> - <!-- Processor Documentation ================================================== --> - <h2>Description:</h2> - <p>This processor monitors its point in the dataflow for - activity and sends a notice when there is a lack of data flowing - through it for some user-specified amount of time; it then sends - another notice when the flow of data resumes.</p> - - <p> - <strong>Modifies Attributes:</strong> - </p> - <table border="1"> - <thead> - <tr> - <th>Attribute Name</th> - <th>Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>inactivityStartMillis</td> - <td>The time at which Inactivity began, in the form of milliseconds since Epoch.</td> - </tr> - <tr> - <td>inactivityDurationMillis</td> - <td>The number of milliseconds that the inactivity has spanned.</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>Threshold Duration</strong> - <ul> - <li>The amount of time that must elapse before the flow is - considered inactive.</li> - <li>Default value: 5 min</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Continually Send Messages</strong> - <ul> - <li>A Boolean value (true/false), indicating whether to send - inactivity notices continually every time the threshold duration - period elapses until activity is restored. If false, the processor - will send a notice only when the flow first becomes inactive.</li> - <li>Default value: false</li> - <li>Supports expression language: false</li> - </ul></li> - <li><strong>Inactivity Message</strong> - <ul> - <li>The message that will appear as the content of outgoing - FlowFiles that are sent to the inactive relationship.</li> - <li>Default value: - <ul> - <li>Lacking activity as of time: ${now():format('yyyy/MM/dd - HH:mm:ss')}; flow has been inactive for - ${inactivityDurationMillis:toNumber():divide(60000)} minutes.</li> - </ul> - </li> - <li>Supports expression language: true</li> - </ul></li> - <li><strong>Activity Restored Message</strong> - <ul> - <li>The message that will appear as the content of outgoing - FlowFiles that are sent to the activity.restored relationship.</li> - <li>Default value: - <ul> - <li>Activity restored at time: ${now():format('yyyy/MM/dd - HH:mm:ss')} after being inactive for - ${inactivityDurationMillis:toNumber():divide(60000)} minutes.</li> - </ul> - </li> - <li>Supports expression language: true</li> - </ul></li> - <li>Copy Attributes - <ul> - <li>If true, will copy all flow file attributes from the flow file that resumed activity to the newly created indicator flow file.</li> - <li>Default value: false - </li> - <li>Supports expression language: false</li> - </ul></li> - </ul> - - <p> - <strong>Relationships:</strong> - </p> - <ul> - <li>activity.restored - <ul> - <li>FlowFiles containing the content specified by the Activity - Restored Message property follow this relationship when FlowFiles - are routing to the success relationship following a period of - inactivity.</li> - </ul> - </li> - <li>inactive - <ul> - <li>FlowFiles containing the content specified by the - Inactivity Message property follow this relationship when FlowFiles - stop routing to the success relationship for the period of time set - in the Threshold Duration property.</li> - </ul> - </li> - <li>success - <ul> - <li>All incoming FlowFiles follow this relationship.</li> - </ul> - </li> - </ul> - - - </body> -</html> http://git-wip-us.apache.org/repos/asf/incubator-nifi/blob/0fa553ac/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 new file mode 100644 index 0000000..5ba60fa --- /dev/null +++ b/nifi/nifi-nar-bundles/nifi-standard-bundle/nifi-standard-processors/src/main/resources/docs/org.apache.nifi.processors.standard.PostHTTP/additionalDetails.html @@ -0,0 +1,48 @@ +<!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>PostHTTP</title> + + + <link rel="stylesheet" href="../../css/component-usage.css" type="text/css" /> + </head> + + <body> + + <!-- Processor Documentation ================================================== --> + + <p> + <strong>Uses Attributes:</strong> + </p> + <table border="1"> + <thead> + <tr> + <th>Attribute Name</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>mime.type</td> + <td>If not sending data as a FlowFile, the mime.type attribute will be used to set the HTTP Header for <code>Content-Type</code>.</td> + </tr> + </tbody> + </table> + + </body> +</html>
