org.apache.nifi.web.api

Class ApplicationResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

Direct Known Subclasses:

BulletinBoardResource, ClusterResource, ConnectionResource, ControllerResource, FunnelResource, HistoryResource, InputPortResource, LabelResource, NodeResource, OutputPortResource, ProcessGroupResource, ProcessorResource, ProvenanceResource, RemoteProcessGroupResource, SnippetResource, SystemDiagnosticsResource, TemplateResource, UserGroupResource, UserResource

public abstract class ApplicationResource
extends Object

Base class for controllers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLIENT_ID
private static int	CLUSTER_CONTEXT_HEADER_VALUE_MAX_BYTES
static String	CLUSTER_CONTEXT_HTTP_HEADER
private static int	HEADER_BUFFER_SIZE
private com.sun.jersey.api.core.HttpContext	httpContext
private javax.servlet.http.HttpServletRequest	httpServletRequest
private static org.slf4j.Logger	logger
static String	PROXIED_ENTITIES_CHAIN_HTTP_HEADER
static String	PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER
static String	PROXY_CONTEXT_PATH_HTTP_HEADER
static String	PROXY_HOST_HTTP_HEADER
static String	PROXY_PORT_HTTP_HEADER
static String	PROXY_SCHEME_HTTP_HEADER
private javax.ws.rs.core.UriInfo	uriInfo
static String	VERSION

Constructor Summary

Constructors

Constructor and Description
ApplicationResource()

Method Summary

Methods

Modifier and Type	Method and Description
protected javax.ws.rs.core.Response.ResponseBuilder	clusterContext(javax.ws.rs.core.Response.ResponseBuilder response) If the application is operating as a node, then this method adds the cluster context information to the response using the response header 'X-CLUSTER_CONTEXT'.
private void	createBatchedActionLogStatement(StringBuilder strb, Collection<Action> actions)
protected javax.ws.rs.core.Response.ResponseBuilder	generateContinueResponse() Generates a 150 Node Continue response to be used within the cluster request handshake.
protected javax.ws.rs.core.Response.ResponseBuilder	generateCreatedResponse(URI uri, Object entity) Generates a 201 Created response with the specified content.
protected javax.ws.rs.core.Response.ResponseBuilder	generateOkResponse() Generates an Ok response with no content.
protected javax.ws.rs.core.Response.ResponseBuilder	generateOkResponse(Object entity) Generates an Ok response with the specified content.
protected String	generateResourceUri(String... path) Generate a resource uri based off of the specified parameters.
protected URI	getAbsolutePath()
protected ClusterContext	getClusterContextFromRequest()
protected Map<String,String>	getHeaders()
protected Map<String,String>	getHeaders(Map<String,String> overriddenHeaders)
protected javax.ws.rs.core.MultivaluedMap<String,String>	getRequestParameters()
protected javax.ws.rs.core.MultivaluedMap<String,String>	getRequestParameters(boolean forceClientId)
protected javax.ws.rs.core.Response.ResponseBuilder	noCache(javax.ws.rs.core.Response.ResponseBuilder response) Edit the response headers to indicating no caching.
protected Entity	updateClientId(Entity entity)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

VERSION

public static final String VERSION

See Also:

Constant Field Values

CLIENT_ID

public static final String CLIENT_ID

See Also:

Constant Field Values

CLUSTER_CONTEXT_HTTP_HEADER

public static final String CLUSTER_CONTEXT_HTTP_HEADER

See Also:

Constant Field Values

PROXY_SCHEME_HTTP_HEADER

public static final String PROXY_SCHEME_HTTP_HEADER

See Also:

Constant Field Values

PROXY_HOST_HTTP_HEADER

public static final String PROXY_HOST_HTTP_HEADER

See Also:

Constant Field Values

PROXY_PORT_HTTP_HEADER

public static final String PROXY_PORT_HTTP_HEADER

See Also:

Constant Field Values

PROXY_CONTEXT_PATH_HTTP_HEADER

public static final String PROXY_CONTEXT_PATH_HTTP_HEADER

See Also:

Constant Field Values

PROXIED_ENTITIES_CHAIN_HTTP_HEADER

public static final String PROXIED_ENTITIES_CHAIN_HTTP_HEADER

See Also:

Constant Field Values

PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER

public static final String PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER

See Also:

Constant Field Values

HEADER_BUFFER_SIZE

private static final int HEADER_BUFFER_SIZE

See Also:

Constant Field Values

CLUSTER_CONTEXT_HEADER_VALUE_MAX_BYTES

private static final int CLUSTER_CONTEXT_HEADER_VALUE_MAX_BYTES

See Also:

Constant Field Values

logger

private static final org.slf4j.Logger logger

httpServletRequest

@Context
private javax.servlet.http.HttpServletRequest httpServletRequest

uriInfo

@Context
private javax.ws.rs.core.UriInfo uriInfo

httpContext

@Context
private com.sun.jersey.api.core.HttpContext httpContext

Constructor Detail

ApplicationResource

public ApplicationResource()

Method Detail

generateResourceUri

protected String generateResourceUri(String... path)

Generate a resource uri based off of the specified parameters.

Parameters:

path -

Returns:

noCache

protected javax.ws.rs.core.Response.ResponseBuilder noCache(javax.ws.rs.core.Response.ResponseBuilder response)

Edit the response headers to indicating no caching.

Parameters:

response -

Returns:

clusterContext

protected javax.ws.rs.core.Response.ResponseBuilder clusterContext(javax.ws.rs.core.Response.ResponseBuilder response)

If the application is operating as a node, then this method adds the cluster context information to the response using the response header 'X-CLUSTER_CONTEXT'.

Parameters:

response -

Returns:

getClusterContextFromRequest

protected ClusterContext getClusterContextFromRequest()

Returns:

the cluster context if found in the request header 'X-CLUSTER_CONTEXT'.

generateOkResponse

protected javax.ws.rs.core.Response.ResponseBuilder generateOkResponse()

Generates an Ok response with no content.

Returns:

generateOkResponse

protected javax.ws.rs.core.Response.ResponseBuilder generateOkResponse(Object entity)

Generates an Ok response with the specified content.

Parameters:

entity - The entity

Returns:

The response to be built

generateCreatedResponse

protected javax.ws.rs.core.Response.ResponseBuilder generateCreatedResponse(URI uri,
                                                                Object entity)

Generates a 201 Created response with the specified content.

Parameters:

uri - The URI

jsonResponse - The content

Returns:

The response to be built

generateContinueResponse

protected javax.ws.rs.core.Response.ResponseBuilder generateContinueResponse()

Generates a 150 Node Continue response to be used within the cluster request handshake.

Returns:

getAbsolutePath

protected URI getAbsolutePath()

getRequestParameters

protected javax.ws.rs.core.MultivaluedMap<String,String> getRequestParameters()

getRequestParameters

protected javax.ws.rs.core.MultivaluedMap<String,String> getRequestParameters(boolean forceClientId)

updateClientId

protected Entity updateClientId(Entity entity)

getHeaders

protected Map<String,String> getHeaders()

getHeaders

protected Map<String,String> getHeaders(Map<String,String> overriddenHeaders)

createBatchedActionLogStatement

private void createBatchedActionLogStatement(StringBuilder strb,
                                   Collection<Action> actions)