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")
 @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.query.string",description="The query string portion of hte 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.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.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\"")
 @SeeAlso(value=HandleHttpResponse.class,
         classNames={"org.apache.nifi.http.StandardHttpContextMap","org.apache.nifi.ssl.StandardSSLContextService"})
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
private BlockingQueue<HandleHttpRequest.HttpRequestContainer>	containerQueue
static PropertyDescriptor	HOSTNAME
static String	HTTP_CONTEXT_ID
static PropertyDescriptor	HTTP_CONTEXT_MAP
private AtomicBoolean	initialized
static PropertyDescriptor	PATH_REGEX
static PropertyDescriptor	PORT
static Relationship	REL_SUCCESS
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.util.ssl.SslContextFactory	createSslFactory(SSLContextService sslService, boolean needClientAuth, boolean wantClientAuth)
protected int	getPort()
Set<Relationship>	getRelationships()
protected int	getRequestQueueSize()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
private void	initializeServer(ProcessContext context)
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)
void	shutdown()

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

onTrigger

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

getControllerServiceLookup, getIdentifier, getLogger, init, initialize, isScheduled, toString, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

HTTP_CONTEXT_ID

public static final String HTTP_CONTEXT_ID

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

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

ADDITIONAL_METHODS

public static final PropertyDescriptor ADDITIONAL_METHODS

CLIENT_AUTH

public static final PropertyDescriptor CLIENT_AUTH

REL_SUCCESS

public static final Relationship REL_SUCCESS

server

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

initialized

private AtomicBoolean initialized

containerQueue

private final BlockingQueue<HandleHttpRequest.HttpRequestContainer> containerQueue

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

private void initializeServer(ProcessContext context)
                       throws Exception

Throws:

Exception

getPort

protected int getPort()

getRequestQueueSize

protected int getRequestQueueSize()

createSslFactory

private org.eclipse.jetty.util.ssl.SslContextFactory createSslFactory(SSLContextService sslService,
                                                                      boolean needClientAuth,
                                                                      boolean wantClientAuth)

shutdown

@OnStopped
public void shutdown()
                         throws Exception

Throws:

Exception

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

putAttribute

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

putAttribute

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