org.apache.nifi.web.api

Class NodeResource

java.lang.Object

org.apache.nifi.web.api.ApplicationResource

org.apache.nifi.web.api.NodeResource

public class NodeResource
extends ApplicationResource

RESTful endpoint for managing a cluster connection.

Field Summary

Fields

Modifier and Type	Field and Description
private NiFiProperties	properties
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
NodeResource()

Method Summary

Methods

Modifier and Type	Method and Description
javax.ws.rs.core.Response	deleteNode(ClientIdParameter clientId, String id) Removes the specified from this NiFi cluster.
javax.ws.rs.core.Response	getNode(ClientIdParameter clientId, String id) Gets the contents of the specified node in this NiFi cluster.
javax.ws.rs.core.Response	getNodeStatus(ClientIdParameter clientId, String id) Gets the status for the specified node.
javax.ws.rs.core.Response	getNodeSystemDiagnostics(ClientIdParameter clientId, String id) Gets the system diagnositics for the specified node.
void	setProperties(NiFiProperties properties)
void	setServiceFacade(NiFiServiceFacade serviceFacade)
javax.ws.rs.core.Response	updateNode(ClientIdParameter clientId, String id, String status, Boolean primary) Updates the contents of the specified node in this NiFi cluster.
javax.ws.rs.core.Response	updateNode(String id, NodeEntity nodeEntity) Updates the contents of the specified node in this NiFi cluster.

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

serviceFacade

private NiFiServiceFacade serviceFacade

properties

private NiFiProperties properties

Constructor Detail

NodeResource

public NodeResource()

Method Detail

getNode

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

Gets the contents of the specified node in 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.

id - The node id.

Returns:

A nodeEntity.

getNodeStatus

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

Gets the status for the specified 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 node.

Returns:

A processGroupStatusEntity

getNodeSystemDiagnostics

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

Gets the system diagnositics for the specified 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 node.

Returns:

A systemDiagnosticsEntity

updateNode

@PreAuthorize(value="hasAnyRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response updateNode(ClientIdParameter clientId,
                                                String id,
                                                String status,
                                                Boolean primary)

Updates the contents of the specified node in 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.

id - The id of the node.

status - The status of the node.

primary - Whether the node should be make primary.

Returns:

A nodeEntity

updateNode

@PreAuthorize(value="hasAnyRole(\'ROLE_ADMIN\')")
public javax.ws.rs.core.Response updateNode(String id,
                                                NodeEntity nodeEntity)

Updates the contents of the specified node in this NiFi cluster.

Parameters:

id - The id of the node

nodeEntity - A nodeEntity

Returns:

A nodeEntity

deleteNode

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

Removes the specified from 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.

id - The id of the node

Returns:

A nodeEntity

setServiceFacade

public void setServiceFacade(NiFiServiceFacade serviceFacade)

setProperties

public void setProperties(NiFiProperties properties)