org.apache.nifi.cluster.flow

Interface DataFlowDao

All Known Implementing Classes:

DataFlowDaoImpl

public interface DataFlowDao

A data access object for loading and saving the flow managed by the cluster.

Method Summary

Methods

Modifier and Type	Method and Description
PersistedFlowState	getPersistedFlowState() Gets the state of the dataflow.
ClusterDataFlow	loadDataFlow() Loads the cluster's dataflow.
void	saveDataFlow(ClusterDataFlow dataFlow) Saves the cluster's dataflow.
void	setPersistedFlowState(PersistedFlowState flowState) Sets the state of the dataflow.

Method Detail

loadDataFlow

ClusterDataFlow loadDataFlow()
                             throws DaoException

Loads the cluster's dataflow.

Returns:

the dataflow or null if no dataflow exists

Throws:

DaoException - if the dataflow was unable to be loaded

saveDataFlow

void saveDataFlow(ClusterDataFlow dataFlow)
                  throws DaoException

Saves the cluster's dataflow.

Parameters:

dataFlow - flow

Throws:

DaoException - if the dataflow was unable to be saved

setPersistedFlowState

void setPersistedFlowState(PersistedFlowState flowState)
                           throws DaoException

Sets the state of the dataflow. If the dataflow does not exist, then an exception is thrown.

Parameters:

flowState - the state of the dataflow

Throws:

DaoException - if the state was unable to be updated

getPersistedFlowState

PersistedFlowState getPersistedFlowState()
                                         throws DaoException

Gets the state of the dataflow.

Returns:

the state of the dataflow

Throws:

DaoException - if the state was unable to be retrieved