Module org.apache.nifi

Package org.apache.nifi.flowanalysis

Interface FlowAnalysisRule

All Superinterfaces:

ConfigurableComponent

All Known Implementing Classes:

AbstractFlowAnalysisRule

public interface FlowAnalysisRule
extends ConfigurableComponent

A single rule that can analyze components or a flow (represented by a process group)

Method Summary

Modifier and Type	Method	Description
default Collection<ComponentAnalysisResult>	analyzeComponent(VersionedComponent component, FlowAnalysisRuleContext context)	Analyze a component provided by the framework.
default Collection<GroupAnalysisResult>	analyzeProcessGroup(VersionedProcessGroup processGroup, FlowAnalysisRuleContext context)	Analyze a flow or a part of it, represented by a process group.
void	initialize(FlowAnalysisRuleInitializationContext context)	Provides the Flow Analysis Rule with access to objects that may be of use throughout its lifecycle

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Details

initialize

void initialize(FlowAnalysisRuleInitializationContext context)
         throws InitializationException

Provides the Flow Analysis Rule with access to objects that may be of use throughout its lifecycle

Parameters:

context - see FlowAnalysisRuleInitializationContext

Throws:

InitializationException - if unable to initialize

analyzeComponent

default Collection<ComponentAnalysisResult> analyzeComponent(VersionedComponent component,
 FlowAnalysisRuleContext context)

Analyze a component provided by the framework. This is a callback method invoked by the framework. It should be expected that this method will be called with any and all available components.

Parameters:

component - the component to be analyzed

context - see FlowAnalysisRuleContext

Returns:

a collection of ComponentAnalysisResult as the result of the analysis of the given component

analyzeProcessGroup

default Collection<GroupAnalysisResult> analyzeProcessGroup(VersionedProcessGroup processGroup,
 FlowAnalysisRuleContext context)

Analyze a flow or a part of it, represented by a process group. This is a callback method invoked by the framework. It should be expected that this method will be called by the root process group and all of its child process groups. In case a flow analysis is requested for a particular process group this method will be called for all it's child process groups as well.

Parameters:

processGroup - the process group to be analyzed

context - see FlowAnalysisRuleContext

Returns:

a collection of GroupAnalysisResult as the result of the analysis. One GroupAnalysisResult in the collection can either refer to a component within the analyzed process group, to a child process group or the entirety of the process group