All Classes and Interfaces
Class
Description
Abstract class holding information about a
FlowAnalysisRule violation.Base class for DocumentationWriter that simplifies iterating over all information for a component, creating a separate method
for each, to ensure that implementations properly override all methods and therefore properly account for all information about
a component.
Provides a standard partial implementation of a
Processor.An action taken on the flow by a user.
Provides additional details about a given action.
Represents a valid value for a
PropertyDescriptorAn Asset is a representation of some resource that is necessary in order to run a dataflow.
Defines a type of expression language statement that can be applied
parametrized by various attributes and properties as specified in each of
the method calls.
Information for locating a bucket in a flow registry.
A Bulletin is a construct that represents a message that is to be displayed
to users to notify of a specific (usually fleeting) event.
The BulletinRepository provides a place to store and retrieve
Bulletins that have been created by the NiFi Framework and the
Components that are running within the Framework.Annotation that may be placed on a
Processor,
ControllerService,
ParameterProvider,
FlowAnalysisRule, or
ReportingTask allowing for a
description to be provided.
There are times when a component must be created in such a way that each instance gets its own ClassLoader hierarchy,
rather than sharing the ClassLoader with other components (see
@RequiresInstanceClassLoading).A context for retrieving information about the state of the cluster.
Defines possible components for a given action.
Holds information about a component violating a
FlowAnalysisRuleBase interface for providing component details to an Action.
The ComponentLog provides a mechanism to ensure that all NiFi components are
logging and reporting information in a consistent way.
An Enumeration for indicating which type of component a Bulletin is associated with
This context is passed to ControllerServices and Reporting Tasks in order
to expose their configuration to them.
This interface provides a mechanism for creating services that are shared
among all
Processors, ReportingTasks, FlowAnalysisRules, ParameterProviders and other
ControllerServices.
Marker interface that a Processor can use to configure default settings for the schedule strategy, the period and the number of concurrent tasks.
Marker interface that a Processor can use to configure the yield duration, the penalty duration and the bulletin log level.
Annotation that can be applied to a
Processor,
ControllerService, or
ReportingTask in order to
warn about the deprecation of the component.Describes a component property value with display name and description.
Marker annotation a
Processor
implementation can use to indicate that the Processor is not designed in
such a way that the 'Run Once' capability would function.Indicates that a component has more than one dynamic property
An annotation that may be placed on a
ConfigurableComponent to
indicate that it supports a dynamic property.Annotation to indicate that a
Processor supports dynamic
relationship.Provides a registry of variables available for use by various components and
extension points.
Defines the Nodes where a given Component will be scheduled to run.
Indicates the scope of expression language on a property descriptor.
Generates documentation for an instance of a ConfigurableComponent.
Might be used by provider service in order to decide if an available resource should be acquired from the external provider.
Describes an available resource might be fetched from the external source.
Represents an external source where the resource files might be acquired from.
Contains necessary information for extensions of external resource provider functionality.
Used for accessing flow- or other analysis-related information
A single rule that can analyze components or a flow (represented by a process group)
This interface provides a bridge between the NiFi Framework and a
FlowAnalysisRule.Provides configuration information to a
FlowAnalysisRule at the time of initialization
A flow file is a logical notion of an item in a flow with its associated
attributes and identity which can be used as a reference for its actual
content.
Indicates an issue occurred while accessing the content of a FlowFile, such
as an IOException, or obtaining a reference to the FlowFile
FlowFileFilter provides a mechanism for selectively choosing which FlowFiles
to obtain from a Processor's incoming connections.
Provides a result type to indicate whether or not a FlowFile should be
selected
Thrown when a flow file is referenced that is not part of the appropriate
session or is not properly accounted for by a transfer or removal within a
session.
Information for locating a flow in a flow registry.
Represents and external source, where flows might be stored and retrieved from.
Indicates an error interacting with the NiFi registry for a reason other than IOException.
Information for locating a flow version in a flow registry.
Holds information about a
FlowAnalysisRule violation after analyzing (a part of) the flow, represented by a process group.
Marker interface that a Processor can use to indicate whether it accepts, requires, or forbids
input from other Processors.
Thrown to indicate that the content for some FlowFile could not be found.
An annotation that can be used for Processors in order to explain a specific use case that can be
accomplished using this Processor in conjunction with at least one other Processor.
An enclosing annotation that can be used in order to use the
MultiProcessorUseCase annotation in a repeated manner.The status of a NiFi node.
This interface provides a set of methods for checking NiFi node type.
Marker annotation a
Processor,
ControllerService,
FlowRegistryClient,
ParameterProvider,
FlowAnalysisRule, or
ReportingTask implementation
can use to indicate a method should be called whenever the component is added
to the flow.
Marker Annotation that a Processor, Reporting Task, or Controller Service can use to indicate
that the method with this Annotation should be invoked whenever the component's configuration
is restored after a restart of NiFi.
Marker annotation a
ControllerService can
use to indicate a method should be called whenever the service is disabled.
Marker annotation a
ControllerService can
use to indicate a method should be called whenever the service is enabled.
Marker annotation that a component can use to indicate that a method should be
called whenever the state of the Primary Node in a cluster has changed.
Marker annotation a
Processor,
ControllerService,
FlowRegistryClient,
ParameterProvider,
FlowAnalysisRule, or
ReportingTask implementation
can use to indicate a method should be called whenever the component is
removed from the flow.
Marker annotation a
Processor or
ReportingTask implementation
can use to indicate a method should be called whenever the component is
scheduled to run.
Marker annotation a
Processor,
ControllerService,
ParameterProvider, or
ReportingTask implementation
can use to indicate a method should be called whenever the flow is being
shutdown.
Marker annotation a
Processor or
ReportingTask implementation
can use to indicate that a method should be called whenever the component is
no longer scheduled to run.
Marker annotation a
Processor or
ReportingTask should be
called whenever the component is no longer scheduled to run.Defines possible operations for a given action.
An immutable class that holds information about a Parameter.
Encapsulates a named group of externally fetched parameters that can be provided to referencing Parameter Contexts.
User-provided configuration for a group of parameters fetched from a ParameterProvider.
Defines a provider that is responsible for fetching from an external source Parameters with
which a ParameterContext can be populated.
Indicates the sensitivity of a parameter.
The status of a port.
Marker annotation a
Processor implementation
can use to indicate that the ExecutionNode
of the processor is to be set to PRIMARYRepresents a state change that occurred for the Primary Node of a NiFi cluster.
Provides a bridge between a Processor and the NiFi Framework
Indicates an issue occurred in user code while processing a FlowFile.
Processor objects operate on FlowFile objects where the processors are linked
together via relationships forming a directed graph structure.
An annotation that can be used in conjunction with
MultiProcessorUseCase in order to specify the different
components that are involved in a given use case.
The
ProcessorInitializationContext provides
Processors access to objects that
may be of use throughout the life of the Processor.A process session encompasses all the behaviors a processor can perform to
obtain, clone, read, modify remove
FlowFiles in an atomic unit.
Factory for creating a
ProcessSessionA context for retrieving a PropertyValue from a PropertyDescriptor.
An immutable object for holding information about a type of component
property.
A PropertyValue provides a mechanism whereby the currently configured value
of a processor property can be obtained in different forms.
Describes an event that happened to a FlowFile.
This Repository houses Provenance Events.
ProvenanceReporter generates and records Provenance-related events.
QueryWindow is used to track time intervals for querying for observations
Annotation that may be placed on a
Processor indicating that this
processor reads a specific FlowFile attribute.Annotation that may be placed on a
Processor indicating that this
processor reads specific FlowFile attributes.An immutable object for holding information about a type of relationship.
RelationshipConfiguration can be used to convey how a Processor's configuration should be migrated from an old configuration
to the latest configuration.
This interface provides a bridge between the NiFi Framework and a
ReportingTask.A ReportingConfiguration provides configuration information to a
ReportingTask at the time of initialization
Defines a task that is responsible for reporting status information to
external destinations.
Enumeration of permission required for annotated components
Marker annotation a component can use to indicate that the framework should create a new ClassLoader
for each instance of the component, copying all resources from the component's NARClassLoader to a
new ClassLoader which will only be used by a given instance of the component.
Indicates the cardinality of how many resources can be referenced by a given property.
Provides the context in which a Reference Reference is to be evaluated
Defines the number and types of resources that allowed to be referenced by a component property
A reference to a Resource that is identified by a property value
A representation of zero or more
ResourceReferences
Marks the usage of a component as restricted to users with elevated privileges.
Specific restriction for a component.
Indicates the valid values for the state of a
Triggerable entity
with respect to scheduling the entity to run.Defines a Scheduling Strategy to use when scheduling Components (Ports,
Funnels, Processors) to run
A Scope represents how a NiFi component's state is to be stored and retrieved when running in a cluster.
Annotation that may be placed on a null
Processor,
ControllerService,
ParameterProvider,
FlowAnalysisRule, or
ReportingTask that indicates
this component is related to the components listed.Describes a Controller Service API that is provided by some implementation.
Marker annotation a
Processor
implementation can use to indicate that its operations on FlowFiles can be
safely repeated across process sessions.
Annotation that a Processor, ReportingTask, FlowAnalysisRule, ParameterProvider, or Controller Service can use to indicate
that the component makes use of the
StateManager.
The StateManager is responsible for providing NiFi components a mechanism for storing
and retrieving state.
Provides a representation of a component's state at some point in time.
Thrown when attempting to store state via the
StateManager but the state being
stored is larger than is allowed by the backing storage mechanism.The StatusAnalytics interface offers methods for accessing predicted and other values for a single component (Connection instance, e.g.).
The status of a storage repository.
Disk usage for a file system directory.
Marker annotation a Processor implementation can use to indicate that users
should be able to supply a Batch Duration for the Processor.
Component annotation indicating support for dynamic properties that can be designated as sensitive for the purpose of
persistence and framework processing
Represents a system resource.
Annotation that may be placed on a
Component describes how this component may impact a
system resource based on its configuration.Annotation that may be placed on a
Component describes how this component may impact
system resources based on its configuration.Annotation that can be applied to a
Processor,
ControllerService,
ParameterProvider,
FlowAnalysisRule, or
ReportingTask in order to
associate tags (keywords) with the component.This Exception is thrown whenever a user terminates a Processor and the
Processor subsequently attempts to call a method on a
ProcessSession,
ProcessSessionFactory, ProcessContext, or an
InputStream or OutputStream that were generated from the associated
Process SessionsMarker annotation a
Processor
implementation can use to indicate that the Processor is not safe for
concurrent execution of its onTrigger() method.Marker annotation a
Processor
implementation can use to indicate that the Processor is to be triggered if
any of its destinations has available space for incoming FlowFiles.
Marker annotation a
Processor
implementation can use to indicate that the Processor should still be
triggered even when it has no data in its work queue.
An annotation that can be used for extension points in order to explain a specific use case that can be
accomplished using this extension.
An enclosing annotation that can be used in order to use the
UseCase annotation in a repeated manner.Immutable - thread safe
An immutable object for holding information about a type of processor
property.
Any Controller Service that implements this interface will be provided the opportunity to verify
a given configuration of the Controller Service.
Any Flow Analysis Rule that implements this interface will be provided the opportunity to verify
a given configuration of the Flow Analysis Rule.
Any Parameter Provider that implements this interface will be provided the opportunity to verify
a given configuration of the Parameter Provider.
Any Processor that implements this interface will be provided the opportunity to verify
a given configuration of the Processor.
Any Reporting Task that implements this interface will be provided the opportunity to verify
a given configuration of the Reporting Task.
A component that has property descriptors and can be configured with values for those properties.
A component that is an extension and has a type and bundle.
Annotation that may be placed on a
Processor indicating that this
processor writes/updates a specific FlowFile attribute.Annotation that may be placed on a
Processor indicating that this
processor writes/updates specific FlowFile attributes.XML-based implementation of DocumentationWriter.