org.apache.nifi.web.api

Class ClusterResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.ClusterResource

public class ClusterResource
extends ApplicationResource

RESTful endpoint for managing a cluster.

Field Summary

Fields

Modifier and Type	Field and Description
private NiFiProperties	properties
private com.sun.jersey.api.core.ResourceContext	resourceContext
private NiFiServiceFacade	serviceFacade

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

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	getCluster(ClientIdParameter clientId) Gets the contents of this NiFi cluster.
javax.ws.rs.core.Response	getClusterHead() Returns a 200 OK response to indicate this is a valid cluster endpoint.
javax.ws.rs.core.Response	getClusterStatus(ClientIdParameter clientId) Gets the status of this NiFi cluster.
javax.ws.rs.core.Response	getConnectionStatus(ClientIdParameter clientId, String id) Gets the connection status for every node.
javax.ws.rs.core.Response	getConnectionStatusHistory(ClientIdParameter clientId, String id) Gets the connections status history for every node.
javax.ws.rs.core.Response	getInputPortStatus(ClientIdParameter clientId, String id) Gets the input port status for every node.
NodeResource	getNodeResource() Locates the ClusterConnection sub-resource.
javax.ws.rs.core.Response	getOutputPortStatus(ClientIdParameter clientId, String id) Gets the output port status for every node.
javax.ws.rs.core.Response	getProcessGroupStatusHistory(ClientIdParameter clientId, String id) Gets the process group status history for every node.
javax.ws.rs.core.Response	getProcessor(ClientIdParameter clientId, String id) Gets the processor.
javax.ws.rs.core.Response	getProcessorStatus(ClientIdParameter clientId, String id) Gets the processor status for every node.
javax.ws.rs.core.Response	getProcessorStatusHistory(ClientIdParameter clientId, String id) Gets the processor status history for every node.
javax.ws.rs.core.Response	getRemoteProcessGroupStatus(ClientIdParameter clientId, String id) Gets the remote process group status for every node.
javax.ws.rs.core.Response	getRemoteProcessGroupStatusHistory(ClientIdParameter clientId, String id) Gets the remote process group status history for every node.
javax.ws.rs.core.Response	searchCluster(String value) Searches the cluster for a node with a given address.
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, LongParameter version, ClientIdParameter clientId, String processorId, String annotationData) Updates the processors annotation data.
javax.ws.rs.core.Response	updateProcessor(javax.servlet.http.HttpServletRequest httpServletRequest, String processorId, ProcessorEntity processorEntity) Updates the processors annotation data.

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

resourceContext

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

serviceFacade

private NiFiServiceFacade serviceFacade

properties

private NiFiProperties properties

Constructor Detail

ClusterResource

public ClusterResource()

Method Detail

getNodeResource

public NodeResource getNodeResource()

Locates the ClusterConnection sub-resource.

Returns:

getClusterStatus

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

Gets the status of this NiFi cluster.

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 clusterStatusEntity

getClusterHead

public javax.ws.rs.core.Response getClusterHead()

Returns a 200 OK response to indicate this is a valid cluster endpoint.

Returns:

An OK response with an empty entity body.

getCluster

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

Gets the contents of this NiFi cluster. This includes all nodes and their status.

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 clusterEntity

searchCluster

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

Searches the cluster for a node with a given address.

Parameters:

value - Search value that will be matched against a node's address

Returns:

Nodes that match the specified criteria

getProcessor

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

Gets the 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

Returns:

A processorEntity

updateProcessor

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

Updates the processors annotation data.

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.

processorId - The id of the processor.

annotationData - The annotation data to set.

Returns:

A processorEntity.

updateProcessor

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

Updates the processors annotation data.

Parameters:

httpServletRequest -

processorId - The id of the processor.

processorEntity - A processorEntity.

Returns:

A processorEntity.

getProcessorStatus

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

Gets the processor status for every node.

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

Returns:

A clusterProcessorStatusEntity

getProcessorStatusHistory

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

Gets the processor status history for every node.

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

Returns:

A clusterProcessorStatusHistoryEntity

getConnectionStatus

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

Gets the connection status for every node.

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

Returns:

A clusterProcessorStatusEntity

getConnectionStatusHistory

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

Gets the connections status history for every node.

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

Returns:

A clusterProcessorStatusHistoryEntity

getProcessGroupStatusHistory

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

Gets the process group status history for every node.

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

Returns:

A clusterProcessGroupStatusHistoryEntity

getRemoteProcessGroupStatus

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

Gets the remote process group status for every node.

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

Returns:

A clusterRemoteProcessGroupStatusEntity

getInputPortStatus

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

Gets the input port status for every node.

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 input port

Returns:

A clusterPortStatusEntity

getOutputPortStatus

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

Gets the output port status for every node.

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 output port

Returns:

A clusterPortStatusEntity

getRemoteProcessGroupStatusHistory

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

Gets the remote process group status history for every node.

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

Returns:

A clusterRemoteProcessGroupStatusHistoryEntity

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setProperties

public void setProperties(NiFiProperties properties)