org.apache.nifi.controller

Class FlowController

java.lang.Object

org.apache.nifi.controller.FlowController

All Implemented Interfaces:

Authorizable, ControllerServiceLookup, NodeTypeProvider, ReloadComponent, ReportingTaskProvider, QueueProvider, ControllerServiceProvider, IdentifierLookup, ProvenanceAuthorizableFactory, EventAccess

public class FlowController
extends java.lang.Object
implements EventAccess, ControllerServiceProvider, ReportingTaskProvider, QueueProvider, Authorizable, ProvenanceAuthorizableFactory, NodeTypeProvider, IdentifierLookup, ReloadComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION
static java.lang.String	DEFAULT_CONTENT_REPO_IMPLEMENTATION
static java.lang.String	DEFAULT_FLOWFILE_REPO_IMPLEMENTATION
static long	DEFAULT_GRACEFUL_SHUTDOWN_SECONDS
static double	DEFAULT_POSITION_SCALE_FACTOR_X
static double	DEFAULT_POSITION_SCALE_FACTOR_Y
static java.lang.String	DEFAULT_PROVENANCE_REPO_IMPLEMENTATION
static java.lang.String	DEFAULT_ROOT_GROUP_NAME
static java.lang.String	DEFAULT_SWAP_MANAGER_IMPLEMENTATION
static java.lang.String	GRACEFUL_SHUTDOWN_PERIOD
static int	METRICS_RESERVOIR_SIZE
static java.lang.String	ROOT_GROUP_ID_ALIAS
static java.lang.String	SCHEDULE_MINIMUM_NANOSECONDS

Fields inherited from interface org.apache.nifi.provenance.IdentifierLookup

EMPTY

Method Summary

Modifier and Type	Method and Description
void	addRootControllerService(ControllerServiceNode serviceNode)
boolean	areGroupsSame(java.lang.String id1, java.lang.String id2) Indicates whether or not the two ID's point to the same ProcessGroup.
static FlowController	createClusteredInstance(FlowFileEventRepository flowFileEventRepo, NiFiProperties properties, Authorizer authorizer, AuditService auditService, StringEncryptor encryptor, NodeProtocolSender protocolSender, BulletinRepository bulletinRepo, ClusterCoordinator clusterCoordinator, HeartbeatMonitor heartbeatMonitor, LeaderElectionManager leaderElectionManager, VariableRegistry variableRegistry)
Connection	createConnection(java.lang.String id, java.lang.String name, Connectable source, Connectable destination, java.util.Collection<java.lang.String> relationshipNames) Creates a connection between two Connectable objects.
ControllerServiceNode	createControllerService(java.lang.String type, java.lang.String id, BundleCoordinate bundleCoordinate, java.util.Set<java.net.URL> additionalUrls, boolean firstTimeAdded) Creates a new Controller Service of the specified type and assigns it the given id.
Funnel	createFunnel(java.lang.String id) Creates a funnel
Label	createLabel(java.lang.String id, java.lang.String text) Creates a new Label
Authorizable	createLocalDataAuthorizable(java.lang.String componentId) Generates an Authorizable object for the Data of the component with the given ID.
Port	createLocalInputPort(java.lang.String id, java.lang.String name) Creates a Port to use as an Input Port for a Process Group
Port	createLocalOutputPort(java.lang.String id, java.lang.String name) Creates a Port to use as an Output Port for a Process Group
FlowFilePrioritizer	createPrioritizer(java.lang.String type)
ProcessGroup	createProcessGroup(java.lang.String id) Creates a ProcessGroup with the given ID
ProcessorNode	createProcessor(java.lang.String type, java.lang.String id, BundleCoordinate coordinate) Creates a new ProcessorNode with the given type and identifier and initializes it invoking the methods annotated with OnAdded.
ProcessorNode	createProcessor(java.lang.String type, java.lang.String id, BundleCoordinate coordinate, boolean firstTimeAdded) Creates a new ProcessorNode with the given type and identifier and optionally initializes it.
ProcessorNode	createProcessor(java.lang.String type, java.lang.String id, BundleCoordinate coordinate, java.util.Set<java.net.URL> additionalUrls, boolean firstTimeAdded, boolean registerLogObserver) Creates a new ProcessorNode with the given type and identifier and optionally initializes it.
Authorizable	createRemoteDataAuthorizable(java.lang.String remoteGroupPortId) Generates an Authorizable object for the Data of the remote group port with the given ID.
Port	createRemoteInputPort(java.lang.String id, java.lang.String name) Creates a Port to use as an Input Port for the root Process Group, which is used for Site-to-Site communications
Port	createRemoteOutputPort(java.lang.String id, java.lang.String name) Creates a Port to use as an Output Port for the root Process Group, which is used for Site-to-Site communications and will queue flow files waiting to be delivered to remote instances
RemoteProcessGroup	createRemoteProcessGroup(java.lang.String id, java.lang.String uris) Creates a new Remote Process Group with the given ID that points to the given URI
ReportingTaskNode	createReportingTask(java.lang.String type, BundleCoordinate bundleCoordinate)
ReportingTaskNode	createReportingTask(java.lang.String type, BundleCoordinate bundleCoordinate, boolean firstTimeAdded)
ReportingTaskNode	createReportingTask(java.lang.String type, java.lang.String id, BundleCoordinate bundleCoordinate, boolean firstTimeAdded) Creates a new instance of a reporting task
ReportingTaskNode	createReportingTask(java.lang.String type, java.lang.String id, BundleCoordinate bundleCoordinate, java.util.Set<java.net.URL> additionalUrls, boolean firstTimeAdded, boolean register)
static FlowController	createStandaloneInstance(FlowFileEventRepository flowFileEventRepo, NiFiProperties properties, Authorizer authorizer, AuditService auditService, StringEncryptor encryptor, BulletinRepository bulletinRepo, VariableRegistry variableRegistry)
java.util.concurrent.CompletableFuture<java.lang.Void>	disableControllerService(ControllerServiceNode serviceNode) Disables the given controller service so that it cannot be used by other components.
java.util.Set<ConfiguredComponent>	disableReferencingServices(ControllerServiceNode serviceNode) Disables any Controller Service that references the provided Controller Service.
void	disableReportingTask(ReportingTaskNode reportingTaskNode) Disables the ability to schedul the reporting task to run
java.util.concurrent.CompletableFuture<java.lang.Void>	enableControllerService(ControllerServiceNode serviceNode) Enables the given controller service that it can be used by other components.
void	enableControllerServices(java.util.Collection<ControllerServiceNode> serviceNodes) Enables the collection of services.
java.util.Set<ConfiguredComponent>	enableReferencingServices(ControllerServiceNode serviceNode) Enables all Controller Services that are referencing the given service.
void	enableReportingTask(ReportingTaskNode reportingTaskNode) Enables the reporting task to be scheduled to run
int	getActiveThreadCount()
java.util.Set<ControllerServiceNode>	getAllControllerServices()
java.util.Collection<FlowFileQueue>	getAllQueues()
java.util.Set<ReportingTaskNode>	getAllReportingTasks()
Authorizer	getAuthorizer()
BulletinRepository	getBulletinRepository()
java.lang.String	getComments()
java.util.List<java.lang.String>	getComponentIdentifiers()
java.util.List<java.lang.String>	getComponentTypes()
Connection	getConnection(java.lang.String id)
StatusHistoryDTO	getConnectionStatusHistory(java.lang.String connectionId)
StatusHistoryDTO	getConnectionStatusHistory(java.lang.String connectionId, java.util.Date startTime, java.util.Date endTime, int preferredDataPoints)
java.io.InputStream	getContent(FlowFileRecord flowFile, java.lang.String requestor, java.lang.String requestUri)
java.io.InputStream	getContent(ProvenanceEventRecord provEvent, ContentDirection direction, java.lang.String requestor, java.lang.String requestUri)
ContentAvailability	getContentAvailability(ProvenanceEventRecord event)
ControllerService	getControllerService(java.lang.String serviceIdentifier)
ControllerService	getControllerServiceForComponent(java.lang.String serviceIdentifier, java.lang.String componentId)
java.util.Set<java.lang.String>	getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType)
java.util.Set<java.lang.String>	getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType, java.lang.String groupId)
java.lang.String	getControllerServiceName(java.lang.String serviceIdentifier)
ControllerServiceNode	getControllerServiceNode(java.lang.String serviceIdentifier)
ProcessGroupStatus	getControllerStatus() Returns the status of all components in the controller.
java.util.List<Counter>	getCounters()
ExtensionManager	getExtensionManager()
java.util.List<Action>	getFlowChanges(int firstActionId, int maxActions) Obtains flow changes starting with (and including) the given action ID.
java.util.Set<java.lang.Class>	getFlowFileComparatorClasses()
java.util.Set<java.lang.Class>	getFlowFileProcessorClasses()
Funnel	getFunnel(java.lang.String id)
ProcessGroup	getGroup(java.lang.String id) Returns the ProcessGroup with the given ID
ProcessGroupStatus	getGroupStatus(ProcessGroup group, RepositoryStatusReport statusReport, org.apache.commons.collections4.Predicate<Authorizable> isAuthorized) Returns the status for the components in the specified group with the specified report.
ProcessGroupStatus	getGroupStatus(java.lang.String groupId) Returns the status of all components in the specified group.
ProcessGroupStatus	getGroupStatus(java.lang.String groupId, NiFiUser user) Returns the status for components in the specified group.
ProcessGroupStatus	getGroupStatus(java.lang.String groupId, RepositoryStatusReport statusReport) Returns the status for the components in the specified group with the specified report.
ProcessGroupStatus	getGroupStatus(java.lang.String groupId, RepositoryStatusReport statusReport, NiFiUser user) Returns the status for the components in the specified group with the specified report.
int	getHeartbeatDelaySeconds()
Heartbeater	getHeartbeater()
Port	getInputPort(java.lang.String id)
java.lang.String	getInstanceId()
int	getMaxEventDrivenThreadCount()
int	getMaxTimerDrivenThreadCount()
java.lang.String	getName()
NodeIdentifier	getNodeId() The node identifier of this instance.
Port	getOutputPort(java.lang.String id)
Authorizable	getParentAuthorizable() The parent for this Authorizable.
StatusHistoryDTO	getProcessGroupStatusHistory(java.lang.String processGroupId)
StatusHistoryDTO	getProcessGroupStatusHistory(java.lang.String processGroupId, java.util.Date startTime, java.util.Date endTime, int preferredDataPoints)
ProcessorNode	getProcessorNode(java.lang.String id)
StatusHistoryDTO	getProcessorStatusHistory(java.lang.String processorId, boolean includeCounters)
StatusHistoryDTO	getProcessorStatusHistory(java.lang.String processorId, java.util.Date startTime, java.util.Date endTime, int preferredDataPoints, boolean includeCounters)
ProcessScheduler	getProcessScheduler()
java.util.List<ProvenanceEventRecord>	getProvenanceEvents(long firstEventId, int maxRecords) Convenience method to obtain Provenance Events starting with (and including) the given ID.
ProvenanceRepository	getProvenanceRepository()
java.util.List<java.lang.String>	getQueueIdentifiers()
StatusHistoryDTO	getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId)
StatusHistoryDTO	getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId, java.util.Date startTime, java.util.Date endTime, int preferredDataPoints)
java.lang.Integer	getRemoteSiteListeningHttpPort()
java.lang.Integer	getRemoteSiteListeningPort()
ReportingTaskNode	getReportingTaskNode(java.lang.String taskId)
Resource	getResource() The Resource for this Authorizable.
ControllerServiceNode	getRootControllerService(java.lang.String serviceIdentifier)
java.util.Set<ControllerServiceNode>	getRootControllerServices()
ProcessGroup	getRootGroup()
java.lang.String	getRootGroupId()
SnippetManager	getSnippetManager()
StateManagerProvider	getStateManagerProvider()
SystemDiagnostics	getSystemDiagnostics()
QueueSize	getTotalFlowFileCount(ProcessGroup group)
void	heartbeat()
void	initializeFlow()
void	instantiateSnippet(ProcessGroup group, FlowSnippetDTO dto) Creates an instance of the given snippet and adds the components to the given group
boolean	isClustered()
boolean	isConfiguredForClustering()
boolean	isConnected()
boolean	isControllerServiceEnabled(ControllerService service)
boolean	isControllerServiceEnabled(java.lang.String serviceIdentifier)
boolean	isControllerServiceEnabling(java.lang.String serviceIdentifier)
boolean	isFlowSynchronized()
boolean	isHeartbeating()
boolean	isInitialized()
boolean	isPrimary()
java.lang.Boolean	isRemoteSiteCommsSecure()
boolean	isTerminated()
void	onConnectionAdded(Connection connection)
void	onConnectionRemoved(Connection connection)
void	onFlowInitialized(boolean startDelayedComponents) Causes any processors that were added to the flow with a 'delayStart' flag of true to now start
void	onFunnelAdded(Funnel funnel)
void	onFunnelRemoved(Funnel funnel)
void	onInputPortAdded(Port inputPort)
void	onInputPortRemoved(Port inputPort)
void	onOutputPortAdded(Port outputPort)
void	onOutputPortRemoved(Port outputPort)
void	onProcessGroupAdded(ProcessGroup group)
void	onProcessGroupRemoved(ProcessGroup group)
void	onProcessorAdded(ProcessorNode procNode)
void	onProcessorRemoved(ProcessorNode procNode)
void	reload(ControllerServiceNode existingNode, java.lang.String newType, BundleCoordinate bundleCoordinate, java.util.Set<java.net.URL> additionalUrls) Changes the underlying ControllerService held by the node to an instance of the new type.
void	reload(ProcessorNode existingNode, java.lang.String newType, BundleCoordinate bundleCoordinate, java.util.Set<java.net.URL> additionalUrls) Changes the underlying Processor held by the node to an instance of the new type.
void	reload(ReportingTaskNode existingNode, java.lang.String newType, BundleCoordinate bundleCoordinate, java.util.Set<java.net.URL> additionalUrls) Changes the underlying ReportingTask held by the node to an instance of the new type.
void	removeControllerService(ControllerServiceNode serviceNode) Removes the given Controller Service from the flow.
void	removeReportingTask(ReportingTaskNode reportingTaskNode) Removes the given reporting task from the flow
void	removeRootControllerService(ControllerServiceNode service)
ProvenanceEventRecord	replayFlowFile(long provenanceEventRecordId, NiFiUser user)
ProvenanceEventRecord	replayFlowFile(ProvenanceEventRecord event, NiFiUser user)
Counter	resetCounter(java.lang.String identifier)
void	resumeHeartbeats() Notifies controller that the sending of heartbeats should be re-enabled.
java.util.Set<ConfiguredComponent>	scheduleReferencingComponents(ControllerServiceNode serviceNode) Schedules any schedulable component (Processor, ReportingTask) that is referencing the given Controller Service to run.
void	serialize(FlowSerializer serializer, java.io.OutputStream os) Serializes the current state of the controller to the given OutputStream
void	setClustered(boolean clustered, java.lang.String clusterInstanceId) Sets whether this instance is clustered.
void	setComments(java.lang.String comments) Sets the comments
void	setConnectionStatus(NodeConnectionStatus connectionStatus)
void	setMaxEventDrivenThreadCount(int maxThreadCount)
void	setMaxTimerDrivenThreadCount(int maxThreadCount)
void	setName(java.lang.String name) Sets the name for the Root Group, which also changes the name for the controller.
void	setNodeId(NodeIdentifier nodeId) Sets the node identifier for this instance.
void	setPrimary(boolean primary)
void	shutdown(boolean kill) Triggers the controller to begin shutdown, stopping all processors and terminating the scheduling engine.
void	startConnectable(Connectable connectable)
void	startHeartbeating() Starts heartbeating to the cluster.
void	startProcessGroup(java.lang.String groupId)
void	startProcessor(java.lang.String parentGroupId, java.lang.String processorId)
void	startReportingTask(ReportingTaskNode reportingTaskNode) Begins scheduling the reporting task to run and invokes appropriate lifecycle methods
void	startTransmitting(RemoteGroupPort remoteGroupPort)
void	stopAllProcessors()
void	stopConnectable(Connectable connectable)
void	stopHeartbeating() Stops heartbeating to the cluster.
void	stopProcessGroup(java.lang.String groupId)
void	stopProcessor(java.lang.String parentGroupId, java.lang.String processorId)
void	stopReportingTask(ReportingTaskNode reportingTaskNode) Stops scheduling the reporting task to run and invokes appropriate lifecycle methods
void	suspendHeartbeats() Notifies controller that the sending of heartbeats should be temporarily suspended.
void	synchronize(FlowSynchronizer synchronizer, DataFlow dataFlow) Synchronizes this controller with the proposed flow.
java.util.Set<ConfiguredComponent>	unscheduleReferencingComponents(ControllerServiceNode serviceNode) Recursively unschedules all schedulable components (Processors and Reporting Tasks) that reference the given Controller Service.
PortDTO	updateInputPort(java.lang.String parentGroupId, PortDTO dto)
PortDTO	updateOutputPort(java.lang.String parentGroupId, PortDTO dto)
void	updateProcessGroup(ProcessGroupDTO dto) Updates the process group corresponding to the specified DTO.
void	verifyCanDisableReferencingServices(ControllerServiceNode serviceNode) Verifies that all Controller Services referencing the provided Controller Service can be disabled.
void	verifyCanEnableReferencingServices(ControllerServiceNode serviceNode) Verifies that all Controller Services referencing the provided ControllerService can be enabled.
void	verifyCanScheduleReferencingComponents(ControllerServiceNode serviceNode) Verifies that all enabled Processors referencing the ControllerService (or a service that depends on the provided service) can be scheduled to run.
void	verifyCanStopReferencingComponents(ControllerServiceNode serviceNode) Verifies that all running Processors and Reporting Tasks referencing the Controller Service (or a service that depends on the provided service) can be stopped.
void	verifyComponentTypesInSnippet(FlowSnippetDTO templateContents)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.nifi.authorization.resource.Authorizable

authorize, authorize, checkAuthorization, checkAuthorization, getRequestedResource, isAuthorized

Methods inherited from interface org.apache.nifi.provenance.IdentifierLookup

invertComponentIdentifiers, invertComponentTypes, invertList, invertQueueIdentifiers

Field Detail

DEFAULT_FLOWFILE_REPO_IMPLEMENTATION

public static final java.lang.String DEFAULT_FLOWFILE_REPO_IMPLEMENTATION

See Also:

Constant Field Values

DEFAULT_CONTENT_REPO_IMPLEMENTATION

public static final java.lang.String DEFAULT_CONTENT_REPO_IMPLEMENTATION

See Also:

Constant Field Values

DEFAULT_PROVENANCE_REPO_IMPLEMENTATION

public static final java.lang.String DEFAULT_PROVENANCE_REPO_IMPLEMENTATION

See Also:

Constant Field Values

DEFAULT_SWAP_MANAGER_IMPLEMENTATION

public static final java.lang.String DEFAULT_SWAP_MANAGER_IMPLEMENTATION

See Also:

Constant Field Values

DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION

public static final java.lang.String DEFAULT_COMPONENT_STATUS_REPO_IMPLEMENTATION

See Also:

Constant Field Values

SCHEDULE_MINIMUM_NANOSECONDS

public static final java.lang.String SCHEDULE_MINIMUM_NANOSECONDS

See Also:

Constant Field Values

GRACEFUL_SHUTDOWN_PERIOD

public static final java.lang.String GRACEFUL_SHUTDOWN_PERIOD

See Also:

Constant Field Values

DEFAULT_GRACEFUL_SHUTDOWN_SECONDS

public static final long DEFAULT_GRACEFUL_SHUTDOWN_SECONDS

See Also:

Constant Field Values

METRICS_RESERVOIR_SIZE

public static final int METRICS_RESERVOIR_SIZE

See Also:

Constant Field Values

ROOT_GROUP_ID_ALIAS

public static final java.lang.String ROOT_GROUP_ID_ALIAS

See Also:

Constant Field Values

DEFAULT_ROOT_GROUP_NAME

public static final java.lang.String DEFAULT_ROOT_GROUP_NAME

See Also:

Constant Field Values

DEFAULT_POSITION_SCALE_FACTOR_X

public static final double DEFAULT_POSITION_SCALE_FACTOR_X

See Also:

Constant Field Values

DEFAULT_POSITION_SCALE_FACTOR_Y

public static final double DEFAULT_POSITION_SCALE_FACTOR_Y

See Also:

Constant Field Values

Method Detail

createStandaloneInstance

public static FlowController createStandaloneInstance(FlowFileEventRepository flowFileEventRepo,
                                                      NiFiProperties properties,
                                                      Authorizer authorizer,
                                                      AuditService auditService,
                                                      StringEncryptor encryptor,
                                                      BulletinRepository bulletinRepo,
                                                      VariableRegistry variableRegistry)

createClusteredInstance

public static FlowController createClusteredInstance(FlowFileEventRepository flowFileEventRepo,
                                                     NiFiProperties properties,
                                                     Authorizer authorizer,
                                                     AuditService auditService,
                                                     StringEncryptor encryptor,
                                                     NodeProtocolSender protocolSender,
                                                     BulletinRepository bulletinRepo,
                                                     ClusterCoordinator clusterCoordinator,
                                                     HeartbeatMonitor heartbeatMonitor,
                                                     LeaderElectionManager leaderElectionManager,
                                                     VariableRegistry variableRegistry)

getParentAuthorizable

public Authorizable getParentAuthorizable()

Description copied from interface: Authorizable

The parent for this Authorizable. May be null.

Specified by:

getParentAuthorizable in interface Authorizable

Returns:

the parent authorizable or null

getResource

public Resource getResource()

Description copied from interface: Authorizable

The Resource for this Authorizable.

Specified by:

getResource in interface Authorizable

Returns:

the resource

initializeFlow

public void initializeFlow()
                    throws java.io.IOException

Throws:

java.io.IOException

onFlowInitialized

public void onFlowInitialized(boolean startDelayedComponents)

Causes any processors that were added to the flow with a 'delayStart' flag of true to now start

Parameters:

startDelayedComponents - true if start

createConnection

public Connection createConnection(java.lang.String id,
                                   java.lang.String name,
                                   Connectable source,
                                   Connectable destination,
                                   java.util.Collection<java.lang.String> relationshipNames)

Creates a connection between two Connectable objects.

Parameters:

id - required ID of the connection

name - the name of the connection, or null to leave the connection unnamed

source - required source

destination - required destination

relationshipNames - required collection of relationship names

Returns:

Throws:

java.lang.NullPointerException - if the ID, source, destination, or set of relationships is null.

java.lang.IllegalArgumentException - if relationships is an empty collection

createLabel

public Label createLabel(java.lang.String id,
                         java.lang.String text)

Creates a new Label

Parameters:

id - identifier

text - label text

Returns:

new label

Throws:

java.lang.NullPointerException - if either argument is null

createFunnel

public Funnel createFunnel(java.lang.String id)

Creates a funnel

Parameters:

id - funnel id

Returns:

new funnel

createLocalInputPort

public Port createLocalInputPort(java.lang.String id,
                                 java.lang.String name)

Creates a Port to use as an Input Port for a Process Group

Parameters:

id - port identifier

name - port name

Returns:

new port

Throws:

java.lang.NullPointerException - if the ID or name is not unique

java.lang.IllegalStateException - if an Input Port already exists with the same name or id.

createLocalOutputPort

public Port createLocalOutputPort(java.lang.String id,
                                  java.lang.String name)

Creates a Port to use as an Output Port for a Process Group

Parameters:

id - port id

name - port name

Returns:

new port

Throws:

java.lang.NullPointerException - if the ID or name is not unique

java.lang.IllegalStateException - if an Input Port already exists with the same name or id.

createProcessGroup

public ProcessGroup createProcessGroup(java.lang.String id)

Creates a ProcessGroup with the given ID

Parameters:

id - group id

Returns:

new group

Throws:

java.lang.NullPointerException - if the argument is null

createProcessor

public ProcessorNode createProcessor(java.lang.String type,
                                     java.lang.String id,
                                     BundleCoordinate coordinate)
                              throws ProcessorInstantiationException

Creates a new ProcessorNode with the given type and identifier and initializes it invoking the methods annotated with OnAdded.

Parameters:

type - processor type

id - processor id

coordinate - the coordinate of the bundle for this processor

Returns:

new processor

Throws:

java.lang.NullPointerException - if either arg is null

ProcessorInstantiationException - if the processor cannot be instantiated for any reason

createProcessor

public ProcessorNode createProcessor(java.lang.String type,
                                     java.lang.String id,
                                     BundleCoordinate coordinate,
                                     boolean firstTimeAdded)
                              throws ProcessorInstantiationException

Creates a new ProcessorNode with the given type and identifier and optionally initializes it.

Parameters:

type - the fully qualified Processor class name

id - the unique ID of the Processor

coordinate - the bundle coordinate for this processor

firstTimeAdded - whether or not this is the first time this Processor is added to the graph. If true, will invoke methods annotated with the OnAdded annotation.

Returns:

new processor node

Throws:

java.lang.NullPointerException - if either arg is null

ProcessorInstantiationException - if the processor cannot be instantiated for any reason

createProcessor

public ProcessorNode createProcessor(java.lang.String type,
                                     java.lang.String id,
                                     BundleCoordinate coordinate,
                                     java.util.Set<java.net.URL> additionalUrls,
                                     boolean firstTimeAdded,
                                     boolean registerLogObserver)
                              throws ProcessorInstantiationException

Creates a new ProcessorNode with the given type and identifier and optionally initializes it.

Parameters:

type - the fully qualified Processor class name

id - the unique ID of the Processor

coordinate - the bundle coordinate for this processor

firstTimeAdded - whether or not this is the first time this Processor is added to the graph. If true, will invoke methods annotated with the OnAdded annotation.

Returns:

new processor node

Throws:

java.lang.NullPointerException - if either arg is null

ProcessorInstantiationException - if the processor cannot be instantiated for any reason

reload

public void reload(ProcessorNode existingNode,
                   java.lang.String newType,
                   BundleCoordinate bundleCoordinate,
                   java.util.Set<java.net.URL> additionalUrls)
            throws ProcessorInstantiationException

Description copied from interface: ReloadComponent

Changes the underlying Processor held by the node to an instance of the new type.

Specified by:

reload in interface ReloadComponent

Parameters:

existingNode - the node being being updated

newType - the fully qualified class name of the new type

bundleCoordinate - the bundle coordinate of the new type

additionalUrls - additional URLs to be added to the instance class loader of the new component

Throws:

ProcessorInstantiationException

getExtensionManager

public ExtensionManager getExtensionManager()

Returns:

the ExtensionManager used for instantiating Processors, Prioritizers, etc.

getInstanceId

public java.lang.String getInstanceId()

getHeartbeater

public Heartbeater getHeartbeater()

getBulletinRepository

public BulletinRepository getBulletinRepository()

Returns:

the BulletinRepository for storing and retrieving Bulletins

getSnippetManager

public SnippetManager getSnippetManager()

getStateManagerProvider

public StateManagerProvider getStateManagerProvider()

getAuthorizer

public Authorizer getAuthorizer()

createRemoteInputPort

public Port createRemoteInputPort(java.lang.String id,
                                  java.lang.String name)

Creates a Port to use as an Input Port for the root Process Group, which is used for Site-to-Site communications

Parameters:

id - port id

name - port name

Returns:

new port

Throws:

java.lang.NullPointerException - if the ID or name is not unique

java.lang.IllegalStateException - if an Input Port already exists with the same name or id.

createRemoteOutputPort

public Port createRemoteOutputPort(java.lang.String id,
                                   java.lang.String name)

Creates a Port to use as an Output Port for the root Process Group, which is used for Site-to-Site communications and will queue flow files waiting to be delivered to remote instances

Parameters:

id - port id

name - port name

Returns:

new port

Throws:

java.lang.NullPointerException - if the ID or name is not unique

java.lang.IllegalStateException - if an Input Port already exists with the same name or id.

createRemoteProcessGroup

public RemoteProcessGroup createRemoteProcessGroup(java.lang.String id,
                                                   java.lang.String uris)

Creates a new Remote Process Group with the given ID that points to the given URI

Parameters:

id - group id

uris - group uris, multiple url can be specified in comma-separated format

Returns:

new group

Throws:

java.lang.NullPointerException - if either argument is null

java.lang.IllegalArgumentException - if uri is not a valid URI.

getRootGroup

public ProcessGroup getRootGroup()

getName

public java.lang.String getName()

Returns:

the name of this controller, which is also the name of the Root Group.

setName

public void setName(java.lang.String name)

Sets the name for the Root Group, which also changes the name for the controller.

Parameters:

name - of root group

getComments

public java.lang.String getComments()

Returns:

the comments of this controller, which is also the comment of the Root Group

setComments

public void setComments(java.lang.String comments)

Sets the comments

Parameters:

comments - for the Root Group, which also changes the comment for the controller

isTerminated

public boolean isTerminated()

Returns:

true if the scheduling engine for this controller has been terminated.

shutdown

public void shutdown(boolean kill)

Triggers the controller to begin shutdown, stopping all processors and terminating the scheduling engine. After calling this method, the isTerminated() method will indicate whether or not the shutdown has finished.

Parameters:

kill - if true, attempts to stop all active threads, but makes no guarantee that this will happen

Throws:

java.lang.IllegalStateException - if the controller is already stopped or currently in the processor of stopping

serialize

public void serialize(FlowSerializer serializer,
                      java.io.OutputStream os)
               throws FlowSerializationException

Serializes the current state of the controller to the given OutputStream

Parameters:

serializer - serializer

os - stream

Throws:

FlowSerializationException - if serialization of the flow fails for any reason

synchronize

public void synchronize(FlowSynchronizer synchronizer,
                        DataFlow dataFlow)
                 throws FlowSerializationException,
                        FlowSynchronizationException,
                        UninheritableFlowException,
                        MissingBundleException

Synchronizes this controller with the proposed flow. For more details, see FlowSynchronizer.sync(FlowController, DataFlow, StringEncryptor).

Parameters:

synchronizer - synchronizer

dataFlow - the flow to load the controller with. If the flow is null or zero length, then the controller must not have a flow or else an UninheritableFlowException will be thrown.

Throws:

FlowSerializationException - if proposed flow is not a valid flow configuration file

UninheritableFlowException - if the proposed flow cannot be loaded by the controller because in doing so would risk orphaning flow files

FlowSynchronizationException - if updates to the controller failed. If this exception is thrown, then the controller should be considered unsafe to be used

MissingBundleException - if the proposed flow cannot be loaded by the controller because it contains a bundle that does not exist in the controller

getMaxTimerDrivenThreadCount

public int getMaxTimerDrivenThreadCount()

Returns:

the currently configured maximum number of threads that can be used for executing processors at any given time.

getMaxEventDrivenThreadCount

public int getMaxEventDrivenThreadCount()

setMaxTimerDrivenThreadCount

public void setMaxTimerDrivenThreadCount(int maxThreadCount)

setMaxEventDrivenThreadCount

public void setMaxEventDrivenThreadCount(int maxThreadCount)

getRootGroupId

public java.lang.String getRootGroupId()

Returns:

the ID of the root group

getSystemDiagnostics

public SystemDiagnostics getSystemDiagnostics()

updateProcessGroup

public void updateProcessGroup(ProcessGroupDTO dto)
                        throws ProcessorInstantiationException

Updates the process group corresponding to the specified DTO. Any field in DTO that is null (with the exception of the required ID) will be ignored.

Parameters:

dto - group

Throws:

ProcessorInstantiationException

java.lang.IllegalStateException - if no process group can be found with the ID of DTO or with the ID of the DTO's parentGroupId, if the template ID specified is invalid, or if the DTO's Parent Group ID changes but the parent group has incoming or outgoing connections

java.lang.NullPointerException - if the DTO or its ID is null

instantiateSnippet

public void instantiateSnippet(ProcessGroup group,
                               FlowSnippetDTO dto)
                        throws ProcessorInstantiationException

Creates an instance of the given snippet and adds the components to the given group

Parameters:

group - group

dto - dto

Throws:

java.lang.NullPointerException - if either argument is null

java.lang.IllegalStateException - if the snippet is not valid because a component in the snippet has an ID that is not unique to this flow, or because it shares an Input Port or Output Port at the root level whose name already exists in the given ProcessGroup, or because the Template contains a Processor or a Prioritizer whose class is not valid within this instance of NiFi.

ProcessorInstantiationException - if unable to instantiate a processor

verifyComponentTypesInSnippet

public void verifyComponentTypesInSnippet(FlowSnippetDTO templateContents)

areGroupsSame

public boolean areGroupsSame(java.lang.String id1,
                             java.lang.String id2)

Indicates whether or not the two ID's point to the same ProcessGroup. If either id is null, will return false.

Parameters:

id1 - group id

id2 - other group id

Returns:

true if same

createPrioritizer

public FlowFilePrioritizer createPrioritizer(java.lang.String type)
                                      throws java.lang.InstantiationException,
                                             java.lang.IllegalAccessException,
                                             java.lang.ClassNotFoundException

Throws:

java.lang.InstantiationException

java.lang.IllegalAccessException

java.lang.ClassNotFoundException

updateInputPort

public PortDTO updateInputPort(java.lang.String parentGroupId,
                               PortDTO dto)

updateOutputPort

public PortDTO updateOutputPort(java.lang.String parentGroupId,
                                PortDTO dto)

getFlowFileProcessorClasses

public java.util.Set<java.lang.Class> getFlowFileProcessorClasses()

getFlowFileComparatorClasses

public java.util.Set<java.lang.Class> getFlowFileComparatorClasses()

getGroup

public ProcessGroup getGroup(java.lang.String id)

Returns the ProcessGroup with the given ID

Parameters:

id - group id

Returns:

the process group or null if not group is found

onProcessGroupAdded

public void onProcessGroupAdded(ProcessGroup group)

onProcessGroupRemoved

public void onProcessGroupRemoved(ProcessGroup group)

onProcessorAdded

public void onProcessorAdded(ProcessorNode procNode)

onProcessorRemoved

public void onProcessorRemoved(ProcessorNode procNode)

getProcessorNode

public ProcessorNode getProcessorNode(java.lang.String id)

onConnectionAdded

public void onConnectionAdded(Connection connection)

onConnectionRemoved

public void onConnectionRemoved(Connection connection)

getConnection

public Connection getConnection(java.lang.String id)

onInputPortAdded

public void onInputPortAdded(Port inputPort)

onInputPortRemoved

public void onInputPortRemoved(Port inputPort)

getInputPort

public Port getInputPort(java.lang.String id)

onOutputPortAdded

public void onOutputPortAdded(Port outputPort)

onOutputPortRemoved

public void onOutputPortRemoved(Port outputPort)

getOutputPort

public Port getOutputPort(java.lang.String id)

onFunnelAdded

public void onFunnelAdded(Funnel funnel)

onFunnelRemoved

public void onFunnelRemoved(Funnel funnel)

getFunnel

public Funnel getFunnel(java.lang.String id)

getControllerStatus

public ProcessGroupStatus getControllerStatus()

Returns the status of all components in the controller. This request is not in the context of a user so the results will be unfiltered.

Specified by:

getControllerStatus in interface EventAccess

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(java.lang.String groupId)

Returns the status of all components in the specified group. This request is not in the context of a user so the results will be unfiltered.

Specified by:

getGroupStatus in interface EventAccess

Parameters:

groupId - group id

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(java.lang.String groupId,
                                         NiFiUser user)

Returns the status for components in the specified group. This request is made by the specified user so the results will be filtered accordingly.

Parameters:

groupId - group id

user - user making request

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(java.lang.String groupId,
                                         RepositoryStatusReport statusReport)

Returns the status for the components in the specified group with the specified report. This request is not in the context of a user so the results will be unfiltered.

Parameters:

groupId - group id

statusReport - report

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(java.lang.String groupId,
                                         RepositoryStatusReport statusReport,
                                         NiFiUser user)

Returns the status for the components in the specified group with the specified report. This request is made by the specified user so the results will be filtered accordingly.

Parameters:

groupId - group id

statusReport - report

user - user making request

Returns:

the component status

getGroupStatus

public ProcessGroupStatus getGroupStatus(ProcessGroup group,
                                         RepositoryStatusReport statusReport,
                                         org.apache.commons.collections4.Predicate<Authorizable> isAuthorized)

Returns the status for the components in the specified group with the specified report. The results will be filtered by executing the specified predicate.

Parameters:

group - group id

statusReport - report

isAuthorized - is authorized check

Returns:

the component status

startProcessor

public void startProcessor(java.lang.String parentGroupId,
                           java.lang.String processorId)

isInitialized

public boolean isInitialized()

isFlowSynchronized

public boolean isFlowSynchronized()

startConnectable

public void startConnectable(Connectable connectable)

stopConnectable

public void stopConnectable(Connectable connectable)

startTransmitting

public void startTransmitting(RemoteGroupPort remoteGroupPort)

stopProcessor

public void stopProcessor(java.lang.String parentGroupId,
                          java.lang.String processorId)

stopAllProcessors

public void stopAllProcessors()

startProcessGroup

public void startProcessGroup(java.lang.String groupId)

stopProcessGroup

public void stopProcessGroup(java.lang.String groupId)

createReportingTask

public ReportingTaskNode createReportingTask(java.lang.String type,
                                             BundleCoordinate bundleCoordinate)
                                      throws ReportingTaskInstantiationException

Throws:

ReportingTaskInstantiationException

createReportingTask

public ReportingTaskNode createReportingTask(java.lang.String type,
                                             BundleCoordinate bundleCoordinate,
                                             boolean firstTimeAdded)
                                      throws ReportingTaskInstantiationException

Throws:

ReportingTaskInstantiationException

createReportingTask

public ReportingTaskNode createReportingTask(java.lang.String type,
                                             java.lang.String id,
                                             BundleCoordinate bundleCoordinate,
                                             boolean firstTimeAdded)
                                      throws ReportingTaskInstantiationException

Description copied from interface: ReportingTaskProvider

Creates a new instance of a reporting task

Specified by:

createReportingTask in interface ReportingTaskProvider

Parameters:

type - the type (fully qualified class name) of the reporting task to instantiate

id - the identifier for the Reporting Task

bundleCoordinate - the bundle coordinate for the type of reporting task

firstTimeAdded - whether or not this is the first time that the reporting task is being added to the flow. I.e., this will be true only when the user adds the reporting task to the flow, not when the flow is being restored after a restart of the software

Returns:

the ReportingTaskNode that is used to manage the reporting task

Throws:

ReportingTaskInstantiationException - if unable to create the Reporting Task

createReportingTask

public ReportingTaskNode createReportingTask(java.lang.String type,
                                             java.lang.String id,
                                             BundleCoordinate bundleCoordinate,
                                             java.util.Set<java.net.URL> additionalUrls,
                                             boolean firstTimeAdded,
                                             boolean register)
                                      throws ReportingTaskInstantiationException

Throws:

ReportingTaskInstantiationException

reload

public void reload(ReportingTaskNode existingNode,
                   java.lang.String newType,
                   BundleCoordinate bundleCoordinate,
                   java.util.Set<java.net.URL> additionalUrls)
            throws ReportingTaskInstantiationException

Description copied from interface: ReloadComponent

Changes the underlying ReportingTask held by the node to an instance of the new type.

Specified by:

reload in interface ReloadComponent

Parameters:

existingNode - the ReportingTaskNode being updated

newType - the fully qualified class name of the new type

bundleCoordinate - the bundle coordinate of the new type

additionalUrls - additional URLs to be added to the instance class loader of the new component

Throws:

ReportingTaskInstantiationException - if unable to create an instance of the new type

getReportingTaskNode

public ReportingTaskNode getReportingTaskNode(java.lang.String taskId)

Specified by:

getReportingTaskNode in interface ReportingTaskProvider

Parameters:

taskId - of node

Returns:

the reporting task that has the given identifier, or null if no reporting task exists with that ID

startReportingTask

public void startReportingTask(ReportingTaskNode reportingTaskNode)

Description copied from interface: ReportingTaskProvider

Begins scheduling the reporting task to run and invokes appropriate lifecycle methods

Specified by:

startReportingTask in interface ReportingTaskProvider

stopReportingTask

public void stopReportingTask(ReportingTaskNode reportingTaskNode)

Description copied from interface: ReportingTaskProvider

Stops scheduling the reporting task to run and invokes appropriate lifecycle methods

Specified by:

stopReportingTask in interface ReportingTaskProvider

removeReportingTask

public void removeReportingTask(ReportingTaskNode reportingTaskNode)

Description copied from interface: ReportingTaskProvider

Removes the given reporting task from the flow

Specified by:

removeReportingTask in interface ReportingTaskProvider

getAllReportingTasks

public java.util.Set<ReportingTaskNode> getAllReportingTasks()

Specified by:

getAllReportingTasks in interface ReportingTaskProvider

Returns:

a Set of all Reporting Tasks that exist for this service provider

createControllerService

public ControllerServiceNode createControllerService(java.lang.String type,
                                                     java.lang.String id,
                                                     BundleCoordinate bundleCoordinate,
                                                     java.util.Set<java.net.URL> additionalUrls,
                                                     boolean firstTimeAdded)

Description copied from interface: ControllerServiceProvider

Creates a new Controller Service of the specified type and assigns it the given id. If firstTimeadded is true, calls any methods that are annotated with OnAdded

Specified by:

createControllerService in interface ControllerServiceProvider

Parameters:

type - of service

id - of service

bundleCoordinate - the coordinate of the bundle for the service

additionalUrls - optional additional URL resources to add to the class loader of the component

firstTimeAdded - for service

Returns:

the service node

reload

public void reload(ControllerServiceNode existingNode,
                   java.lang.String newType,
                   BundleCoordinate bundleCoordinate,
                   java.util.Set<java.net.URL> additionalUrls)
            throws ControllerServiceInstantiationException

Description copied from interface: ReloadComponent

Changes the underlying ControllerService held by the node to an instance of the new type.

Specified by:

reload in interface ReloadComponent

Parameters:

existingNode - the node being being updated

newType - the fully qualified class name of the new type

bundleCoordinate - the bundle coordinate of the new type

additionalUrls - additional URLs to be added to the instance class loader of the new component

Throws:

ControllerServiceInstantiationException - if unable to create an instance of the new type

enableReportingTask

public void enableReportingTask(ReportingTaskNode reportingTaskNode)

Description copied from interface: ReportingTaskProvider

Enables the reporting task to be scheduled to run

Specified by:

enableReportingTask in interface ReportingTaskProvider

disableReportingTask

public void disableReportingTask(ReportingTaskNode reportingTaskNode)

Description copied from interface: ReportingTaskProvider

Disables the ability to schedul the reporting task to run

Specified by:

disableReportingTask in interface ReportingTaskProvider

disableReferencingServices

public java.util.Set<ConfiguredComponent> disableReferencingServices(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Disables any Controller Service that references the provided Controller Service. This action is performed recursively so that if service A references B and B references C, disabling references for C will first disable A, then B.

Specified by:

disableReferencingServices in interface ControllerServiceProvider

Parameters:

serviceNode - the node

enableReferencingServices

public java.util.Set<ConfiguredComponent> enableReferencingServices(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Enables all Controller Services that are referencing the given service. If Service A references Service B and Service B references serviceNode, Service A and B will both be enabled.

Specified by:

enableReferencingServices in interface ControllerServiceProvider

Parameters:

serviceNode - the node

Returns:

the set of all components that were updated as a result of this action

scheduleReferencingComponents

public java.util.Set<ConfiguredComponent> scheduleReferencingComponents(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Schedules any schedulable component (Processor, ReportingTask) that is referencing the given Controller Service to run. This is performed recursively, so if a Processor is referencing Service A, which is referencing serviceNode, then the Processor will also be started.

Specified by:

scheduleReferencingComponents in interface ControllerServiceProvider

Parameters:

serviceNode - the node

unscheduleReferencingComponents

public java.util.Set<ConfiguredComponent> unscheduleReferencingComponents(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Recursively unschedules all schedulable components (Processors and Reporting Tasks) that reference the given Controller Service. For any Controller services that reference this one, its schedulable referencing components will also be unscheduled.

Specified by:

unscheduleReferencingComponents in interface ControllerServiceProvider

Parameters:

serviceNode - the node

enableControllerService

public java.util.concurrent.CompletableFuture<java.lang.Void> enableControllerService(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Enables the given controller service that it can be used by other components. This method will asynchronously enable the service, returning immediately.

Specified by:

enableControllerService in interface ControllerServiceProvider

Parameters:

serviceNode - the service node

Returns:

a Future that can be used to wait for the service to finish being enabled.

enableControllerServices

public void enableControllerServices(java.util.Collection<ControllerServiceNode> serviceNodes)

Description copied from interface: ControllerServiceProvider

Enables the collection of services. If a service in this collection depends on another service, the service being depended on must either already be enabled or must be in the collection as well.

Specified by:

enableControllerServices in interface ControllerServiceProvider

Parameters:

serviceNodes - the nodes

disableControllerService

public java.util.concurrent.CompletableFuture<java.lang.Void> disableControllerService(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Disables the given controller service so that it cannot be used by other components. This allows configuration to be updated or allows service to be removed.

Specified by:

disableControllerService in interface ControllerServiceProvider

Parameters:

serviceNode - the node

verifyCanEnableReferencingServices

public void verifyCanEnableReferencingServices(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Verifies that all Controller Services referencing the provided ControllerService can be enabled.

Specified by:

verifyCanEnableReferencingServices in interface ControllerServiceProvider

Parameters:

serviceNode - the node

verifyCanScheduleReferencingComponents

public void verifyCanScheduleReferencingComponents(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Verifies that all enabled Processors referencing the ControllerService (or a service that depends on the provided service) can be scheduled to run.

Specified by:

verifyCanScheduleReferencingComponents in interface ControllerServiceProvider

Parameters:

serviceNode - the node

verifyCanDisableReferencingServices

public void verifyCanDisableReferencingServices(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Verifies that all Controller Services referencing the provided Controller Service can be disabled.

Specified by:

verifyCanDisableReferencingServices in interface ControllerServiceProvider

Parameters:

serviceNode - the node

verifyCanStopReferencingComponents

public void verifyCanStopReferencingComponents(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Verifies that all running Processors and Reporting Tasks referencing the Controller Service (or a service that depends on the provided service) can be stopped.

Specified by:

verifyCanStopReferencingComponents in interface ControllerServiceProvider

Parameters:

serviceNode - the node

getControllerService

public ControllerService getControllerService(java.lang.String serviceIdentifier)

Specified by:

getControllerService in interface ControllerServiceLookup

Parameters:

serviceIdentifier - of controller service

Returns:

the ControllerService that is registered with the given identifier

getControllerServiceForComponent

public ControllerService getControllerServiceForComponent(java.lang.String serviceIdentifier,
                                                          java.lang.String componentId)

Specified by:

getControllerServiceForComponent in interface ControllerServiceProvider

Parameters:

serviceIdentifier - the identifier of the controller service

componentId - the identifier of the component that is referencing the service.

Returns:

the Controller Service that is registered with the given identifier or null if that identifier does not exist for any controller service or if the controller service with that identifier is not accessible from the component with the given componentId, or if no component exists with the given identifier

getControllerServiceIdentifiers

public java.util.Set<java.lang.String> getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType)
                                                                throws java.lang.IllegalArgumentException

Specified by:

getControllerServiceIdentifiers in interface ControllerServiceLookup

Parameters:

serviceType - type of service to get identifiers for

Returns:

the set of all Controller Service Identifiers whose Controller Service is of the given type.

Throws:

java.lang.IllegalArgumentException - if the given class is not an interface

getControllerServiceNode

public ControllerServiceNode getControllerServiceNode(java.lang.String serviceIdentifier)

Specified by:

getControllerServiceNode in interface ControllerServiceProvider

Parameters:

serviceIdentifier - of the service

Returns:

the controller service node for the specified identifier. Returns null if the identifier does not match a known service

getRootControllerServices

public java.util.Set<ControllerServiceNode> getRootControllerServices()

addRootControllerService

public void addRootControllerService(ControllerServiceNode serviceNode)

getRootControllerService

public ControllerServiceNode getRootControllerService(java.lang.String serviceIdentifier)

removeRootControllerService

public void removeRootControllerService(ControllerServiceNode service)

isControllerServiceEnabled

public boolean isControllerServiceEnabled(ControllerService service)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

Parameters:

service - service to check

Returns:

true if the given Controller Service is enabled, false otherwise. If the given Controller Service is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabled

public boolean isControllerServiceEnabled(java.lang.String serviceIdentifier)

Specified by:

isControllerServiceEnabled in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier of service to check

Returns:

true if the Controller Service with the given identifier is enabled, false otherwise. If the given identifier is not known by this ControllerServiceLookup, returns false

isControllerServiceEnabling

public boolean isControllerServiceEnabling(java.lang.String serviceIdentifier)

Specified by:

isControllerServiceEnabling in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier of service to check

Returns:

true if the Controller Service with the given identifier has been enabled but is still in the transitioning state, otherwise returns false. If the given identifier is not known by this ControllerServiceLookup, returns false

getControllerServiceName

public java.lang.String getControllerServiceName(java.lang.String serviceIdentifier)

Specified by:

getControllerServiceName in interface ControllerServiceLookup

Parameters:

serviceIdentifier - identifier to look up

Returns:

the name of the Controller service with the given identifier. If no service can be found with this identifier, returns null

removeControllerService

public void removeControllerService(ControllerServiceNode serviceNode)

Description copied from interface: ControllerServiceProvider

Removes the given Controller Service from the flow. This will call all appropriate methods that have the @OnRemoved annotation.

Specified by:

removeControllerService in interface ControllerServiceProvider

Parameters:

serviceNode - the controller service to remove

getAllControllerServices

public java.util.Set<ControllerServiceNode> getAllControllerServices()

Specified by:

getAllControllerServices in interface ControllerServiceProvider

Returns:

a Set of all Controller Services that exist for this service provider

getCounters

public java.util.List<Counter> getCounters()

resetCounter

public Counter resetCounter(java.lang.String identifier)

getTotalFlowFileCount

public QueueSize getTotalFlowFileCount(ProcessGroup group)

getActiveThreadCount

public int getActiveThreadCount()

startHeartbeating

public void startHeartbeating()
                       throws java.lang.IllegalStateException

Starts heartbeating to the cluster. May only be called if the instance was constructed for a clustered environment.

Throws:

java.lang.IllegalStateException - if not configured for clustering

suspendHeartbeats

public void suspendHeartbeats()

Notifies controller that the sending of heartbeats should be temporarily suspended. This method does not cancel any background tasks as does stopHeartbeating() and does not require any lock on the FlowController. Background tasks will still generate heartbeat messages and any background task currently in the process of sending a Heartbeat to the cluster will continue.

resumeHeartbeats

public void resumeHeartbeats()

Notifies controller that the sending of heartbeats should be re-enabled. This method does not submit any background tasks to take affect as does startHeartbeating() and does not require any lock on the FlowController.

stopHeartbeating

public void stopHeartbeating()
                      throws java.lang.IllegalStateException

Stops heartbeating to the cluster. May only be called if the instance was constructed for a clustered environment. If the controller was not heartbeating, then this method has no effect.

Throws:

java.lang.IllegalStateException - if not clustered

isHeartbeating

public boolean isHeartbeating()

Returns:

true if the instance is heartbeating; false otherwise

getHeartbeatDelaySeconds

public int getHeartbeatDelaySeconds()

Returns:

the number of seconds to wait between successive heartbeats

getNodeId

public NodeIdentifier getNodeId()

The node identifier of this instance.

Returns:

the node identifier or null if no identifier is set

setNodeId

public void setNodeId(NodeIdentifier nodeId)

Sets the node identifier for this instance.

Parameters:

nodeId - the node identifier, which may be null

isClustered

public boolean isClustered()

Specified by:

isClustered in interface NodeTypeProvider

Returns:

true if this instance is clustered; false otherwise. Clustered means that a node is either connected or trying to connect to the cluster.

isConfiguredForClustering

public boolean isConfiguredForClustering()

setClustered

public void setClustered(boolean clustered,
                         java.lang.String clusterInstanceId)

Sets whether this instance is clustered. Clustered means that a node is either connected or trying to connect to the cluster.

Parameters:

clustered - true if clustered

clusterInstanceId - if clustered is true, indicates the InstanceID of the Cluster Manager

isPrimary

public boolean isPrimary()

Specified by:

isPrimary in interface NodeTypeProvider

Returns:

true if this instance is the primary node in the cluster; false otherwise

setPrimary

public void setPrimary(boolean primary)

getContentAvailability

public ContentAvailability getContentAvailability(ProvenanceEventRecord event)

getContent

public java.io.InputStream getContent(ProvenanceEventRecord provEvent,
                                      ContentDirection direction,
                                      java.lang.String requestor,
                                      java.lang.String requestUri)
                               throws java.io.IOException

Throws:

java.io.IOException

getContent

public java.io.InputStream getContent(FlowFileRecord flowFile,
                                      java.lang.String requestor,
                                      java.lang.String requestUri)
                               throws java.io.IOException

Throws:

java.io.IOException

replayFlowFile

public ProvenanceEventRecord replayFlowFile(long provenanceEventRecordId,
                                            NiFiUser user)
                                     throws java.io.IOException

Throws:

java.io.IOException

replayFlowFile

public ProvenanceEventRecord replayFlowFile(ProvenanceEventRecord event,
                                            NiFiUser user)
                                     throws java.io.IOException

Throws:

java.io.IOException

getComponentIdentifiers

public java.util.List<java.lang.String> getComponentIdentifiers()

Specified by:

getComponentIdentifiers in interface IdentifierLookup

Returns:

the identifiers of components that may generate Provenance Events

getComponentTypes

public java.util.List<java.lang.String> getComponentTypes()

Specified by:

getComponentTypes in interface IdentifierLookup

Returns:

a list of component types that may generate Provenance Events

getQueueIdentifiers

public java.util.List<java.lang.String> getQueueIdentifiers()

Specified by:

getQueueIdentifiers in interface IdentifierLookup

Returns:

the identifiers of FlowFile Queues that are in the flow

isConnected

public boolean isConnected()

setConnectionStatus

public void setConnectionStatus(NodeConnectionStatus connectionStatus)

heartbeat

public void heartbeat()

getProvenanceEvents

public java.util.List<ProvenanceEventRecord> getProvenanceEvents(long firstEventId,
                                                                 int maxRecords)
                                                          throws java.io.IOException

Description copied from interface: EventAccess

Convenience method to obtain Provenance Events starting with (and including) the given ID. If no event exists with that ID, the first event to be returned will be have an ID greater than firstEventId.

Specified by:

getProvenanceEvents in interface EventAccess

Parameters:

firstEventId - the ID of the first event to obtain

maxRecords - the maximum number of records to obtain

Returns:

event records matching query

Throws:

java.io.IOException - if unable to get records

createLocalDataAuthorizable

public Authorizable createLocalDataAuthorizable(java.lang.String componentId)

Description copied from interface: ProvenanceAuthorizableFactory

Generates an Authorizable object for the Data of the component with the given ID. This includes provenance data and queue's on outgoing relationships.

Specified by:

createLocalDataAuthorizable in interface ProvenanceAuthorizableFactory

Parameters:

componentId - the ID of the component to which the Data belongs

Returns:

the Authorizable that can be use to authorize access to provenance events

createRemoteDataAuthorizable

public Authorizable createRemoteDataAuthorizable(java.lang.String remoteGroupPortId)

Description copied from interface: ProvenanceAuthorizableFactory

Generates an Authorizable object for the Data of the remote group port with the given ID.

Specified by:

createRemoteDataAuthorizable in interface ProvenanceAuthorizableFactory

Parameters:

remoteGroupPortId - the ID of the remote group port to which the data belongs

Returns:

the Authorizable that can be used to authorize access to provenance events

getFlowChanges

public java.util.List<Action> getFlowChanges(int firstActionId,
                                             int maxActions)

Description copied from interface: EventAccess

Obtains flow changes starting with (and including) the given action ID. If no action exists with that ID, the first action to be returned will have an ID greater than firstActionId.

Specified by:

getFlowChanges in interface EventAccess

Parameters:

firstActionId - the id of the first action to obtain

maxActions - the maximum number of actions to obtain

Returns:

actions with ids greater than or equal to firstActionID, up to the max number of actions

getRemoteSiteListeningPort

public java.lang.Integer getRemoteSiteListeningPort()

getRemoteSiteListeningHttpPort

public java.lang.Integer getRemoteSiteListeningHttpPort()

isRemoteSiteCommsSecure

public java.lang.Boolean isRemoteSiteCommsSecure()

getProcessScheduler

public ProcessScheduler getProcessScheduler()

getControllerServiceIdentifiers

public java.util.Set<java.lang.String> getControllerServiceIdentifiers(java.lang.Class<? extends ControllerService> serviceType,
                                                                       java.lang.String groupId)

Specified by:

getControllerServiceIdentifiers in interface ControllerServiceProvider

Parameters:

serviceType - type of service to get identifiers for

groupId - the ID of the Process Group to look in for Controller Services

Returns:

the set of all Controller Service Identifiers whose Controller Service is of the given type.

getProvenanceRepository

public ProvenanceRepository getProvenanceRepository()

Specified by:

getProvenanceRepository in interface EventAccess

Returns:

the Provenance Event Repository

getConnectionStatusHistory

public StatusHistoryDTO getConnectionStatusHistory(java.lang.String connectionId)

getConnectionStatusHistory

public StatusHistoryDTO getConnectionStatusHistory(java.lang.String connectionId,
                                                   java.util.Date startTime,
                                                   java.util.Date endTime,
                                                   int preferredDataPoints)

getProcessorStatusHistory

public StatusHistoryDTO getProcessorStatusHistory(java.lang.String processorId,
                                                  boolean includeCounters)

getProcessorStatusHistory

public StatusHistoryDTO getProcessorStatusHistory(java.lang.String processorId,
                                                  java.util.Date startTime,
                                                  java.util.Date endTime,
                                                  int preferredDataPoints,
                                                  boolean includeCounters)

getProcessGroupStatusHistory

public StatusHistoryDTO getProcessGroupStatusHistory(java.lang.String processGroupId)

getProcessGroupStatusHistory

public StatusHistoryDTO getProcessGroupStatusHistory(java.lang.String processGroupId,
                                                     java.util.Date startTime,
                                                     java.util.Date endTime,
                                                     int preferredDataPoints)

getRemoteProcessGroupStatusHistory

public StatusHistoryDTO getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId)

getRemoteProcessGroupStatusHistory

public StatusHistoryDTO getRemoteProcessGroupStatusHistory(java.lang.String remoteGroupId,
                                                           java.util.Date startTime,
                                                           java.util.Date endTime,
                                                           int preferredDataPoints)

getAllQueues

public java.util.Collection<FlowFileQueue> getAllQueues()

Specified by:

getAllQueues in interface QueueProvider

Returns:

all FlowFileQueues that currently exist in the flow