org.apache.nifi.processors.standard

Class HandleHttpRequest

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.HandleHttpRequest

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"http","https","request","listen","ingress","web service"})
 @CapabilityDescription(value="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. In case  of a multipart request, one FlowFile is generated for each part.")
 @WritesAttribute(attribute="http.context.identifier",description="An identifier that allows the HandleHttpRequest and HandleHttpResponse to coordinate which FlowFile belongs to which HTTP Request/Response.") @WritesAttribute(attribute="mime.type",description="The MIME Type of the data, according to the HTTP Header \"Content-Type\"") @WritesAttribute(attribute="http.servlet.path",description="The part of the request URL that is considered the Servlet Path") @WritesAttribute(attribute="http.context.path",description="The part of the request URL that is considered to be the Context Path") @WritesAttribute(attribute="http.method",description="The HTTP Method that was used for the request, such as GET or POST") @WritesAttribute(attribute="http.local.name",description="IP address/hostname of the server") @WritesAttribute(attribute="http.server.port",description="Listening port of the server") @WritesAttribute(attribute="http.query.string",description="The query string portion of the Request URL") @WritesAttribute(attribute="http.remote.host",description="The hostname of the requestor") @WritesAttribute(attribute="http.remote.addr",description="The hostname:port combination of the requestor") @WritesAttribute(attribute="http.remote.user",description="The username of the requestor") @WritesAttribute(attribute="http.protocol",description="The protocol used to communicate") @WritesAttribute(attribute="http.request.uri",description="The full Request URL") @WritesAttribute(attribute="http.auth.type",description="The type of HTTP Authorization used") @WritesAttribute(attribute="http.principal.name",description="The name of the authenticated user making the request") @WritesAttribute(attribute="http.query.param.XXX",description="Each of query parameters in the request will be added as an attribute, prefixed with \"http.query.param.\"") @WritesAttribute(attribute="http.param.XXX",description="Form parameters in the request that are configured by \"Parameters to Attributes List\" will be added as an attribute, prefixed with \"http.param.\". Putting form parameters of large size is not recommended.") @WritesAttribute(attribute="http.subject.dn",description="The Distinguished Name of the requestor. This value will not be populated unless the Processor is configured to use an SSLContext Service") @WritesAttribute(attribute="http.issuer.dn",description="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") @WritesAttribute(attribute="http.headers.XXX",description="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\"") @WritesAttribute(attribute="http.headers.multipart.XXX",description="Each of the HTTP Headers that is received in the multipart 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\"") @WritesAttribute(attribute="http.multipart.size",description="For requests with Content-Type \"multipart/form-data\", the part\'s content size is recorded into this attribute") @WritesAttribute(attribute="http.multipart.content.type",description="For requests with Content-Type \"multipart/form-data\", the part\'s content type is recorded into this attribute") @WritesAttribute(attribute="http.multipart.name",description="For requests with Content-Type \"multipart/form-data\", the part\'s name is recorded into this attribute") @WritesAttribute(attribute="http.multipart.filename",description="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. Files are stored temporarily at the default temporary-file directory specified in \"java.io.File\" Java Docs)") @WritesAttribute(attribute="http.multipart.fragments.sequence.number",description="For requests with Content-Type \"multipart/form-data\", the part\'s index is recorded into this attribute. The index starts with 1.") @WritesAttribute(attribute="http.multipart.fragments.total.number",description="For requests with Content-Type \"multipart/form-data\", the count of all parts is recorded into this attribute.")
 @SeeAlso(value=HandleHttpResponse.class)
public class HandleHttpRequest
extends AbstractProcessor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	HandleHttpRequest.HttpRequestContainer

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	ADDITIONAL_METHODS
static PropertyDescriptor	ALLOW_DELETE
static PropertyDescriptor	ALLOW_GET
static PropertyDescriptor	ALLOW_HEAD
static PropertyDescriptor	ALLOW_OPTIONS
static PropertyDescriptor	ALLOW_POST
static PropertyDescriptor	ALLOW_PUT
static PropertyDescriptor	CLIENT_AUTH
static AllowableValue	CLIENT_NEED
static AllowableValue	CLIENT_NONE
static AllowableValue	CLIENT_WANT
static PropertyDescriptor	CONTAINER_QUEUE_SIZE
private BlockingQueue<HandleHttpRequest.HttpRequestContainer>	containerQueue
static PropertyDescriptor	HOSTNAME
static PropertyDescriptor	HTTP_CONTEXT_MAP
static PropertyDescriptor	HTTP_PROTOCOL_STRATEGY
private AtomicBoolean	initialized
static PropertyDescriptor	MAXIMUM_THREADS
private static String	MIME_TYPE__MULTIPART_FORM_DATA
static PropertyDescriptor	MULTIPART_READ_BUFFER_SIZE
static PropertyDescriptor	MULTIPART_REQUEST_MAX_SIZE
static PropertyDescriptor	PARAMETERS_TO_ATTRIBUTES
private AtomicReference<Set<String>>	parameterToAttributesReference
static PropertyDescriptor	PATH_REGEX
static PropertyDescriptor	PORT
private static List<PropertyDescriptor>	propertyDescriptors
private boolean	ready
static Relationship	REL_SUCCESS
private AtomicBoolean	runOnPrimary
private org.eclipse.jetty.server.Server	server
static PropertyDescriptor	SSL_CONTEXT
static PropertyDescriptor	URL_CHARACTER_SET
private static Pattern	URL_QUERY_PARAM_DELIMITER

Constructor Summary

Constructors

Constructor and Description
HandleHttpRequest()

Method Summary

Modifier and Type	Method and Description
void	clearInit()
private org.eclipse.jetty.server.Server	createServer(ProcessContext context)
(package private) void	drainContainerQueue()
private void	forwardFlowFile(ProcessSession session, long start, javax.servlet.http.HttpServletRequest request, FlowFile flowFile)
protected int	getPort()
Set<Relationship>	getRelationships()
protected int	getRequestQueueSize()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	handleFlowContentStreamingError(ProcessSession session, HandleHttpRequest.HttpRequestContainer container, Optional<FlowFile> flowFile, Exception e)
(package private) void	initializeServer(ProcessContext context)
void	onPrimaryNodeChange(PrimaryNodeState state)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	putAttribute(Map<String,String> map, String key, Object value)
private void	putAttribute(Map<String,String> map, String key, String value)
private boolean	registerRequest(ProcessContext context, ProcessSession session, HandleHttpRequest.HttpRequestContainer container, FlowFile flowFile)
private FlowFile	savePartAttributes(ProcessSession session, javax.servlet.http.Part part, FlowFile flowFile, int i, int allPartsCount)
private FlowFile	saveRequestAttributes(ProcessContext context, ProcessSession session, javax.servlet.http.HttpServletRequest request, FlowFile flowFile, String contextIdentifier)
private void	sendError(int statusCode, String message, HandleHttpRequest.HttpRequestContainer container)
private void	sendError(int statusCode, String message, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	shutdown()

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

onTrigger

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

customValidate, 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

MIME_TYPE__MULTIPART_FORM_DATA

private static final String MIME_TYPE__MULTIPART_FORM_DATA

See Also:

Constant Field Values

URL_QUERY_PARAM_DELIMITER

private static final Pattern URL_QUERY_PARAM_DELIMITER

CLIENT_NONE

public static final AllowableValue CLIENT_NONE

CLIENT_WANT

public static final AllowableValue CLIENT_WANT

CLIENT_NEED

public static final AllowableValue CLIENT_NEED

PORT

public static final PropertyDescriptor PORT

HOSTNAME

public static final PropertyDescriptor HOSTNAME

HTTP_CONTEXT_MAP

public static final PropertyDescriptor HTTP_CONTEXT_MAP

SSL_CONTEXT

public static final PropertyDescriptor SSL_CONTEXT

HTTP_PROTOCOL_STRATEGY

public static final PropertyDescriptor HTTP_PROTOCOL_STRATEGY

URL_CHARACTER_SET

public static final PropertyDescriptor URL_CHARACTER_SET

PATH_REGEX

public static final PropertyDescriptor PATH_REGEX

ALLOW_GET

public static final PropertyDescriptor ALLOW_GET

ALLOW_POST

public static final PropertyDescriptor ALLOW_POST

ALLOW_PUT

public static final PropertyDescriptor ALLOW_PUT

ALLOW_DELETE

public static final PropertyDescriptor ALLOW_DELETE

ALLOW_HEAD

public static final PropertyDescriptor ALLOW_HEAD

ALLOW_OPTIONS

public static final PropertyDescriptor ALLOW_OPTIONS

MAXIMUM_THREADS

public static final PropertyDescriptor MAXIMUM_THREADS

ADDITIONAL_METHODS

public static final PropertyDescriptor ADDITIONAL_METHODS

PARAMETERS_TO_ATTRIBUTES

public static final PropertyDescriptor PARAMETERS_TO_ATTRIBUTES

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

CONTAINER_QUEUE_SIZE

public static final PropertyDescriptor CONTAINER_QUEUE_SIZE

MULTIPART_REQUEST_MAX_SIZE

public static final PropertyDescriptor MULTIPART_REQUEST_MAX_SIZE

MULTIPART_READ_BUFFER_SIZE

public static final PropertyDescriptor MULTIPART_READ_BUFFER_SIZE

REL_SUCCESS

public static final Relationship REL_SUCCESS

propertyDescriptors

private static final List<PropertyDescriptor> propertyDescriptors

server

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

ready

private volatile boolean ready

containerQueue

private volatile BlockingQueue<HandleHttpRequest.HttpRequestContainer> containerQueue

initialized

private final AtomicBoolean initialized

runOnPrimary

private final AtomicBoolean runOnPrimary

parameterToAttributesReference

private final AtomicReference<Set<String>> parameterToAttributesReference

Constructor Detail

HandleHttpRequest

public HandleHttpRequest()

Method Detail

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

clearInit

@OnScheduled
public void clearInit()

initializeServer

void initializeServer(ProcessContext context)
               throws Exception

Throws:

Exception

getPort

protected int getPort()

getRequestQueueSize

protected int getRequestQueueSize()

shutdown

@OnUnscheduled
public void shutdown()
                             throws Exception

Throws:

Exception

drainContainerQueue

void drainContainerQueue()

onPrimaryNodeChange

@OnPrimaryNodeStateChange
public void onPrimaryNodeChange(PrimaryNodeState state)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

savePartAttributes

private FlowFile savePartAttributes(ProcessSession session,
                                    javax.servlet.http.Part part,
                                    FlowFile flowFile,
                                    int i,
                                    int allPartsCount)

saveRequestAttributes

private FlowFile saveRequestAttributes(ProcessContext context,
                                       ProcessSession session,
                                       javax.servlet.http.HttpServletRequest request,
                                       FlowFile flowFile,
                                       String contextIdentifier)

forwardFlowFile

private void forwardFlowFile(ProcessSession session,
                             long start,
                             javax.servlet.http.HttpServletRequest request,
                             FlowFile flowFile)

registerRequest

private boolean registerRequest(ProcessContext context,
                                ProcessSession session,
                                HandleHttpRequest.HttpRequestContainer container,
                                FlowFile flowFile)

handleFlowContentStreamingError

protected void handleFlowContentStreamingError(ProcessSession session,
                                               HandleHttpRequest.HttpRequestContainer container,
                                               Optional<FlowFile> flowFile,
                                               Exception e)

putAttribute

private void putAttribute(Map<String,String> map,
                          String key,
                          Object value)

putAttribute

private void putAttribute(Map<String,String> map,
                          String key,
                          String value)

sendError

private void sendError(int statusCode,
                       String message,
                       HandleHttpRequest.HttpRequestContainer container)

sendError

private void sendError(int statusCode,
                       String message,
                       javax.servlet.http.HttpServletRequest request,
                       javax.servlet.http.HttpServletResponse response)

createServer

private org.eclipse.jetty.server.Server createServer(ProcessContext context)