GetHTTP

From commits-return-42400-archive-asf-public=cust-asf.ponee.io@nifi.apache.org Mon Feb 3 21:53:55 2020 Return-Path: X-Original-To: archive-asf-public@cust-asf.ponee.io Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [207.244.88.153]) by mx-eu-01.ponee.io (Postfix) with SMTP id 750B718067C for ; Mon, 3 Feb 2020 22:53:54 +0100 (CET) Received: (qmail 79393 invoked by uid 500); 3 Feb 2020 21:53:42 -0000 Mailing-List: contact commits-help@nifi.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@nifi.apache.org Delivered-To: mailing list commits@nifi.apache.org Received: (qmail 78640 invoked by uid 99); 3 Feb 2020 21:53:41 -0000 Received: from Unknown (HELO svn01-us-east.apache.org) (13.90.137.153) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 03 Feb 2020 21:53:40 +0000 Received: from svn01-us-east.apache.org (svn01-us-east.apache.org [127.0.0.1]) by svn01-us-east.apache.org (ASF Mail Server at svn01-us-east.apache.org) with ESMTP id 1690F17A166 for ; Mon, 3 Feb 2020 21:53:40 +0000 (UTC) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r1873556 [37/48] - in /nifi/site/trunk/docs/nifi-docs: ./ components/org.apache.nifi/nifi-ambari-nar/1.11.1/ components/org.apache.nifi/nifi-ambari-nar/1.11.1/org.apache.nifi.reporting.ambari.AmbariReportingTask/ components/org.apache.nifi/... Date: Mon, 03 Feb 2020 21:53:33 -0000 To: commits@nifi.apache.org From: joewitt@apache.org X-Mailer: svnmailer-1.0.9 Message-Id: <20200203215340.1690F17A166@svn01-us-east.apache.org> Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetHTTP/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetHTTP/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetHTTP/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetHTTP/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1,2 @@ +GetHTTP

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: InvokeHTTP

Description:

Please be aware this processor is deprecated and may be removed in the near future. Use InvokeHTTP instead. Fetches data from an HTTP or HTTPS URL and writes the data to the content of a FlowFile. Once the content has been fetched, the ETag and Last Modified dates are remembered (if the web server supports these concepts). This allows the Processor to fetch new data only if the remote data has changed or until the state is cleared. That is, once the content has been fetched from the given URL, it will not be fetched again until the content on the remote server changes. Note that due to limitations on state management, stored "last modified" and etag fields never expire. If the URL in GetHttp uses Expression Language that is unbounded, there is the potential for Out of Memory Errors to occur.

Tags:

get, fetch, poll, http, https, ingest, source, input

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before enter ing a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name	Default Value	Allowable Values	Description
URL			The URL to pull from Supports Expression Language: true (will be evaluated using variable registry only)
Filename			The filename to assign to the file when pulled Supports Expression Language: true (will be evaluated using variable registry only)
SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The Controller Service to use in order to obtain an SSL Context
Username			Username required to access the URL
Password			Password required to access the URL Sensitive Property: true
Connection Timeout	30 sec		How long to wait when attempting to connect to the remote serv er before giving up
Data Timeout	30 sec		How long to wait between receiving segments of data from the remote server before giving up and discarding the partial file
User Agent			What to report as the User Agent when we connect to the remote server
Accept Content-Type			If specified, requests will only accept the provided Content-Type
Follow Redirects	false	true false	If we receive a 3xx HTTP Status Code from the server, indicates whether or not we should follow the redirect that the server specifies
Redirect Cookie Policy	default	default standard strict netscape ignore	When a HTTP server responds to a request with a redirect, this is the cookie policy used to copy cookies to the following request.
Proxy Configuration Service		Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService	Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: HTTP + AuthN
Proxy Host			The fully qualified hostname or IP address of the proxy server
Proxy Port			The port of the proxy server

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.
Name Value Description
Header Name The Expression Language to be used to populate the header value The additional headers to be sent by the processor whenever making a new HTTP request. + Setting a dynamic property name to XYZ and value to ${attribute} will result in the header 'XYZ: attribute_value' being sent to the HTTP endpoint
Supports Expression Language: true (will be evaluated using variable registry only)

Name	Value	Description
Header Name	The Expression Language to be used to populate the header value	The additional headers to be sent by the processor whenever making a new HTTP request. + Setting a dynamic property name to XYZ and value to ${attribute} will result in the header 'XYZ: attribute_value' being sent to the HTTP endpoint Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

Name	Description
success	All files are transferred to the success relationship

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
filename	The filename is set to the name of the file on the remote server
mime.type	The MIME Type of the FlowFile, as reported by the HTTP Content-Type header

State management:

Scope	Description
LOCAL	Stores Last Modified Time and ETag headers returned by server so that the same data will not be fetched multiple times.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetJMSQueue/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetJMSQueue/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetJMSQueue/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.GetJMSQueue/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1 @@ +GetJMSQueue

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: ConsumeJMS

Description:

Pulls messages from a ActiveMQ JMS Queue, creating a FlowFile for each JMS Message or bundle of messages, as configured

Tags:

jms, queue, listen, get, pull, source, consume, consumer

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name	Default Value	Allowable Values	Description
JMS Provider	ActiveMQ	ActiveMQ	The Provider used for the JMS Server
URL			The URL of the JMS Server
Destination Name			The name of the JMS Topic or queue to use
Communications Timeout	30 sec		The amount of time to wait when attempting to receive a message before giving up and assuming failure
Message Batch Size	10		The number of messages to pull/push in a single iteration of the processor
Username			Username used for authentication and authorization
Password			Password used for authentication and authorization Sensitive Property: true
SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The Controller Service to use in order to obtain an SSL Context.
Acknowledgement Mode	Client Acknowledge	Client Acknowledge Auto Acknowledge	The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.
Message Selector			The JMS Message Selector to use in order to narrow the messages that are pulled
Copy JMS Properties to Attributes	true	true false	Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name
Client ID Prefix			A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise

Relationships:

Name	Description
success	All FlowFiles are routed to success

Reads Attr ibutes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: ConsumeJMS

Description:

Pulls messages from a ActiveMQ JMS Topic, creating a FlowFile for each JMS Message or bundle of messages, as configured.

Tags:

jms, topic, subscription, durable, non-durable, listen, get, pull, source, consume, consumer

Properties:

Name	Default Value	Allowable Values	Description
JMS Provider	ActiveMQ	ActiveMQ	The Provider used for the JMS Server
URL			The URL of the JMS Server
Destination Name			The name of the JMS Topic or queue to use
Communications Timeout	30 sec		The amount of time to wait when attempting to receive a message before giving up and assuming failure
Message Batch Size	10		The number of messages to pull/push in a single iteration of the processor
Username			Username used for authentication and authorization
Password			Password used for authentication and authorization Sensitive Property: true
SSL Context Service		Controller Service API: SSLContextService Implementations: StandardSSLContextService StandardRestrictedSSLContextService	The Controller Service to use in order to obtain an SSL Context.
Acknowledgement Mode	Client Acknowledge	Client Acknowledge Auto Acknowledge	The JMS Acknowledgement Mode. Using Auto Acknowledge can cause messages to be lost on restart of NiFi but may provide better performance than Client Acknowledge.
Message Selector			The JMS Message Selector to use in order to narrow the messages that are pulled
Copy JMS Properties to Attributes	true	true false	Whether or not the JMS Message Properties should be copied to the FlowFile Attributes; if so, the attribute name will be jms.XXX, where XXX is the JMS Property name
Client ID Prefix			A human-readable ID that can be used to associate connections with yourself so that the maintainers of the JMS Server know who to contact if problems arise
Use Durable Subscription	false	true false < /ul>	If true, connections to the specified topic will use Durable Subscription so that messages are queued when we are not pulling them

Relationships:

Name	Description
success	All FlowFiles are routed to success

Reads Attributes:

None specified.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

Description:

Fetches files from an SFTP Server and creates FlowFiles from them

Tags:

sftp, get, retrieve, files, fetch, remote, ingest, source, input

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values, whether a property supports the NiFi Expression Language, and whether a property is considered "sensitive", meaning that its value will be encrypted. Before entering a value in a sensitive property, ensure that the nifi.properties file has an entry for the property nifi.sensitive.props.key.

Name	Default Value	Allowable Values	Description
Hostname			The fully qualified hostname or IP address of the remote system Supports Expression Language: true (will be evaluated using variable registry only)
Port	22		The port that the remote system is listening on for file transfers Supports Expression Language: true (will be evaluated using variable registry only)
Username			Username Supports Expression Language: true (will be evaluated using variable registry only)
Password			Password for the user account Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)
Private Key Path			The fully qualified path to the Private Key file Supports Expression Language: true (will be evaluated using variable registry only)
Private Key Passphrase			Password for the private key Sensitive Property: true Supports Expression Language: tru e (will be evaluated using variable registry only)
Remote Path			The path on the remote system from which to pull or push files Supports Expression Language: true (will be evaluated using variable registry only)
File Filter Regex			Provides a Java Regular Expression for filtering Filenames; if a filter is supplied, only files whose names match that Regular Expression will be fetched
Path Filter Regex			When Search Recursively is true, then only subdirectories whose path matches the given Regular Expression will be scanned
Polling Interval	60 sec		Determines how long to wait between fetching the listing for new files
Search Recursively	false	true false	If true, will pull files from arbitrarily nested subdirectories; otherwise, will not traverse subdirectories
Follow symlink	false	true false	If true, will pull even symbolic files and also nested symbolic subdirectories; otherwise, will not read symbolic files and will not traverse symbolic link subdirectories
Ignore Dotted Files	true	true false	If true, files whose names begin with a dot (". ") will be ignored
Delete Original	true	true false	Determines whether or not the file is deleted from the remote system after it has been successfully transferred
Connection Timeout	30 sec		Amount of time to wait before timing out while creating a connection
Data Timeout	30 sec		When transferring a file between the local and remote system, this value specifies how long is allowed to elapse without any data being transferred between systems
Host Key File			If supplied, the given f ile will be used as the Host Key; otherwise, no use host key file will be used
Max Selects	100		The maximum number of files to pull in a single connection
Remote Poll Batch Size	5000		The value specifies how many file paths to find in a given directory on the remote system when doing a file listing. This value in general should not need to be modified but when polling against a remote system with a tremendous number of files this value can be critical. Setting this value too high can result very poor performance and setting it too low can cause the flow to be slower than normal.
Strict Host Key Checking	false	true false	Indicates whether or not strict enforcement of hosts keys should be applied
Send Keep Alive On Timeout	true	true false	Indicates whether or not to send a single Keep Alive message when SSH socket times out
Use Compression	false	true false	Indicates whether or not ZLIB compression should be used when transferring files
Use Natural Ordering	false	true false	If true, will pull files in the order in which they are naturally listed; otherwise, the order in which the files will be pulled is not defined
Proxy Configuration Service		Controller Service API: ProxyConfigurationService Implementation: StandardProxyConfigurationService	Specifies the Proxy Configuration Controller Service to proxy network requests. If set, it supersedes proxy settings configured per component. Supported proxies: SOCKS + AuthN, HTTP + AuthN
Proxy Type	DIRECT	DIRECT HTTP SOCKS	Proxy type used for file transfers
Proxy Host			The fully qualified hostname or IP address of the proxy server Supports Expression Language: true (will be evaluated using variable registry only)
Proxy Port			The port of the proxy server Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy Username			Http Proxy Username Supports Expression Language: true (will be evaluated using variable registry only)
Http Proxy Password			Http Proxy Password Sensitive Property: true Supports Expression Language: true (will be evaluated using variable registry only)

Relationships:

Name	Description
success	All FlowFiles that are received are routed to success

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
filename	The filename is set to the name of the file on the remote server
path	The path is set to the path of the file's directory on the remote server. For example, if the <Remote Path> property is set to /tmp, files picked up from /tmp will have the path attribute set to /tmp. If the <Search Recursively> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to /tmp/abc/1/2/3
file.lastModifiedTime	The date and time that the source file was last modified
file.owner	The numeric owner id of the source file
file.group	The numeric group id of the sourc e file
file.permissions	The read/write/execute permissions of the source file
absolute.path	The full/absolute path from where a file was picked up. The current 'path' attribute is still populated, but may be a relative path

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

Usage Description

+ The pairing of this Processor with a HandleHttpResponse 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: +

+ +

+ HandleHttpRequest -> + PutSFTP -> + HandleHttpResponse +

+ +

+ The HandleHttpRequest Processor provides several Properties to configure which methods are supported, the paths that are + supported, and SSL configuration. +

+ +

+ To handle requests with Content-Type: multipart/form-data containing multiple parts, additional attention needs to be paid. + Each part generates a FlowFile of its own. To each these FlowFiles, some special attributes are written: +

http.context.identifier
http.multipart.fragments.sequence.number
http.multipart.fragments.total.number

+ These attributes could be used to implement a gating mechanism for HandleHttpResponse processor to wait for the processing of FlowFiles + with sequence number http.multipart.fragments.sequence.number until up to http.multipart.fragments.total.number of flow files are processed, + belonging to the same http.context.identifier, which is unique to the request. +

+ + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpRequest/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpRequest/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpRequest/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpRequest/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1 @@ +HandleHttpRequest

Description:

Starts an HTTP Server and listens for HTTP Requests. For each request, creates a FlowFile and transfers to 'success'. This Processor is designed to be used in conjunction with the HandleHttpResponse Processor in order to create a Web Service

Additional Details...

Tags:

http, https, request, listen, ingress, web service

Properties:

< td id="description">Allow HTTP PUT Method

Name	Default Value	Allowable Values	Description
Listening Port	80		The Port to listen on for incoming HTTP requests Supports Expression Language: true (will be evaluated using variable registry only)
Hostname			The Hostname to bind to. If not specified, will bind to all hosts
SSL Context Service		Controller Service API: RestrictedSSLContextService Implementation: StandardRestrictedSSLContextService	The SSL Context Service to use in order to secure the server. If specified, the server will accept only HTTPS requests; otherwise, the server will accept only HTTP requests
HTTP Context Map		Controller Service API: HttpContextMap Implementation: StandardHttpContextMap	The HTTP Context Map Controller Service to use for caching the HTTP Request Information
Allowed Paths			A Regular Expression that specifies the valid HTTP Paths that are al lowed 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
Default URL Character Set	UTF-8		The character set to use for decoding URL parameters if the HTTP Request does not supply one
Allow GET	true	true false	Allow HTTP GET Method
Allow POST	true	true false	Allow HTTP POST Method
Allow PUT	true	true false
Allow DELETE	true	true false	Allow HTTP DELETE Method
Allow HEAD	false	true false	Allow HTTP HEAD Method
Allow OPTIONS	false	true false	Allow HTTP OPTIONS Method
Additional HTTP Methods			A comma-separated list of non-standard HTTP Methods that should be allowed
Client Authentication	No Authentication	No Authentication Want Authentication Need Authentication	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.
Container Queue Size	50		The size of the queue for Http Request Containers
Multipart Request Max Size	1 MB		The max size of the request. Only applies for requests with Content-Type: multipart/form-data, and is used to prevent denial of service type of attacks, to prevent filling up the heap or disk space
Multipart Read Buffer Size	512 KB		The threshold size, at which the contents of an incoming file would be written to disk. Only applies for requests with Content-Type: multipart/form-data. It is used to prevent denial of service type of attacks, to prevent filling up the heap or disk space.

Relationships:

Name	Description
success	All content that is received is routed to the 'success' relationship

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
http.context.identifier	An identifier that allows the HandleHttpRequest and HandleHttpResponse to coordinate which FlowFile belongs to which HTTP Request/Response.
mime.type	The MIME Type of the data, according to the HTTP Header "Content-Type"
http.servlet.path	The part o f the request URL that is considered the Servlet Path
http.context.path	The part of the request URL that is considered to be the Context Path
http.method	The HTTP Method that was used for the request, such as GET or POST
http.local.name	IP address/hostname of the server
http.server.port	Listening port of the server
http.query.string	The query string portion of the Request URL
http.remote.host	The hostname of the requestor
http.remote.addr	The hostname:port combination of the requestor
http.remote.user	The username of the requestor
http.protocol	The protocol used to communicate
http.request.uri	The full Request URL
http.auth.type	The type of HTTP Authorization used
http.principal.name	The name of the authenticated user making the request
http.subject.dn	The Distinguished Name of the requestor. This value will not be populated unless the Processor is configured to use an SSLContext Service
http.issuer.dn	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
http.headers.XXX	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"
http.headers.multipart.XXX	Each of the HTTP Headers that is received in the mulipart request will be added as an attribute, prefixed with "http.headers.multipart." For example, if the multipart request contains an HTTP Header named "content-disposition", then the value will be added to an attribute named "http.headers.multipart.content-disposition"
http.multipart.size	For requests with Content-Type "multipart/form-data", the part's content size is recorded into this attribute
http.multipart.content.type	For requests with Content-Type "multipart/form-data", the part's content type is recorded into this attribute
http.multipart.name	For requests with Content-Type "multipart/form-data", the part's name is recorded into this attribute
http.multipart.filename	For requests with Content-Type "multipart/form-data", when the part contains an uploaded file, the name of the file is recorded into this attribute
http.multipart.fragments.sequence.number	For requests with Content-Type "multipart/form-data", the part's index is recorded into this attribute. The index starts with 1.
http.multipart.fragments.total.number	For requests with Content-Type "multipart/form-data", the count of all parts is recorded into this attribute.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component does not allow an incoming relationship.

System Resource Considerations:

None specified.

Usage Description:

+ The pairing of this Processor with a HandleHttpRequest 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: +

+ +

+ HandleHttpRequest -> + PutSFTP -> + HandleHttpResponse +

+ +

+ 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. +

+ + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpResponse/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpResponse/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpResponse/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HandleHttpResponse/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1 @@ +HandleHttpResponse

Description:

Sends an HTTP Response to the Requestor that generated a FlowFile. This Processor is designed to be used in conjunction with the HandleHttpRequest in order to create a web service.

Additional Details...

Tags:

http, https, response, egress, web service

Properties:

Name	Default Value	Allowable Values	Description
HTTP Status Code			The HTTP Status Code to use when responding to the HTTP Request. See Section 10 of RFC 2616 for more information. Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)
HTTP Context Map		Controller Service API: HttpContextMap Implementation: StandardHttpContextMap	The HTTP Context Map Control ler Service to use for caching the HTTP Request Information

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.
Name Value Description
An HTTP header name An HTTP header value These HTTPHeaders are set in the HTTP Response
Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Name	Value	Description
An HTTP header name	An HTTP header value	These HTTPHeaders are set in the HTTP Response Supports Expression Language: true (will be evaluated using flow file attributes and variable registry)

Relationships:

Name	Description
success	FlowFiles will be routed to this Relationship after the response has been successfully sent to the requestor
failure	FlowFiles will be routed to this Relationship if the Processor is unable to respond to the requestor. This may happen, for instance, if the connection times out or if NiFi is restar ted before responding to the HTTP Request.

Reads Attributes:

Name	Description
http.context.identifier	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.'
http.request.uri	Value of the URI requested by the client. Used for provenance event.
http.remote.host	IP address of the client. Used for provenance event.
http.local.name	IP address/hostname of the server. Used for provenance event.
http.server.port	Listening port of the server. Used for provenance event.
http.subject.dn	SSL distinguished name (if any). Used for provenance event.

Writes Attributes:

None specified.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified.

Description:

Hashes together the key/value pairs of several flowfile attributes and adds the hash as a new attribute. Optional properties are to be added such that the name of the property is the name of a flowfile attribute to consider and the value of the property is a regular expression that, if matched by the attribute value, will cause that attribute to be used as part of the hash. If the regular expression contains a capturing group, only the value of the capturing group will be used. For a processor which accepts various attributes and generates a cryptographic hash of each, see "CryptographicHashAttribute".

Tags:

attributes, hash

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Name	Default Value	Allowable Values	Description
Hash Value Attribute Key			The name of the flowfile attribute where the hash value should be stored

Dynamic Properties:

Dynamic Properties allow the user to specify both the name and value of a property.
Name Value Description
A flowfile attribute key for attribute inspection A Regular Expression This regular expression i s evaluated against the flowfile attribute values. If the regular expression contains a capturing group, the value of that group will be used when comparing flow file attributes. Otherwise, the original flow file attribute's value will be used if and only if the value matches the given regular expression.
Supports Expression Language: false

Name	Value	Description
A flowfile attribute key for attribute inspection	A Regular Expression	This regular expression i s evaluated against the flowfile attribute values. If the regular expression contains a capturing group, the value of that group will be used when comparing flow file attributes. Otherwise, the original flow file attribute's value will be used if and only if the value matches the given regular expression. Supports Expression Language: false

Relationships:

Name	Description
success	Used for flowfiles that have a hash value added
failure	Used for flowfiles that are missing required attributes

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
<Hash Value Attribute Key>	This Processor adds an attribute whose value is the result of Hashing the existing flowfile attributes. The name of this attribute is specified by the <Hash Value Attribute Key> property.

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HashContent/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HashContent/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HashContent/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.HashContent/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1 @@ +HashContent

Deprecation notice:

This processor is deprecated and may be removed in future releases.

Please consider using one the following alternatives: CryptographicHashContent

Description:

Calculates a hash value for the Content of a FlowFile and puts that hash value on the FlowFile as an attribute whose name is determined by the <Hash Attribute Name> property. This processor did not provide a consistent offering of hash algorithms, and is now deprecated. For modern cryptographic hashing capabilities, see "CryptographicHashContent".

Tags:

hash, content, MD5, SHA-1, SHA-256

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Name	Default Value	Allowable Values	Description
Hash Attribute Name	hash.value		The name of the FlowFile Attribute into which the Hash Value should be written. If the value already exists, it will be overwritten
Hash Algorithm	MD5	1.0.10118.3.0.55 SHA-1 SHA-384 SKEIN-512-256 SKEIN-1024-384 BLAKE2B-160 SHA KECCAK-288 WHIRLPOOL SKEIN-512-384 SHA-224 SM3 BLAKE2B-512 OID.1.0.10118.3.0.55 GOST3411-2012-512 KECCAK-256 SKEIN-512-128 BLAKE2B-384 SKEIN-256-160 OID.2.16.840.1.101.3.4.2.10 DSTU7564-256 SHA-256 BLAKE2S-224 SHA3-256 KECCAK-384 SKEIN-256-128 DSTU7564-384 KECCAK-224 SKEIN-512-512 SKEIN-1024-512 SKEIN-512-160 OID.1.2.804.2.1.1.1.1.2.2.3 GOST3411 1.2.804.2.1.1.1.1.2.2.3 BLAKE2B-256 OID.1.2.804.2.1.1.1.1.2.2.2 SKEIN-1024-1024 OID.1.2.804.2.1.1.1.1.2.2.1 SHA3-384 OID.2.16.840.1.101.3.4.2.9 BLAKE2S-256 SHA-512/224 OID.2.16.840.1.101.3.4.2.8 OID.2.16.840.1.101.3.4.2.7 TIGER RIPEMD256 SKEIN-256-256 SHA3-224 SHA3-512 RIPEMD320 2.16.840.1.101.3.4.2.9 RIPEMD160 GOST3411-2012-256 2.16.840.1.101.3.4.2.8 1.2.804.2.1.1.1.1.2.2.1 KECCAK-512 SKEIN-512-224 2.16.840.1.101.3.4.2.7 1.2.804.2.1.1.1.1.2.2.2 2.16.840.1.101.3.4.2.10 BLAKE2S-160 SHA-512/256 MD2 RIPEMD128 MD4 SHA-512 SKEIN-256-224 MD5 BLAKE2S-128 DSTU7564-512	Determines what hashing algorithm should be used to perform the hashing function

Relationships:

Name	Description
success	FlowFiles that are process successfully will be sent to this relationship
failure	Any FlowFile that cannot be processed successfully will be sent to this relationship without any attribute being added

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
<Hash Attribute Name>	This Processor adds an attribute whose value is the result of Hashing the existing FlowFile content. The name of this attribute is specified by the <Hash Attribute Name> property

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified. \ No newline at end of file Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/additionalDetails.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1,64 @@ + + + + + + IdentifyMimeType + + + + + +

The following is a non-exhaustive list of MIME Types detected: +

application/gzip
application/bzip2
application/flowfile-v3
application/flowfile-v1
application/xml
video/mp4
video/x-m4v
video/mp4a-latm
video/quicktime
video/mpeg
audio/wav
audio/mp3
image/bmp
image/png
image/jpg
image/gif
image/tif
application/vnd.ms-works
application/msexcel
application/mspowerpoint
application/msaccess
application/x-ms-wmv
application/pdf
application/x-rpm
application/tar
application/x-7z-compressed
application/java-archive
application/zip
application/x-lzh

For a complete list, please refer to + + Apache Tika's source code +

+ + + Added: nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/index.html URL: http://svn.apache.org/viewvc/nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/index.html?rev=1873556&view=auto ============================================================================== --- nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/index.html (added) +++ nifi/site/trunk/docs/nifi-docs/components/org.apache.nifi/nifi-standard-nar/1.11.1/org.apache.nifi.processors.standard.IdentifyMimeType/index.html Mon Feb 3 21:53:27 2020 @@ -0,0 +1 @@ +IdentifyMimeType

Description:

Attempts to identify the MIME Type used for a FlowFile. If the MIME Type can be identified, an attribute with the name 'mime.type' is added with the value being the MIME Type. If the MIME Type cannot be determined, the value will be set to 'application/octet-stream'. In addition, the attribute mime.extension will be set if a common file extension for the MIME Type is known.

Additional Details...

Tags:

compression, gzip, bzip2, zip, MIME, mime.type, file, identify

Properties:

In the list below, the names of required properties appear in bold. Any other properties (not in bold) are considered optional. The table also indicates any default values.

Name	Default Value	Allowable Values	Description
Use Filename In Detection	true	true false	If true will pass the filename to Tika to aid in detection.

Relationships:

Name	Description
success	All FlowFiles are routed to success

Reads Attributes:

None specified.

Writes Attributes:

Name	Description
mime.type	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 application/octet-stream

State management:

This component does not store state.

Restricted:

This component is not restricted.

Input requirement:

This component requires an incoming relationship.

System Resource Considerations:

None specified. \ No newline at end of file

GetHTTP

Deprecation notice:

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

GetJMSQueue

Deprecation notice:

Description:

Tags:

Properties:

Relationships:

Reads Attr ibutes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

See Also:

GetJMSTopic

Deprecation notice:

Description:

Tags:

Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

See Also:

GetSFTP

Description:

Tags:

Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

See Also:

Usage Description

HandleHttpRequest

Description:

Tags:

Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

See Also:

Usage Description:

HandleHttpResponse

Description:

Tags:

Properties:

Dynamic Properties:

Relationships:

Reads Attributes:

Writes Attributes:

State management:

Restricted:

Input requirement:

System Resource Considerations:

See Also:

HashAttribute

Description: