ListenHTTP 2.4.0

Bundle
org.apache.nifi | nifi-standard-nar
Description
Starts an HTTP Server and listens on a given base path to transform incoming requests into FlowFiles. The default URI of the Service will be http://{hostname}:{port}/contentListener. Only HEAD and POST requests are supported. GET, PUT, DELETE, OPTIONS and TRACE will result in an error and the HTTP response status code 405; CONNECT will also result in an error and the HTTP response status code 400. GET is supported on <service_URI>/healthcheck. If the service is available, it returns "200 OK" with the content "OK". The health check functionality can be configured to be accessible via a different port. For details see the documentation of the "Listening Port for health check requests" property. A Record Reader and Record Writer property can be enabled on the processor to process incoming requests as records. Record processing is not allowed for multipart requests and request in FlowFileV3 format (minifi).
Tags
http, https, ingest, listen, rest
Input Requirement
FORBIDDEN
Supports Sensitive Dynamic Properties
false
Properties
Relationships
Name Description
success Relationship for successfully received FlowFiles
Use Cases
  • Unpack FlowFileV3 content received in a POST
    Description
    Unpack FlowFileV3 content received in a POST
    Notes
    POST requests with "Content-Type: application/flowfile-v3" will have their payload interpreted as FlowFileV3 format and will be automatically unpacked. This will output the original FlowFile(s) from within the FlowFileV3 format and will not require a separate UnpackContent processor.
    Keywords
    flowfile, flowfilev3, unpack
    Configuration
    This feature of ListenHTTP is always on, no configuration required.

The MergeContent and PackageFlowFile processors can generate FlowFileV3 formatted data.
Use Cases Involving Other Components
  • Limit the date flow rate that is accepted
    Description
    Limit the date flow rate that is accepted
    Notes
    When ListenHTTP cannot output FlowFiles due to back pressure, it will send HTTP 503 Service Unavailable response to clients, or deny connections, until more space is available in the output queue.
    Keywords
    rate, limit
    Processor Configurations
    org.apache.nifi.processors.standard.ListenHTTP
    Connect the 'success' relationship of ListenHTTP to a ControlRate processor and configure back pressure on that
connection so that a small amount of data will fill the queue. The size of the back pressure configuration
determines how much data to buffer to handle spikes in rate without affecting clients.
    org.apache.nifi.processors.standard.ControlRate
    Use the ControlRate properties to set the desired data flow rate limit. When the limit it reached,
the ControlRate input connection will start accumulating files. When this connection is full, ListenHTTP
will limit the input data flow rate.