org.apache.nifi.http

Class StandardHttpContextMap

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

org.apache.nifi.http.StandardHttpContextMap

All Implemented Interfaces:

ConfigurableComponent, ControllerService, HttpContextMap

@Tags(value={"http","request","response"})
 @SeeAlso(classNames={"org.apache.nifi.processors.standard.HandleHttpRequest","org.apache.nifi.processors.standard.HandleHttpResponse"})
 @CapabilityDescription(value="Provides the ability to store and retrieve HTTP requests and responses external to a Processor, so that multiple Processors can interact with the same HTTP request.")
public class StandardHttpContextMap
extends AbstractControllerService
implements HttpContextMap

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	MAX_OUTSTANDING_REQUESTS
static PropertyDescriptor	REQUEST_EXPIRATION

Constructor Summary

Constructors

Constructor and Description
StandardHttpContextMap()

Method Summary

Modifier and Type	Method and Description
void	cleanup()
void	complete(java.lang.String identifier) Marks the HTTP request/response for the given identifier as complete
javax.servlet.http.HttpServletResponse	getResponse(java.lang.String identifier) Retrieves the HttpServletResponse for the given identifier, if it exists
protected java.util.List<PropertyDescriptor>	getSupportedPropertyDescriptors() Allows subclasses to register which property descriptor objects are supported.
void	onConfigured(ConfigurationContext context)
boolean	register(java.lang.String identifier, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, javax.servlet.AsyncContext context) Registers an HttpServletRequest, HttpServletResponse, and the AsyncContext for a given identifier

Methods inherited from class org.apache.nifi.controller.AbstractControllerService

abstractClearConfigContext, abstractStoreConfigContext, disabled, enabled, getConfigurationContext, getControllerServiceLookup, getIdentifier, getLogger, getProperty, getStateManager, init, initialize, isEnabled

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

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.controller.ControllerService

initialize

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

MAX_OUTSTANDING_REQUESTS

public static final PropertyDescriptor MAX_OUTSTANDING_REQUESTS

REQUEST_EXPIRATION

public static final PropertyDescriptor REQUEST_EXPIRATION

Constructor Detail

StandardHttpContextMap

public StandardHttpContextMap()

Method Detail

getSupportedPropertyDescriptors

protected java.util.List<PropertyDescriptor> getSupportedPropertyDescriptors()

Description copied from class: AbstractConfigurableComponent

Allows subclasses to register which property descriptor objects are supported. Default return is an empty set.

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

Returns:

PropertyDescriptor objects this processor currently supports

onConfigured

@OnEnabled
public void onConfigured(ConfigurationContext context)

cleanup

@OnShutdown
 @OnDisabled
public void cleanup()

register

public boolean register(java.lang.String identifier,
                        javax.servlet.http.HttpServletRequest request,
                        javax.servlet.http.HttpServletResponse response,
                        javax.servlet.AsyncContext context)

Description copied from interface: HttpContextMap

Registers an HttpServletRequest, HttpServletResponse, and the AsyncContext for a given identifier

Specified by:

register in interface HttpContextMap

Parameters:

identifier - identifier

request - request

response - response

context - context

Returns:

true if register is successful, false if the context map is too full because too many requests have already been received and not processed

getResponse

public javax.servlet.http.HttpServletResponse getResponse(java.lang.String identifier)

Description copied from interface: HttpContextMap

Retrieves the HttpServletResponse for the given identifier, if it exists

Specified by:

getResponse in interface HttpContextMap

Parameters:

identifier - identifier

Returns:

the HttpServletResponse for the given identifier, or null if it does not exist

complete

public void complete(java.lang.String identifier)

Description copied from interface: HttpContextMap

Marks the HTTP request/response for the given identifier as complete

Specified by:

complete in interface HttpContextMap

Parameters:

identifier - identifier