org.apache.nifi.processors.standard

Class ListenHTTP

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processors.standard.ListenHTTP

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"ingest","http","https","rest","listen"})
 @CapabilityDescription(value="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, and DELETE will result in an error and the HTTP response status code 405. 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).")
public class ListenHTTP
extends AbstractSessionFactoryProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListenHTTP.ClientAuthentication
static class	ListenHTTP.FlowFileEntryTimeWrapper

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	AUTHORIZED_DN_PATTERN
static PropertyDescriptor	AUTHORIZED_ISSUER_DN_PATTERN
static PropertyDescriptor	BASE_PATH
static PropertyDescriptor	CLIENT_AUTHENTICATION
static String	CONTEXT_ATTRIBUTE_AUTHORITY_ISSUER_PATTERN
static String	CONTEXT_ATTRIBUTE_AUTHORITY_PATTERN
static String	CONTEXT_ATTRIBUTE_BASE_PATH
static String	CONTEXT_ATTRIBUTE_FLOWFILE_MAP
static String	CONTEXT_ATTRIBUTE_HEADER_PATTERN
static String	CONTEXT_ATTRIBUTE_LOGGER
static String	CONTEXT_ATTRIBUTE_MULTIPART_READ_BUFFER_SIZE
static String	CONTEXT_ATTRIBUTE_MULTIPART_REQUEST_MAX_SIZE
static String	CONTEXT_ATTRIBUTE_PORT
static String	CONTEXT_ATTRIBUTE_PROCESS_CONTEXT_HOLDER
static String	CONTEXT_ATTRIBUTE_PROCESSOR
static String	CONTEXT_ATTRIBUTE_RETURN_CODE
static String	CONTEXT_ATTRIBUTE_SESSION_FACTORY_HOLDER
static String	CONTEXT_ATTRIBUTE_STREAM_THROTTLER
private ConcurrentMap<String,ListenHTTP.FlowFileEntryTimeWrapper>	flowFileMap
static PropertyDescriptor	HEADERS_AS_ATTRIBUTES_REGEX
static PropertyDescriptor	HEALTH_CHECK_PORT
static PropertyDescriptor	HTTP_PROTOCOL_STRATEGY
private AtomicBoolean	initialized
private static String	MATCH_ALL
static PropertyDescriptor	MAX_DATA_RATE
static PropertyDescriptor	MAX_THREAD_POOL_SIZE
static PropertyDescriptor	MAX_UNCONFIRMED_TIME
static PropertyDescriptor	MULTIPART_READ_BUFFER_SIZE
static PropertyDescriptor	MULTIPART_REQUEST_MAX_SIZE
static PropertyDescriptor	PORT
protected static List<PropertyDescriptor>	PROPERTIES
static PropertyDescriptor	RECORD_READER
static PropertyDescriptor	RECORD_WRITER
static Relationship	RELATIONSHIP_SUCCESS
private static Set<Relationship>	RELATIONSHIPS
static PropertyDescriptor	RETURN_CODE
private AtomicBoolean	runOnPrimary
private org.eclipse.jetty.server.Server	server
private AtomicReference<ProcessSessionFactory>	sessionFactoryReference
static PropertyDescriptor	SSL_CONTEXT_SERVICE
private AtomicReference<StreamThrottler>	throttlerRef

Constructor Summary

Constructors

Constructor and Description
ListenHTTP()

Method Summary

Modifier and Type	Method and Description
void	clearInit()
private void	createHttpServerFromService(ProcessContext context)
private org.eclipse.jetty.server.ServerConnector	createServerConnector(org.eclipse.jetty.server.Server server, int port, SSLContextService sslContextService, ListenHTTP.ClientAuthentication clientAuthentication, HttpProtocolStrategy httpProtocolStrategy)
private ValidationResult	createValidationResult(String subject, String explanation)
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
private Set<String>	findOldFlowFileIds(ProcessContext ctx)
private ListenHTTP.ClientAuthentication	getClientAuthentication(SSLContextService sslContextService, PropertyValue clientAuthenticationProperty)
Set<Relationship>	getRelationships()
(package private) org.eclipse.jetty.server.Server	getServer()
protected Set<Class<? extends javax.servlet.Servlet>>	getServerClasses()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onPrimaryNodeChange(PrimaryNodeState newState)
void	onTrigger(ProcessContext context, ProcessSessionFactory sessionFactory)
void	shutdownHttpServer()
private void	shutdownHttpServer(org.eclipse.jetty.server.Server toShutdown)
private void	validatePortsAreNotEqual(ValidationContext context, Collection<ValidationResult> validationResults)

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, init, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

MATCH_ALL

private static final String MATCH_ALL

See Also:

Constant Field Values

initialized

private final AtomicBoolean initialized

runOnPrimary

private final AtomicBoolean runOnPrimary

RELATIONSHIP_SUCCESS

public static final Relationship RELATIONSHIP_SUCCESS

BASE_PATH

public static final PropertyDescriptor BASE_PATH

PORT

public static final PropertyDescriptor PORT

HEALTH_CHECK_PORT

public static final PropertyDescriptor HEALTH_CHECK_PORT

AUTHORIZED_DN_PATTERN

public static final PropertyDescriptor AUTHORIZED_DN_PATTERN

AUTHORIZED_ISSUER_DN_PATTERN

public static final PropertyDescriptor AUTHORIZED_ISSUER_DN_PATTERN

MAX_UNCONFIRMED_TIME

public static final PropertyDescriptor MAX_UNCONFIRMED_TIME

MAX_DATA_RATE

public static final PropertyDescriptor MAX_DATA_RATE

SSL_CONTEXT_SERVICE

public static final PropertyDescriptor SSL_CONTEXT_SERVICE

HTTP_PROTOCOL_STRATEGY

public static final PropertyDescriptor HTTP_PROTOCOL_STRATEGY

HEADERS_AS_ATTRIBUTES_REGEX

public static final PropertyDescriptor HEADERS_AS_ATTRIBUTES_REGEX

RETURN_CODE

public static final PropertyDescriptor RETURN_CODE

MULTIPART_REQUEST_MAX_SIZE

public static final PropertyDescriptor MULTIPART_REQUEST_MAX_SIZE

MULTIPART_READ_BUFFER_SIZE

public static final PropertyDescriptor MULTIPART_READ_BUFFER_SIZE

CLIENT_AUTHENTICATION

public static final PropertyDescriptor CLIENT_AUTHENTICATION

MAX_THREAD_POOL_SIZE

public static final PropertyDescriptor MAX_THREAD_POOL_SIZE

RECORD_READER

public static final PropertyDescriptor RECORD_READER

RECORD_WRITER

public static final PropertyDescriptor RECORD_WRITER

PROPERTIES

protected static final List<PropertyDescriptor> PROPERTIES

RELATIONSHIPS

private static final Set<Relationship> RELATIONSHIPS

CONTEXT_ATTRIBUTE_PROCESSOR

public static final String CONTEXT_ATTRIBUTE_PROCESSOR

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_LOGGER

public static final String CONTEXT_ATTRIBUTE_LOGGER

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_SESSION_FACTORY_HOLDER

public static final String CONTEXT_ATTRIBUTE_SESSION_FACTORY_HOLDER

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_PROCESS_CONTEXT_HOLDER

public static final String CONTEXT_ATTRIBUTE_PROCESS_CONTEXT_HOLDER

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_AUTHORITY_PATTERN

public static final String CONTEXT_ATTRIBUTE_AUTHORITY_PATTERN

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_AUTHORITY_ISSUER_PATTERN

public static final String CONTEXT_ATTRIBUTE_AUTHORITY_ISSUER_PATTERN

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_HEADER_PATTERN

public static final String CONTEXT_ATTRIBUTE_HEADER_PATTERN

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_FLOWFILE_MAP

public static final String CONTEXT_ATTRIBUTE_FLOWFILE_MAP

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_STREAM_THROTTLER

public static final String CONTEXT_ATTRIBUTE_STREAM_THROTTLER

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_BASE_PATH

public static final String CONTEXT_ATTRIBUTE_BASE_PATH

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_RETURN_CODE

public static final String CONTEXT_ATTRIBUTE_RETURN_CODE

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_MULTIPART_REQUEST_MAX_SIZE

public static final String CONTEXT_ATTRIBUTE_MULTIPART_REQUEST_MAX_SIZE

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_MULTIPART_READ_BUFFER_SIZE

public static final String CONTEXT_ATTRIBUTE_MULTIPART_READ_BUFFER_SIZE

See Also:

Constant Field Values

CONTEXT_ATTRIBUTE_PORT

public static final String CONTEXT_ATTRIBUTE_PORT

See Also:

Constant Field Values

server

private volatile org.eclipse.jetty.server.Server server

flowFileMap

private final ConcurrentMap<String,ListenHTTP.FlowFileEntryTimeWrapper> flowFileMap

sessionFactoryReference

private final AtomicReference<ProcessSessionFactory> sessionFactoryReference

throttlerRef

private final AtomicReference<StreamThrottler> throttlerRef

Constructor Detail

ListenHTTP

public ListenHTTP()

Method Detail

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

validatePortsAreNotEqual

private void validatePortsAreNotEqual(ValidationContext context,
                                      Collection<ValidationResult> validationResults)

createValidationResult

private ValidationResult createValidationResult(String subject,
                                                String explanation)

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

shutdownHttpServer

@OnStopped
public void shutdownHttpServer()

getServer

org.eclipse.jetty.server.Server getServer()

shutdownHttpServer

private void shutdownHttpServer(org.eclipse.jetty.server.Server toShutdown)

createHttpServerFromService

private void createHttpServerFromService(ProcessContext context)
                                  throws Exception

Throws:

Exception

getClientAuthentication

private ListenHTTP.ClientAuthentication getClientAuthentication(SSLContextService sslContextService,
                                                                PropertyValue clientAuthenticationProperty)

createServerConnector

private org.eclipse.jetty.server.ServerConnector createServerConnector(org.eclipse.jetty.server.Server server,
                                                                       int port,
                                                                       SSLContextService sslContextService,
                                                                       ListenHTTP.ClientAuthentication clientAuthentication,
                                                                       HttpProtocolStrategy httpProtocolStrategy)

clearInit

@OnScheduled
public void clearInit()

getServerClasses

protected Set<Class<? extends javax.servlet.Servlet>> getServerClasses()

findOldFlowFileIds

private Set<String> findOldFlowFileIds(ProcessContext ctx)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSessionFactory sessionFactory)
               throws ProcessException

Throws:

ProcessException

onPrimaryNodeChange

@OnPrimaryNodeStateChange
public void onPrimaryNodeChange(PrimaryNodeState newState)