org.apache.nifi.cluster.flow

Interface DataFlowManagementService

All Known Implementing Classes:

DataFlowManagementServiceImpl

public interface DataFlowManagementService

A service for managing the cluster's flow. The service will attempt to keep the cluster's dataflow current while respecting the value of the configured retrieval delay. The eligible retrieval time is reset with the configured delay every time the flow state is set to STALE. If the state is set to UNKNOWN or CURRENT, then the flow will not be retrieved. Clients must call start() and stop() to initialize and stop the instance.

Method Summary

Modifier and Type	Method and Description
Set<NodeIdentifier>	getNodeIds() Returns the set of node identifiers the service is using to retrieve the flow.
PersistedFlowState	getPersistedFlowState()
int	getRetrievalDelaySeconds()
boolean	isFlowCurrent()
boolean	isRunning()
ClusterDataFlow	loadDataFlow() Loads the dataflow.
void	setNodeIds(Set<NodeIdentifier> nodeIds) Sets the node identifiers to use when attempting to retrieve the flow.
void	setPersistedFlowState(PersistedFlowState flowState) Sets the state of the flow.
void	setRetrievalDelay(String delay) Sets the retrieval delay.
void	start() Starts the instance.
void	stop() Stops the instance.
void	updateControllerServices(byte[] serializedControllerServices) Updates the dataflow with the given serialized form of the Controller Services that are to exist on the NCM.
void	updatePrimaryNode(NodeIdentifier nodeId) Updates the dataflow with the given primary node identifier.
void	updateReportingTasks(byte[] serializedReportingTasks) Updates the dataflow with the given serialized form of Reporting Tasks that are to exist on the NCM.

Method Detail

start

void start()

Starts the instance. Start may only be called if the instance is not running.

stop

void stop()

Stops the instance. Stop may only be called if the instance is running.

isRunning

boolean isRunning()

Returns:

true if the instance is started; false otherwise.

loadDataFlow

ClusterDataFlow loadDataFlow()

Loads the dataflow.

Returns:

the dataflow or null if no dataflow exists

updatePrimaryNode

void updatePrimaryNode(NodeIdentifier nodeId)
                throws DaoException

Updates the dataflow with the given primary node identifier.

Parameters:

nodeId - the node identifier

Throws:

DaoException - if the update failed

updateControllerServices

void updateControllerServices(byte[] serializedControllerServices)
                       throws DaoException

Updates the dataflow with the given serialized form of the Controller Services that are to exist on the NCM.

Parameters:

serializedControllerServices - services

Throws:

DaoException - ex

updateReportingTasks

void updateReportingTasks(byte[] serializedReportingTasks)
                   throws DaoException

Updates the dataflow with the given serialized form of Reporting Tasks that are to exist on the NCM.

Parameters:

serializedReportingTasks - tasks

Throws:

DaoException - ex

setPersistedFlowState

void setPersistedFlowState(PersistedFlowState flowState)

Sets the state of the flow.

Parameters:

flowState - the state

See Also:

PersistedFlowState

getPersistedFlowState

PersistedFlowState getPersistedFlowState()

Returns:

the state of the flow

isFlowCurrent

boolean isFlowCurrent()

Returns:

true if the flow is current; false otherwise.

setNodeIds

void setNodeIds(Set<NodeIdentifier> nodeIds)

Sets the node identifiers to use when attempting to retrieve the flow.

Parameters:

nodeIds - the node identifiers

getNodeIds

Set<NodeIdentifier> getNodeIds()

Returns the set of node identifiers the service is using to retrieve the flow.

Returns:

the set of node identifiers the service is using to retrieve the flow.

getRetrievalDelaySeconds

int getRetrievalDelaySeconds()

Returns:

the retrieval delay in seconds

setRetrievalDelay

void setRetrievalDelay(String delay)

Sets the retrieval delay.

Parameters:

delay - the retrieval delay in seconds