org.apache.nifi.web.api

Class ProcessorResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ProcessorResource

public class ProcessorResource
extends ApplicationResource

RESTful endpoint for managing a Processor.

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
ProcessorResource()

Method Summary

Modifier and Type	Method and Description
javax.ws.rs.core.Response	clearState(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String id) Clears the state for a processor.
javax.ws.rs.core.Response	deleteProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, java.lang.String id) Removes the specified processor.
javax.ws.rs.core.Response	getProcessor(java.lang.String id) Retrieves the specified processor.
javax.ws.rs.core.Response	getPropertyDescriptor(ClientIdParameter clientId, java.lang.String id, java.lang.String propertyName) Returns the descriptor for the specified property.
javax.ws.rs.core.Response	getState(java.lang.String id) Gets the state for a processor.
ProcessorDTO	populateRemainingProcessorContent(ProcessorDTO processor) Populate the uri's for the specified processor and its relationships.
java.util.Set<ProcessorEntity>	populateRemainingProcessorEntitiesContent(java.util.Set<ProcessorEntity> processorEntities) Populate the uri's for the specified processors and their relationships.
ProcessorEntity	populateRemainingProcessorEntityContent(ProcessorEntity processorEntity) Populate the uri's for the specified processors and their relationships.
void	setAuthorizer(Authorizer authorizer)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, java.lang.String id, ProcessorEntity requestProcessorEntity) Updates the specified processor with the specified values.

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

ProcessorResource

public ProcessorResource()

Method Detail

populateRemainingProcessorEntitiesContent

public java.util.Set<ProcessorEntity> populateRemainingProcessorEntitiesContent(java.util.Set<ProcessorEntity> processorEntities)

Populate the uri's for the specified processors and their relationships.

Parameters:

processorEntities - processors

Returns:

dtos

populateRemainingProcessorEntityContent

public ProcessorEntity populateRemainingProcessorEntityContent(ProcessorEntity processorEntity)

Populate the uri's for the specified processors and their relationships.

Parameters:

processorEntity - processors

Returns:

dtos

populateRemainingProcessorContent

public ProcessorDTO populateRemainingProcessorContent(ProcessorDTO processor)

Populate the uri's for the specified processor and its relationships.

getProcessor

public javax.ws.rs.core.Response getProcessor(java.lang.String id)
                                       throws java.lang.InterruptedException

Retrieves the specified processor.

Parameters:

id - The id of the processor to retrieve.

Returns:

A processorEntity.

Throws:

java.lang.InterruptedException - if interrupted

getPropertyDescriptor

public javax.ws.rs.core.Response getPropertyDescriptor(ClientIdParameter clientId,
                                                       java.lang.String id,
                                                       java.lang.String propertyName)
                                                throws java.lang.InterruptedException

Returns the descriptor for the specified property.

Parameters:

id - The id of the processor

propertyName - The property

Returns:

a propertyDescriptorEntity

Throws:

java.lang.InterruptedException - if interrupted

getState

public javax.ws.rs.core.Response getState(java.lang.String id)
                                   throws java.lang.InterruptedException

Gets the state for a processor.

Parameters:

id - The id of the processor

Returns:

a componentStateEntity

Throws:

java.lang.InterruptedException - if interrupted

clearState

public javax.ws.rs.core.Response clearState(@Context
                                            javax.servlet.http.HttpServletRequest httpServletRequest,
                                            java.lang.String id)
                                     throws java.lang.InterruptedException

Clears the state for a processor.

Parameters:

httpServletRequest - servlet request

id - The id of the processor

Returns:

a componentStateEntity

Throws:

java.lang.InterruptedException - if interrupted

updateProcessor

public javax.ws.rs.core.Response updateProcessor(@Context
                                                 javax.servlet.http.HttpServletRequest httpServletRequest,
                                                 java.lang.String id,
                                                 ProcessorEntity requestProcessorEntity)
                                          throws java.lang.InterruptedException

Updates the specified processor with the specified values.

Parameters:

httpServletRequest - request

id - The id of the processor to update.

requestProcessorEntity - A processorEntity.

Returns:

A processorEntity.

Throws:

java.lang.InterruptedException - if interrupted

deleteProcessor

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

Removes the specified processor.

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 processor to remove.

Returns:

A processorEntity.

Throws:

java.lang.InterruptedException - if interrupted

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setAuthorizer

public void setAuthorizer(Authorizer authorizer)