org.apache.nifi.http

Interface HttpContextMap

All Superinterfaces:

ConfigurableComponent, ControllerService

public interface HttpContextMap
extends ControllerService

An interface that provides the capability of receiving an HTTP servlet request in one component and responding to that request in another component.

The intended flow is for the component receiving the HTTP request to register the request, response, and AsyncContext with a particular identifier via the register(String, HttpServletRequest, HttpServletResponse, AsyncContext) method. Another component is then able to obtain the response by providing that identifier to the getResponse(String) method. After writing to the HttpServletResponse, the transaction is to then be completed via the complete(String) method.

Method Summary

Modifier and Type	Method and Description
void	complete(String identifier) Marks the HTTP request/response for the given identifier as complete
long	getRequestTimeout(TimeUnit timeUnit) Returns the configured timeout for HTTP Requests
javax.servlet.http.HttpServletResponse	getResponse(String identifier) Retrieves the HttpServletResponse for the given identifier, if it exists
boolean	register(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 interface org.apache.nifi.controller.ControllerService

initialize, isStateful

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

register

boolean register(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

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

Throws:

IllegalStateException - if the identifier is already registered

getResponse

javax.servlet.http.HttpServletResponse getResponse(String identifier)

Retrieves the HttpServletResponse for the given identifier, if it exists

Parameters:

identifier - identifier

Returns:

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

complete

void complete(String identifier)

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

Parameters:

identifier - identifier

Throws:

IllegalStateException - if the identifier is not registered to a valid AsyncContext

getRequestTimeout

long getRequestTimeout(TimeUnit timeUnit)

Returns the configured timeout for HTTP Requests

Parameters:

timeUnit - the desired time unit

Returns:

the configured timeout for HTTP Requests