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.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private String	groupId
private static org.slf4j.Logger	logger
private static List<Long>	POSSIBLE_RUN_DURATIONS
private NiFiProperties	properties
private NiFiServiceFacade	serviceFacade
private javax.servlet.ServletContext	servletContext

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

CLIENT_ID, CLUSTER_CONTEXT_HTTP_HEADER, PROXIED_ENTITIES_CHAIN_HTTP_HEADER, PROXIED_ENTITY_USER_DETAILS_HTTP_HEADER, 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

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String name, String type, DoubleParameter x, DoubleParameter y) Creates a new processor.
javax.ws.rs.core.Response	createProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, ProcessorEntity processorEntity) Creates a new processor.
javax.ws.rs.core.Response	deleteProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified processor.
javax.ws.rs.core.Response	getProcessor(ClientIdParameter clientId, String id) Retrieves the specified processor.
javax.ws.rs.core.Response	getProcessors(ClientIdParameter clientId) Retrieves all the processors in this NiFi.
javax.ws.rs.core.Response	getProcessorStatusHistory(ClientIdParameter clientId, String id) Retrieves the specified processor status history.
private ProcessorDTO	populateRemainingProcessorContent(ProcessorDTO processor) Populate the uri's for the specified processor and its relationships.
Set<ProcessorDTO>	populateRemainingProcessorsContent(Set<ProcessorDTO> processors) Populate the uri's for the specified processors and their relationships.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, DoubleParameter x, DoubleParameter y, String name, IntegerParameter concurrentlySchedulableTaskCount, String schedulingPeriod, String penaltyDuration, String yieldDuration, LongParameter runDurationMillis, String bulletinLevel, String schedulingStrategy, String comments, List<String> markedForDeletion, String state, javax.ws.rs.core.MultivaluedMap<String,String> formParams) Updates the specified processor with the specified values.
javax.ws.rs.core.Response	updateProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, String id, ProcessorEntity processorEntity) Updates the specified processor with the specified values.

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

clusterContext, generateContinueResponse, generateCreatedResponse, generateOkResponse, generateOkResponse, generateResourceUri, getAbsolutePath, getClusterContextFromRequest, getHeaders, getHeaders, getRequestParameters, getRequestParameters, noCache, updateClientId

Methods inherited from class java.lang.Object

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

Field Detail

logger

private static final org.slf4j.Logger logger

POSSIBLE_RUN_DURATIONS

private static final List<Long> POSSIBLE_RUN_DURATIONS

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

groupId

private String groupId

servletContext

@Context
private javax.servlet.ServletContext servletContext

Constructor Detail

ProcessorResource

public ProcessorResource()

Method Detail

populateRemainingProcessorsContent

public Set<ProcessorDTO> populateRemainingProcessorsContent(Set<ProcessorDTO> processors)

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

Parameters:

processors -

Returns:

populateRemainingProcessorContent

private ProcessorDTO populateRemainingProcessorContent(ProcessorDTO processor)

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

Parameters:

processor -

Returns:

getProcessors

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getProcessors(ClientIdParameter clientId)

Retrieves all the processors in this NiFi.

Parameters:

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.

Returns:

A processorsEntity.

createProcessor

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createProcessor(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     LongParameter version,
                                                     ClientIdParameter clientId,
                                                     String name,
                                                     String type,
                                                     DoubleParameter x,
                                                     DoubleParameter y)

Creates a new processor.

Parameters:

httpServletRequest -

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.

name - The name of the new processor.

type - The type of the new processor. This type should refer to one of the types in the GET /controller/processor-types response.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A processorEntity.

createProcessor

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createProcessor(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     ProcessorEntity processorEntity)

Creates a new processor.

Parameters:

httpServletRequest -

processorEntity - A processorEntity.

Returns:

A processorEntity.

getProcessor

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getProcessor(ClientIdParameter clientId,
                                                  String id)

Retrieves the specified processor.

Parameters:

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 retrieve.

Returns:

A processorEntity.

getProcessorStatusHistory

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getProcessorStatusHistory(ClientIdParameter clientId,
                                                               String id)

Retrieves the specified processor status history.

Parameters:

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 history to retrieve.

Returns:

A statusHistoryEntity.

updateProcessor

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateProcessor(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     LongParameter version,
                                                     ClientIdParameter clientId,
                                                     String id,
                                                     DoubleParameter x,
                                                     DoubleParameter y,
                                                     String name,
                                                     IntegerParameter concurrentlySchedulableTaskCount,
                                                     String schedulingPeriod,
                                                     String penaltyDuration,
                                                     String yieldDuration,
                                                     LongParameter runDurationMillis,
                                                     String bulletinLevel,
                                                     String schedulingStrategy,
                                                     String comments,
                                                     List<String> markedForDeletion,
                                                     String state,
                                                     javax.ws.rs.core.MultivaluedMap<String,String> formParams)

Updates the specified processor with the specified values.

Parameters:

httpServletRequest -

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 update.

x - The x coordinate for this processors position.

y - The y coordinate for this processors position.

name - The name of the processor.

concurrentlySchedulableTaskCount - The number of concurrentlySchedulableTasks

schedulingPeriod - The scheduling period

schedulingStrategy - The scheduling strategy

penaltyDuration - The penalty duration

yieldDuration - The yield duration

runDurationMillis - The run duration in milliseconds

bulletinLevel - The bulletin level

comments - Any comments about this processor.

markedForDeletion - Array of property names whose value should be removed.

state - The processors state.

formParams - Additionally, the processor properties and styles are specified in the form parameters. Because the property names and styles differ from processor to processor they are specified in a map-like fashion:

• properties[required.file.path]=/path/to/file
• properties[required.hostname]=localhost
• properties[required.port]=80
• properties[optional.file.path]=/path/to/file
• properties[optional.hostname]=localhost
• properties[optional.port]=80
• properties[user.defined.pattern]=^.*?s.*$
• style[background-color]=#aaaaaa

Returns:

A processorEntity.

updateProcessor

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response updateProcessor(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     String id,
                                                     ProcessorEntity processorEntity)

Updates the specified processor with the specified values.

Parameters:

httpServletRequest -

id - The id of the processor to update.

processorEntity - A processorEntity.

Returns:

A processorEntity.

deleteProcessor

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response deleteProcessor(@Context
                                                     javax.servlet.http.HttpServletRequest httpServletRequest,
                                                     LongParameter version,
                                                     ClientIdParameter clientId,
                                                     String id)

Removes the specified processor.

Parameters:

httpServletRequest -

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.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setGroupId

public void setGroupId(String groupId)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)