org.apache.nifi.web.api

Class FunnelResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.FunnelResource

public class FunnelResource
extends ApplicationResource

RESTful endpoint for managing a Funnel.

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.nifi.web.api.ApplicationResource

ApplicationResource.ReplicationTarget, ApplicationResource.ResponseCreator

Field Summary

Fields inherited from class org.apache.nifi.web.api.ApplicationResource

CLIENT_ID, FORWARDED_CONTEXT_HTTP_HEADER, FORWARDED_HOST_HTTP_HEADER, FORWARDED_PORT_HTTP_HEADER, FORWARDED_PROTO_HTTP_HEADER, NODEWISE, NON_GUARANTEED_ENDPOINT, properties, PROXY_CONTEXT_PATH_HTTP_HEADER, PROXY_HOST_HTTP_HEADER, PROXY_PORT_HTTP_HEADER, PROXY_SCHEME_HTTP_HEADER, VERSION

Constructor Summary

Constructors

Constructor and Description
FunnelResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getFunnel(java.lang.String id) Retrieves the specified funnel.
java.util.Set<FunnelEntity>	populateRemainingFunnelEntitiesContent(java.util.Set<FunnelEntity> funnelEntities) Populates the uri for the specified funnels.
FunnelEntity	populateRemainingFunnelEntityContent(FunnelEntity funnelEntity) Populates the uri for the specified funnel.
javax.ws.rs.core.Response	removeFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, java.lang.String id) Removes the specified funnel.
void	setAuthorizer(Authorizer authorizer)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateFunnel(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String id, FunnelEntity requestFunnelEntity) Creates a new Funnel.

Methods inherited from class org.apache.nifi.web.api.ApplicationResource

authorizeProcessGroup, authorizeSnippet, generateContinueResponse, generateCreatedResponse, generateNotAuthorizedResponse, generateOkResponse, generateOkResponse, generateResourceUri, generateUuid, getAbsolutePath, getClusterCoordinator, getClusterCoordinatorNode, getHeaders, getHeaders, getIdGenerationSeed, getProperties, getReplicationTarget, getRequestParameters, getRequestReplicator, getRequestUri, getRevision, getRevision, isCancellationPhase, isExecutionPhase, isTwoPhaseRequest, isValidationPhase, negotiateTransportProtocolVersion, noCache, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicate, replicateNodeResponse, replicateNodeResponse, replicateNodeResponse, replicateToCoordinator, setClusterCoordinator, setCommonHeaders, setFlowController, setProperties, setRequestReplicator, withWriteLock, withWriteLock, withWriteLock

Methods inherited from class java.lang.Object

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

Constructor Detail

FunnelResource

public FunnelResource()

Method Detail

populateRemainingFunnelEntitiesContent

public java.util.Set<FunnelEntity> populateRemainingFunnelEntitiesContent(java.util.Set<FunnelEntity> funnelEntities)

Populates the uri for the specified funnels.

Parameters:

funnelEntities - funnels

Returns:

funnels

populateRemainingFunnelEntityContent

public FunnelEntity populateRemainingFunnelEntityContent(FunnelEntity funnelEntity)

Populates the uri for the specified funnel.

Parameters:

funnelEntity - funnel

Returns:

funnel

getFunnel

public javax.ws.rs.core.Response getFunnel(java.lang.String id)

Retrieves the specified funnel.

Parameters:

id - The id of the funnel to retrieve

Returns:

A funnelEntity.

updateFunnel

public javax.ws.rs.core.Response updateFunnel(@Context
                                              javax.servlet.http.HttpServletRequest httpServletRequest,
                                              java.lang.String id,
                                              FunnelEntity requestFunnelEntity)

Creates a new Funnel.

Parameters:

httpServletRequest - request

id - The id of the funnel to update.

requestFunnelEntity - A funnelEntity.

Returns:

A funnelEntity.

removeFunnel

public javax.ws.rs.core.Response removeFunnel(@Context
                                              javax.servlet.http.HttpServletRequest httpServletRequest,
                                              LongParameter version,
                                              ClientIdParameter clientId,
                                              java.lang.String id)

Removes the specified funnel.

Parameters:

httpServletRequest - request

version - The revision is used to verify the client is working with the latest version of the flow.

clientId - Optional client id. If the client id is not specified, a new one will be generated. This value (whether specified or generated) is included in the response.

id - The id of the funnel to remove.

Returns:

A entity containing the client id and an updated revision.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setAuthorizer

public void setAuthorizer(Authorizer authorizer)