Package org.apache.nifi.reporting

Class AbstractReportingTask

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.reporting.AbstractReportingTask

All Implemented Interfaces:

ConfigurableComponent, ReportingTask

public abstract class AbstractReportingTask
extends AbstractConfigurableComponent
implements ReportingTask

Field Summary

Fields

Modifier and Type	Field	Description
private String	identifier
private ComponentLog	logger
private String	name
private NodeTypeProvider	nodeTypeProvider
private long	schedulingNanos
private ControllerServiceLookup	serviceLookup

Constructor Summary

Constructors

Constructor	Description
AbstractReportingTask()

Method Summary

Modifier and Type	Method	Description
protected final ControllerServiceLookup	getControllerServiceLookup()
String	getIdentifier()
protected ComponentLog	getLogger()
protected String	getName()
protected final NodeTypeProvider	getNodeTypeProvider()
protected long	getSchedulingPeriod(TimeUnit timeUnit)
protected void	init(ReportingInitializationContext config)	Provides a mechanism by which subclasses can perform initialization of the Reporting Task before it is scheduled to be run
final void	initialize(ReportingInitializationContext config)	Provides the Reporting Task with access to objects that may be of use throughout the life of the service
void	setComponentInfo(ConfigurationContext context)	Sets various component information using the given context

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, getSupportedPropertyDescriptors, hashCode, onPropertyModified, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Methods inherited from interface org.apache.nifi.reporting.ReportingTask

isStateful, migrateProperties, onTrigger

Field Details

identifier

private String identifier

name

private String name

schedulingNanos

private long schedulingNanos

serviceLookup

private ControllerServiceLookup serviceLookup

logger

private ComponentLog logger

nodeTypeProvider

private NodeTypeProvider nodeTypeProvider

Constructor Details

AbstractReportingTask

public AbstractReportingTask()

Method Details

initialize

public final void initialize(ReportingInitializationContext config)
                      throws InitializationException

Description copied from interface: ReportingTask

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

Specified by:

initialize in interface ReportingTask

Parameters:

config - of initialization context

Throws:

InitializationException - if unable to init

getControllerServiceLookup

protected final ControllerServiceLookup getControllerServiceLookup()

Returns:

the ControllerServiceLookup that was passed to the initialize(ReportingInitializationContext) method

getNodeTypeProvider

protected final NodeTypeProvider getNodeTypeProvider()

Returns:

the NodeTypeProvider that was passed to the initialize(ReportingInitializationContext) method

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ConfigurableComponent

Returns:

the identifier of this Reporting Task

getName

protected String getName()

Returns:

the name of this Reporting Task

setComponentInfo

@OnScheduled
public void setComponentInfo(ConfigurationContext context)

Sets various component information using the given context

Parameters:

context - the context to use for this reporting task

getSchedulingPeriod

protected long getSchedulingPeriod(TimeUnit timeUnit)

Parameters:

timeUnit - of scheduling period

Returns:

the amount of times that elapses between the moment that this ReportingTask finishes its invocation of ReportingTask.onTrigger(ReportingContext) and the next time that ReportingTask.onTrigger(ReportingContext) is called.

init

protected void init(ReportingInitializationContext config)
             throws InitializationException

Provides a mechanism by which subclasses can perform initialization of the Reporting Task before it is scheduled to be run

Parameters:

config - context

Throws:

InitializationException - if failure to init

getLogger

protected ComponentLog getLogger()

Returns:

the logger that has been provided to the component by the framework in its initialize method