org.apache.nifi.web.api

Class SnippetResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.SnippetResource

public class SnippetResource
extends ApplicationResource

RESTful endpoint for managing a Snippet.

Field Summary

Fields

Modifier and Type	Field and Description
private WebClusterManager	clusterManager
private static String	LINKED
private static org.slf4j.Logger	logger
private NiFiProperties	properties
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
SnippetResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	createSnippet(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String parentGroupId, Boolean linked, List<String> processorIds, List<String> processGroupIds, List<String> remoteProcessGroupIds, List<String> inputPortIds, List<String> outputPortIds, List<String> connectionIds, List<String> labelIds, List<String> funnelIds) Creates a new snippet based on the specified contents.
javax.ws.rs.core.Response	createSnippet(javax.servlet.http.HttpServletRequest httpServletRequest, SnippetEntity snippetEntity) Creates a snippet based off the specified configuration.
private ConnectionResource	getConnectionResource(String groupId) Get the connection sub-resource within the specified group.
private FunnelResource	getFunnelResource(String groupId) Locates the funnel sub-resource within the specified group.
private InputPortResource	getInputPortResource(String groupId) Get the input ports sub-resource within the specified group.
private LabelResource	getLabelResource(String groupId) Locates the label sub-resource within the specified group.
private OutputPortResource	getOutputPortResource(String groupId) Get the output ports sub-resource within the specified group.
private ProcessGroupResource	getProcessGroupResource(String groupId) Locates the process group sub-resource within the specified group.
private ProcessorResource	getProcessorResource(String groupId) Get the processor resource within the specified group.
private RemoteProcessGroupResource	getRemoteProcessGroupResource(String groupId) Locates the remote process group sub-resource within the specified group.
javax.ws.rs.core.Response	getSnippet(ClientIdParameter clientId, Boolean verbose, String id) Retrieves the specified snippet.
private SnippetDTO	populateRemainingSnippetContent(SnippetDTO snippet) Populates the uri for the specified snippet.
javax.ws.rs.core.Response	removeSnippet(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String id) Removes the specified snippet.
void	setClusterManager(WebClusterManager clusterManager)
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateSnippet(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, Boolean verbose, String id, String parentGroupId, Boolean linked) Updates the specified snippet.
javax.ws.rs.core.Response	updateSnippet(javax.servlet.http.HttpServletRequest httpServletRequest, String id, SnippetEntity snippetEntity) Updates the specified snippet.

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

LINKED

private static final String LINKED

See Also:

Constant Field Values

VERBOSE

private static final String VERBOSE

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

Constructor Detail

SnippetResource

public SnippetResource()

Method Detail

getProcessorResource

private ProcessorResource getProcessorResource(String groupId)

Get the processor resource within the specified group.

Returns:

getConnectionResource

private ConnectionResource getConnectionResource(String groupId)

Get the connection sub-resource within the specified group.

Returns:

getInputPortResource

private InputPortResource getInputPortResource(String groupId)

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

Returns:

getOutputPortResource

private OutputPortResource getOutputPortResource(String groupId)

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

Returns:

getLabelResource

private LabelResource getLabelResource(String groupId)

Locates the label sub-resource within the specified group.

Returns:

getFunnelResource

private FunnelResource getFunnelResource(String groupId)

Locates the funnel sub-resource within the specified group.

Returns:

getRemoteProcessGroupResource

private RemoteProcessGroupResource getRemoteProcessGroupResource(String groupId)

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

Returns:

getProcessGroupResource

private ProcessGroupResource getProcessGroupResource(String groupId)

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

Parameters:

groupId -

Returns:

populateRemainingSnippetContent

private SnippetDTO populateRemainingSnippetContent(SnippetDTO snippet)

Populates the uri for the specified snippet.

createSnippet

@PreAuthorize(value="hasRole(\'ROLE_DFM\')")
public javax.ws.rs.core.Response createSnippet(@Context
                                                   javax.servlet.http.HttpServletRequest httpServletRequest,
                                                   LongParameter version,
                                                   ClientIdParameter clientId,
                                                   String parentGroupId,
                                                   Boolean linked,
                                                   List<String> processorIds,
                                                   List<String> processGroupIds,
                                                   List<String> remoteProcessGroupIds,
                                                   List<String> inputPortIds,
                                                   List<String> outputPortIds,
                                                   List<String> connectionIds,
                                                   List<String> labelIds,
                                                   List<String> funnelIds)

Creates a new snippet based on the specified contents.

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.

parentGroupId - The id of the process group the components in this snippet belong to.

linked - Whether or not this snippet is linked to the underlying data flow. If a linked snippet is deleted, the components that comprise the snippet are also deleted.

processorIds - The ids of any processors in this snippet.

processGroupIds - The ids of any process groups in this snippet.

remoteProcessGroupIds - The ids of any remote process groups in this snippet.

inputPortIds - The ids of any input ports in this snippet.

outputPortIds - The ids of any output ports in this snippet.

connectionIds - The ids of any connections in this snippet.

labelIds - The ids of any labels in this snippet.

funnelIds - The ids of any funnels in this snippet.

Returns:

A snippetEntity

createSnippet

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

Creates a snippet based off the specified configuration.

Parameters:

httpServletRequest -

snippetEntity - A snippetEntity

Returns:

A snippetEntity

getSnippet

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

Retrieves the specified snippet.

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 - Whether or not to include the contents of the snippet in the response.

id - The id of the snippet to retrieve.

Returns:

A snippetEntity.

updateSnippet

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

Updates the specified snippet.

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.

verbose - Whether or not to include the contents of the snippet in the response.

id - The id of the snippet to update.

parentGroupId - The id of the process group to move the contents of this snippet to.

linked - Whether or not this snippet is linked to the underlying data flow. If a linked snippet is deleted, the components that comprise the snippet are also deleted.

Returns:

A snippetEntity.

updateSnippet

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

Updates the specified snippet. The contents of the snippet (component ids) cannot be updated once the snippet is created.

Parameters:

httpServletRequest -

id - The id of the snippet.

snippetEntity - A snippetEntity

Returns:

A snippetEntity

removeSnippet

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

Removes the specified snippet.

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

Returns:

A entity containing the client id and an updated revision.

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setClusterManager

public void setClusterManager(WebClusterManager clusterManager)

setProperties

public void setProperties(NiFiProperties properties)