org.apache.nifi.reporting

Interface ReportingInitializationContext

public interface ReportingInitializationContext

A ReportingConfiguration provides configuration information to a ReportingTask at the time of initialization

Method Summary

Methods

Modifier and Type	Method and Description
ControllerServiceLookup	getControllerServiceLookup() Returns the ControllerServiceLookup which can be used to obtain Controller Services
String	getIdentifier() Returns the identifier for this ReportingTask
String	getName() Returns the configured name for this ReportingTask
String	getSchedulingPeriod() Returns a String representation of the scheduling period.
long	getSchedulingPeriod(TimeUnit timeUnit) Returns the amount of time, in the given TimeUnit that will elapsed between the return of one execution of the ReportingTask's onTrigger method and the time at which the method is invoked again.
SchedulingStrategy	getSchedulingStrategy() Returns the SchedulingStrategy that is used to trigger the task to run

Method Detail

getIdentifier

String getIdentifier()

Returns the identifier for this ReportingTask

Returns:

getName

String getName()

Returns the configured name for this ReportingTask

Returns:

getSchedulingPeriod

long getSchedulingPeriod(TimeUnit timeUnit)

Returns the amount of time, in the given TimeUnit that will elapsed between the return of one execution of the ReportingTask's onTrigger method and the time at which the method is invoked again. This method will return -1L if the Scheduling Strategy is not set to SchedulingStrategy.TIMER_DRIVEN

Parameters:

timeUnit -

Returns:

getControllerServiceLookup

ControllerServiceLookup getControllerServiceLookup()

Returns the ControllerServiceLookup which can be used to obtain Controller Services

Returns:

getSchedulingPeriod

String getSchedulingPeriod()

Returns a String representation of the scheduling period.

Returns:

getSchedulingStrategy

SchedulingStrategy getSchedulingStrategy()

Returns the SchedulingStrategy that is used to trigger the task to run

Returns: