org.apache.nifi.web.api

Class ProcessGroupResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ProcessGroupResource

public class ProcessGroupResource
extends ApplicationResource

RESTful endpoint for managing a Group.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private String	groupId
private NiFiProperties	properties
private static String	RECURSIVE
private com.sun.jersey.api.core.ResourceContext	resourceContext
private NiFiServiceFacade	serviceFacade
private static String	VERBOSE

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	copySnippet(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String snippetId, DoubleParameter originX, DoubleParameter originY) Copies the specified snippet within this ProcessGroup.
javax.ws.rs.core.Response	createProcessGroupReference(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String name, DoubleParameter x, DoubleParameter y) Adds the specified process group.
javax.ws.rs.core.Response	createProcessGroupReference(javax.servlet.http.HttpServletRequest httpServletRequest, ProcessGroupEntity processGroupEntity) Adds the specified process group.
ConnectionResource	getConnectionResource() Get the connection sub-resource within the specified group.
FunnelResource	getFunnelResource() Locates the funnel sub-resource within the specified group.
InputPortResource	getInputPortResource() Get the input ports sub-resource within the specified group.
LabelResource	getLabelResource() Locates the label sub-resource within the specified group.
OutputPortResource	getOutputPortResource() Get the output ports sub-resource within the specified group.
javax.ws.rs.core.Response	getProcessGroup(ClientIdParameter clientId, Boolean recursive, Boolean verbose) Retrieves the content of the specified group.
javax.ws.rs.core.Response	getProcessGroup(ClientIdParameter clientId, String processGroupReferenceId, Boolean recursive, Boolean verbose) Retrieves the contents of the specified group.
javax.ws.rs.core.Response	getProcessGroupReferences(ClientIdParameter clientId, Boolean verbose) Retrieves the content of the specified group reference.
private String	getProcessGroupReferenceUri(ProcessGroupDTO processGroup) Generates a URI for a process group reference.
javax.ws.rs.core.Response	getProcessGroupStatus(ClientIdParameter clientId, Boolean recursive) Retrieves the status report for this NiFi.
javax.ws.rs.core.Response	getProcessGroupStatusHistory(ClientIdParameter clientId) Retrieves the specified remote process groups status history.
private String	getProcessGroupUri(String processGroupId) Generates a URI for a process group.
ProcessorResource	getProcessorResource() Get the processor resource within the specified group.
RemoteProcessGroupResource	getRemoteProcessGroupResource() Locates the remote process group sub-resource within the specified group.
javax.ws.rs.core.Response	instantiateTemplate(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String templateId, DoubleParameter originX, DoubleParameter originY) Instantiates the specified template within this ProcessGroup.
private ProcessGroupDTO	populateRemainingProcessGroupContent(ProcessGroupDTO processGroup, String processGroupUri) Populates the remaining fields in the specified process group.
Set<ProcessGroupDTO>	populateRemainingProcessGroupsContent(Set<ProcessGroupDTO> processGroups) Populates the remaining fields in the specified process groups.
private FlowSnippetDTO	populateRemainingSnippetContent(FlowSnippetDTO snippet) Populates the remaining content of the specified snippet.
javax.ws.rs.core.Response	removeProcessGroupReference(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified process group reference.
void	setClusterManager(WebClusterManager clusterManager)
void	setGroupId(String groupId)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, Boolean running) Updates the state of all processors in the process group.
javax.ws.rs.core.Response	updateProcessGroup(javax.servlet.http.HttpServletRequest httpServletRequest, ProcessGroupEntity processGroupEntity) Updates the state of all processors in the process group.
javax.ws.rs.core.Response	updateProcessGroupReference(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id, String name, String comments, Boolean running, DoubleParameter x, DoubleParameter y) Updates the specified process group.
javax.ws.rs.core.Response	updateProcessGroupReference(javax.servlet.http.HttpServletRequest httpServletRequest, String id, ProcessGroupEntity processGroupEntity) Updates the specified process group.

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

VERBOSE

private static final String VERBOSE

See Also:

Constant Field Values

RECURSIVE

private static final String RECURSIVE

See Also:

Constant Field Values

resourceContext

@Context
private com.sun.jersey.api.core.ResourceContext resourceContext

serviceFacade

private NiFiServiceFacade serviceFacade

clusterManager

private WebClusterManager clusterManager

properties

private NiFiProperties properties

groupId

private String groupId

Constructor Detail

ProcessGroupResource

public ProcessGroupResource()

Method Detail

getProcessorResource

public ProcessorResource getProcessorResource()

Get the processor resource within the specified group.

Returns:

getConnectionResource

public ConnectionResource getConnectionResource()

Get the connection sub-resource within the specified group.

Returns:

getInputPortResource

public InputPortResource getInputPortResource()

Get the input ports sub-resource within the specified group.

Returns:

getOutputPortResource

public OutputPortResource getOutputPortResource()

Get the output ports sub-resource within the specified group.

Returns:

getLabelResource

public LabelResource getLabelResource()

Locates the label sub-resource within the specified group.

Returns:

getFunnelResource

public FunnelResource getFunnelResource()

Locates the funnel sub-resource within the specified group.

Returns:

getRemoteProcessGroupResource

public RemoteProcessGroupResource getRemoteProcessGroupResource()

Locates the remote process group sub-resource within the specified group.

Returns:

populateRemainingProcessGroupsContent

public Set<ProcessGroupDTO> populateRemainingProcessGroupsContent(Set<ProcessGroupDTO> processGroups)

Populates the remaining fields in the specified process groups.

Parameters:

processGroups -

Returns:

populateRemainingProcessGroupContent

private ProcessGroupDTO populateRemainingProcessGroupContent(ProcessGroupDTO processGroup,
                                                   String processGroupUri)

Populates the remaining fields in the specified process group.

Parameters:

processGroup -

verbose -

Returns:

populateRemainingSnippetContent

private FlowSnippetDTO populateRemainingSnippetContent(FlowSnippetDTO snippet)

Populates the remaining content of the specified snippet.

Parameters:

snippet -

Returns:

getProcessGroupUri

private String getProcessGroupUri(String processGroupId)

Generates a URI for a process group.

Parameters:

processGroupId -

Returns:

getProcessGroupReferenceUri

private String getProcessGroupReferenceUri(ProcessGroupDTO processGroup)

Generates a URI for a process group reference.

Parameters:

processGroupId -

Returns:

getProcessGroup

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

Retrieves the content of the specified group. This includes all processors, the connections, the process group references, the remote process group references, and the labels.

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.

recursive - Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true.

verbose - Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response.

Returns:

A processGroupEntity.

copySnippet

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

Copies the specified snippet within this ProcessGroup.

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.

snippetId - The id of the snippet to copy.

originX - The x coordinate of the origin of the bounding box.

originY - The y coordinate of the origin of the bounding box.

Returns:

A flowSnippetEntity.

instantiateTemplate

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

Instantiates the specified template within this ProcessGroup.

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.

templateId - The id of the template to instantiate.

originX - The x coordinate of the origin of the bounding box.

originY - The y coordinate of the origin of the bounding box.

Returns:

A flowSnippetEntity.

updateProcessGroup

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

Updates the state of all processors in the process group. Supports modifying whether the processors and process groups are running/stopped and instantiating templates.

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.

running - Optional flag that indicates whether all processors in this group should be started/stopped.

Returns:

A processGroupEntity.

updateProcessGroup

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

Updates the state of all processors in the process group. Supports modifying whether the processors and process groups are running/stopped and instantiating templates.

Parameters:

httpServletRequest -

processGroupEntity - A processGroupEntity

Returns:

A processGroupEntity

getProcessGroup

@PreAuthorize(value="hasAnyRole(\'ROLE_MONITOR\', \'ROLE_DFM\', \'ROLE_ADMIN\')")
public javax.ws.rs.core.Response getProcessGroup(ClientIdParameter clientId,
                                                     String processGroupReferenceId,
                                                     Boolean recursive,
                                                     Boolean verbose)

Retrieves the contents of the specified group.

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.

recursive - Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true.

processGroupReferenceId - The id of the process group.

verbose - Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response.

Returns:

A processGroupEntity.

getProcessGroupReferences

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

Retrieves the content of the specified group reference.

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.

verbose - Optional verbose flag that defaults to false. If the verbose flag is set to true processor configuration and property details will be included in the response.

Returns:

A controllerEntity.

createProcessGroupReference

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

Adds the specified process group.

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 process group

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A processGroupEntity

createProcessGroupReference

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

Adds the specified process group.

Parameters:

httpServletRequest -

processGroupEntity - A processGroupEntity

Returns:

A processGroupEntity

updateProcessGroupReference

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

Updates the specified process group.

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 process group

name - The name of the process group.

comments - The comments for the process group.

running - Optional flag that indicates whether all processors should be started/stopped.

x - The x coordinate for this funnels position.

y - The y coordinate for this funnels position.

Returns:

A processGroupEntity.

updateProcessGroupReference

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

Updates the specified process group.

Parameters:

httpServletRequest -

id - The id of the process group.

processGroupEntity - A processGroupEntity.

Returns:

A processGroupEntity.

removeProcessGroupReference

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

Removes the specified process group reference.

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 process group to be removed.

Returns:

A processGroupEntity.

getProcessGroupStatus

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

Retrieves the status report for 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.

recursive - Optional recursive flag that defaults to false. If set to true, all descendent groups and their content will be included if the verbose flag is also set to true.

Returns:

A processGroupStatusEntity.

getProcessGroupStatusHistory

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

Retrieves the specified remote process groups 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.

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)