org.apache.nifi.cluster.flow.impl

Class DataFlowManagementServiceImpl

java.lang.Object

org.apache.nifi.cluster.flow.impl.DataFlowManagementServiceImpl

All Implemented Interfaces:

DataFlowManagementService

public class DataFlowManagementServiceImpl
extends Object
implements DataFlowManagementService

Implements FlowManagementService interface. The service tries to keep the cluster's flow current with regards to the available nodes. The instance may be configured with a retrieval delay, which will reduce the number of retrievals performed by the service at the expense of increasing the chances that the service will not be able to provide a current flow to the caller. By default, the service will try to update the flow as quickly as possible. Configuring a delay enables a less aggressive retrieval strategy. Specifically, the eligible retrieval time is reset 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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	DataFlowManagementServiceImpl.FlowRetrieverTimerTask A timer task for issuing FlowRequestMessage messages to nodes to retrieve an updated flow.
private static class	DataFlowManagementServiceImpl.TimingReentrantLock

Field Summary

Fields

Modifier and Type	Field and Description
private DataFlowDao	flowDao
private Timer	flowRetriever
private AtomicLong	lastRetrievalTime
private static org.slf4j.Logger	logger
private Set<NodeIdentifier>	nodeIds
private DataFlowManagementServiceImpl.TimingReentrantLock	resourceLock
private long	retrievableAfterTime
private AtomicInteger	retrievalDelaySeconds
private ClusterManagerProtocolSender	sender
private AtomicBoolean	stopRequested

Constructor Summary

Constructors

Constructor and Description
DataFlowManagementServiceImpl(DataFlowDao flowDao, ClusterManagerProtocolSender sender)

Method Summary

Modifier and Type	Method and Description
long	getLastRetrievalTime()
Set<NodeIdentifier>	getNodeIds() Returns the set of node identifiers the service is using to retrieve the flow.
PersistedFlowState	getPersistedFlowState()
int	getRetrievalDelaySeconds()
ClusterManagerProtocolSender	getSender()
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 retrievalDelay) Sets the retrieval delay.
void	start() Starts the instance.
void	stop() Stops the instance.
void	updateControllerServices(byte[] controllerServiceBytes) 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[] reportingTaskBytes) Updates the dataflow with the given serialized form of Reporting Tasks that are to exist on the NCM.

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

flowDao

private final DataFlowDao flowDao

sender

private final ClusterManagerProtocolSender sender

nodeIds

private final Set<NodeIdentifier> nodeIds

stopRequested

private final AtomicBoolean stopRequested

lastRetrievalTime

private final AtomicLong lastRetrievalTime

flowRetriever

private Timer flowRetriever

retrievableAfterTime

private long retrievableAfterTime

retrievalDelaySeconds

private AtomicInteger retrievalDelaySeconds

resourceLock

private final DataFlowManagementServiceImpl.TimingReentrantLock resourceLock

Constructor Detail

DataFlowManagementServiceImpl

public DataFlowManagementServiceImpl(DataFlowDao flowDao,
                                     ClusterManagerProtocolSender sender)

Method Detail

start

public void start()

Description copied from interface: DataFlowManagementService

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

Specified by:

start in interface DataFlowManagementService

isRunning

public boolean isRunning()

Specified by:

isRunning in interface DataFlowManagementService

Returns:

true if the instance is started; false otherwise.

stop

public void stop()

Description copied from interface: DataFlowManagementService

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

Specified by:

stop in interface DataFlowManagementService

loadDataFlow

public ClusterDataFlow loadDataFlow()
                             throws DaoException

Description copied from interface: DataFlowManagementService

Loads the dataflow.

Specified by:

loadDataFlow in interface DataFlowManagementService

Returns:

the dataflow or null if no dataflow exists

Throws:

DaoException

updatePrimaryNode

public void updatePrimaryNode(NodeIdentifier nodeId)

Description copied from interface: DataFlowManagementService

Updates the dataflow with the given primary node identifier.

Specified by:

updatePrimaryNode in interface DataFlowManagementService

Parameters:

nodeId - the node identifier

updateControllerServices

public void updateControllerServices(byte[] controllerServiceBytes)
                              throws DaoException

Description copied from interface: DataFlowManagementService

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

Specified by:

updateControllerServices in interface DataFlowManagementService

Parameters:

controllerServiceBytes - services

Throws:

DaoException - ex

updateReportingTasks

public void updateReportingTasks(byte[] reportingTaskBytes)
                          throws DaoException

Description copied from interface: DataFlowManagementService

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

Specified by:

updateReportingTasks in interface DataFlowManagementService

Parameters:

reportingTaskBytes - tasks

Throws:

DaoException - ex

getPersistedFlowState

public PersistedFlowState getPersistedFlowState()

Specified by:

getPersistedFlowState in interface DataFlowManagementService

Returns:

the state of the flow

isFlowCurrent

public boolean isFlowCurrent()

Specified by:

isFlowCurrent in interface DataFlowManagementService

Returns:

true if the flow is current; false otherwise.

setPersistedFlowState

public void setPersistedFlowState(PersistedFlowState flowState)

Description copied from interface: DataFlowManagementService

Sets the state of the flow.

Specified by:

setPersistedFlowState in interface DataFlowManagementService

Parameters:

flowState - the state

See Also:

PersistedFlowState

getNodeIds

public Set<NodeIdentifier> getNodeIds()

Description copied from interface: DataFlowManagementService

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

Specified by:

getNodeIds in interface DataFlowManagementService

Returns:

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

setNodeIds

public void setNodeIds(Set<NodeIdentifier> nodeIds)

Description copied from interface: DataFlowManagementService

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

Specified by:

setNodeIds in interface DataFlowManagementService

Parameters:

nodeIds - the node identifiers

getRetrievalDelaySeconds

public int getRetrievalDelaySeconds()

Specified by:

getRetrievalDelaySeconds in interface DataFlowManagementService

Returns:

the retrieval delay in seconds

setRetrievalDelay

public void setRetrievalDelay(String retrievalDelay)

Description copied from interface: DataFlowManagementService

Sets the retrieval delay.

Specified by:

setRetrievalDelay in interface DataFlowManagementService

Parameters:

retrievalDelay - the retrieval delay in seconds

getSender

public ClusterManagerProtocolSender getSender()

getLastRetrievalTime

public long getLastRetrievalTime()