Package org.apache.nifi.flow.synchronization

Interface VersionedComponentSynchronizer

All Known Implementing Classes:

StandardVersionedComponentSynchronizer

public interface VersionedComponentSynchronizer

Method Summary

Modifier and Type	Method	Description
ComponentAdditions	addVersionedComponentsToProcessGroup(ProcessGroup group, VersionedComponentAdditions additions, FlowSynchronizationOptions options)	Adds versioned components to the specified Process Group.
void	synchronize(Connection connection, org.apache.nifi.flow.VersionedConnection proposedConnection, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Connection to match the proposed one, or deletes the Connection if the proposed is null.
void	synchronize(Funnel funnel, org.apache.nifi.flow.VersionedFunnel proposed, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Funnel to match the proposed one, or deletes the Funnel if the proposed is null.
void	synchronize(Port port, org.apache.nifi.flow.VersionedPort proposed, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Port to match the proposed one, or deletes the Port if the proposed is null.
void	synchronize(FlowAnalysisRuleNode flowAnalysisRule, org.apache.nifi.flow.VersionedFlowAnalysisRule proposed, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Flow Analysis Rule to match the proposed one, or deletes the Flow Analysis Rule if the proposed is null.
void	synchronize(Label label, org.apache.nifi.flow.VersionedLabel proposed, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Label to match the proposed one, or deletes the Label if the proposed is null.
void	synchronize(ProcessorNode processor, org.apache.nifi.flow.VersionedProcessor proposedProcessor, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Processor to match the proposed snapshot, or deletes the Processor if the proposed snapshot is null.
void	synchronize(ReportingTaskNode reportingTask, org.apache.nifi.flow.VersionedReportingTask proposed, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Reporting Task to match the proposed one, or deletes the Reporting Task if the proposed is null.
void	synchronize(ControllerServiceNode controllerService, org.apache.nifi.flow.VersionedControllerService proposed, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Controller Service to match the proposed version, or deletes the Controller Service if the proposed snapshot is null.
void	synchronize(ProcessGroup group, org.apache.nifi.flow.VersionedExternalFlow proposedFlow, FlowSynchronizationOptions synchronizationOptions)	Synchronize the given Process Group to match the proposed flow
void	synchronize(RemoteProcessGroup rpg, org.apache.nifi.flow.VersionedRemoteProcessGroup proposed, ProcessGroup group, FlowSynchronizationOptions synchronizationOptions)	Synchronizes the given Remote Process Group to match the proposed one, or deletes the rpg if the proposed is null.
void	synchronize(ParameterContext parameterContext, org.apache.nifi.flow.VersionedParameterContext proposed, FlowSynchronizationOptions synchronizationOptions)
void	synchronizeProcessGroupSettings(ProcessGroup processGroup, org.apache.nifi.flow.VersionedProcessGroup proposed, ProcessGroup parentGroup, FlowSynchronizationOptions synchronizationOptions)
void	verifyCanAddVersionedComponents(ProcessGroup group, VersionedComponentAdditions additions)	Verifies that the given additions can be applied to the specified process group.
void	verifyCanSynchronize(ProcessGroup group, org.apache.nifi.flow.VersionedProcessGroup proposed, boolean verifyConnectionRemoval)	Verifies that the given Process Group can be updated to match the proposed flow

Method Details

addVersionedComponentsToProcessGroup

ComponentAdditions addVersionedComponentsToProcessGroup(ProcessGroup group,
 VersionedComponentAdditions additions,
 FlowSynchronizationOptions options)

Adds versioned components to the specified Process Group.

Parameters:

group - the Process Group to append to

additions - the component additions to add to the Process Group

options - sync options

Returns:

the component additions

verifyCanAddVersionedComponents

void verifyCanAddVersionedComponents(ProcessGroup group,
 VersionedComponentAdditions additions)

Verifies that the given additions can be applied to the specified process group.

Parameters:

group - the Process Group that will be appended to

additions - the component additions that will be added to the Process Group

synchronize

void synchronize(ProcessGroup group,
 org.apache.nifi.flow.VersionedExternalFlow proposedFlow,
 FlowSynchronizationOptions synchronizationOptions)
          throws ProcessorInstantiationException

Synchronize the given Process Group to match the proposed flow

Parameters:

group - the Process Group to update

proposedFlow - the proposed/desired state for the process group

synchronizationOptions - options for how to synchronize the group

Throws:

ProcessorInstantiationException

verifyCanSynchronize

void verifyCanSynchronize(ProcessGroup group,
 org.apache.nifi.flow.VersionedProcessGroup proposed,
 boolean verifyConnectionRemoval)

Verifies that the given Process Group can be updated to match the proposed flow

Parameters:

group - the group to update

proposed - the proposed updated version

verifyConnectionRemoval - if true and synchronizing the Process Group would result in any Connection being removed, an IllegalStateException will be thrown if that Connection has data in it. If false, the presence of data in removed queues will be ignored.

synchronize

void synchronize(ProcessorNode processor,
 org.apache.nifi.flow.VersionedProcessor proposedProcessor,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Synchronizes the given Processor to match the proposed snapshot, or deletes the Processor if the proposed snapshot is null. If the given processor is null, adds the processor to the given ProcessGroup

Parameters:

processor - the processor to synchronize

proposedProcessor - the proposed/desired state for the processor

group - the ProcessGroup to which the ProcessorNode should belong.

synchronizationOptions - options for how to synchronize the flow

Throws:

FlowSynchronizationException - if unable to synchronize the processor with the proposed version

TimeoutException - if the processor must be stopped in order to synchronize it with the proposed version and stopping takes longer than the timeout allowed by the synchronization options.

InterruptedException - if interrupted while waiting for processor to stop or outbound connections to empty if processor is being removed

synchronize

void synchronize(ControllerServiceNode controllerService,
 org.apache.nifi.flow.VersionedControllerService proposed,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Synchronizes the given Controller Service to match the proposed version, or deletes the Controller Service if the proposed snapshot is null. If the given Controller Service is null, adds the Controller Service to the given Process Group

Parameters:

controllerService - the Controller Service to synchronize

proposed - the proposed/desired state for the controller service

group - the ProcessGroup to which the Controller Service should belong

synchronizationOptions - options for how to synchronize the flow

Throws:

FlowSynchronizationException - if unable to synchronize the Controller Service with the proposed version

TimeoutException - if the Controller Service must be disabled in order to synchronize it with the proposed version and disabling takes longer than the timeout allowed by the synchronization options.

InterruptedException - if interrupted while waiting for Controller Service to disable

synchronize

void synchronize(Connection connection,
 org.apache.nifi.flow.VersionedConnection proposedConnection,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException

Synchronizes the given Connection to match the proposed one, or deletes the Connection if the proposed is null. If the given connection is null, adds the connection to the given ProcessGroup

Parameters:

connection - the connection to synchronize

proposedConnection - the proposed/desired state for the connection

group - the ProcessGroup to which the connection should belong

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the connection cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the connection with the proposed version

TimeoutException - if the source or destination of the connection must be stopped in order to perform the synchronization and stopping it takes longer than the timeout allowed by the synchronization options.

synchronize

void synchronize(Port port,
 org.apache.nifi.flow.VersionedPort proposed,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Synchronizes the given Port to match the proposed one, or deletes the Port if the proposed is null. If the given Port is null, creates it and adds it to the given ProcessGroup

Parameters:

port - the port to synchronize

proposed - the proposed/desired state for the port

group - the ProcessGroup to which the port should belong

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the port cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the port with the proposed version

TimeoutException - if the port is running and takes longer to stop than the timeout allowed by the synchronization options.

InterruptedException

synchronize

void synchronize(Funnel funnel,
 org.apache.nifi.flow.VersionedFunnel proposed,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Synchronizes the given Funnel to match the proposed one, or deletes the Funnel if the proposed is null. If the given Funnel is null, creates it and adds it to the given ProcessGroup

Parameters:

funnel - the funnel to synchronize

proposed - the proposed/desired state for the funnel

group - the ProcessGroup to which the funnel should belong

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the funnel cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the funnel with the proposed version

TimeoutException - if the funnel is being removed and downstream components take longer to stop than the timeout allowed by the synchronization options.

InterruptedException

synchronize

void synchronize(Label label,
 org.apache.nifi.flow.VersionedLabel proposed,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)

Synchronizes the given Label to match the proposed one, or deletes the Label if the proposed is null. If the given Label is null, creates it and adds it to the given ProcessGroup

Parameters:

label - the label to synchronize

proposed - the proposed/desired state for the label

group - the ProcessGroup to which the label should belong

synchronizationOptions - options for how to synchronize the flow

synchronize

void synchronize(ReportingTaskNode reportingTask,
 org.apache.nifi.flow.VersionedReportingTask proposed,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException,
ReportingTaskInstantiationException

Synchronizes the given Reporting Task to match the proposed one, or deletes the Reporting Task if the proposed is null. If the given Reporting Task is null, creates it

Parameters:

reportingTask - the reporting task to synchronize

proposed - the proposed/desired state

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the reporting task cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the reporting task with the proposed version

TimeoutException - if the reporting task is being removed and takes longer to stop than the timeout allowed by the synchronization options.

InterruptedException

ReportingTaskInstantiationException

synchronize

void synchronize(FlowAnalysisRuleNode flowAnalysisRule,
 org.apache.nifi.flow.VersionedFlowAnalysisRule proposed,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException,
FlowAnalysisRuleInstantiationException

Synchronizes the given Flow Analysis Rule to match the proposed one, or deletes the Flow Analysis Rule if the proposed is null. If the given Flow Analysis Rule is null, creates it.

Parameters:

flowAnalysisRule - the flow analysis rule to synchronize

proposed - the proposed/desired state

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the flow analysis rule cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the flow analysis rule with the proposed version

TimeoutException - if the flow analysis rule is being removed and takes longer to stop than the timeout allowed by the synchronization options.

InterruptedException

FlowAnalysisRuleInstantiationException

synchronize

void synchronize(RemoteProcessGroup rpg,
 org.apache.nifi.flow.VersionedRemoteProcessGroup proposed,
 ProcessGroup group,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Synchronizes the given Remote Process Group to match the proposed one, or deletes the rpg if the proposed is null. If the given rpg is null, creates it and adds it to the given ProcessGroup

Parameters:

rpg - the rpg to synchronize

proposed - the proposed/desired state for the rpg

group - the ProcessGroup to which the rpg should belong

synchronizationOptions - options for how to synchronize the flow

Throws:

IllegalStateException - if the rpg cannot be updated due to the state of the flow

FlowSynchronizationException - if unable to synchronize the rpg with the proposed version

TimeoutException - if the rpg is being removed and takes longer to stop than the timeout allowed by the synchronization options.

InterruptedException

synchronize

void synchronize(ParameterContext parameterContext,
 org.apache.nifi.flow.VersionedParameterContext proposed,
 FlowSynchronizationOptions synchronizationOptions)
          throws FlowSynchronizationException,
TimeoutException,
InterruptedException

Throws:

FlowSynchronizationException

TimeoutException

InterruptedException

synchronizeProcessGroupSettings

void synchronizeProcessGroupSettings(ProcessGroup processGroup,
 org.apache.nifi.flow.VersionedProcessGroup proposed,
 ProcessGroup parentGroup,
 FlowSynchronizationOptions synchronizationOptions)
                              throws FlowSynchronizationException,
TimeoutException,
InterruptedException,
ProcessorInstantiationException

Throws:

FlowSynchronizationException

TimeoutException

InterruptedException

ProcessorInstantiationException