org.apache.nifi.reporting

Interface ReportingTask

All Superinterfaces:

ConfigurableComponent

All Known Implementing Classes:

AbstractReportingTask

public interface ReportingTask
extends ConfigurableComponent

Defines a task that is responsible for reporting status information to external destinations. All implementations of this class must have a default constructor.

ReportingTasks are discovered using Java's ServiceLoader mechanism. As a result, all implementations must follow these rules:

• The implementation must implement this interface.
• The implementation must have a file named org.apache.nifi.reporting.ReportingTask located within the jar's META-INF/services directory. This file contains a list of fully-qualified class names of all ReportingTasks in the jar, one-per-line.
• The implementation must support a default constructor.

ReportingTasks are scheduled on a delayed interval with a single thread. Therefore, implementations are not required to be thread-safe.

ReportingTasks may choose to annotate a method with the @OnConfigured annotation. If this is done, that method will be invoked after all properties have been set for the ReportingTask and before it is scheduled to run. If the method throws an Exception, the ReportingTask will be Administratively yielded and will not run for the configured period of time.

Method Summary

Modifier and Type	Method and Description
void	initialize(ReportingInitializationContext config) Provides the Reporting Task with access to objects that may be of use throughout the life of the service
void	onTrigger(ReportingContext context) This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.

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

getIdentifier, getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Method Detail

initialize

void initialize(ReportingInitializationContext config)
         throws InitializationException

Provides the Reporting Task with access to objects that may be of use throughout the life of the service

Parameters:

config - of initialization context

Throws:

InitializationException - if unable to init

onTrigger

void onTrigger(ReportingContext context)

This method is called on a scheduled interval to allow the Reporting Task to perform its tasks.

Parameters:

context - reporting context