Module org.apache.nifi
Package org.apache.nifi.reporting

Interface ReportingInitializationContext

All Superinterfaces:
KerberosContext
All Known Implementing Classes:
DocumentationReportingInitializationContext
public interface ReportingInitializationContext extends KerberosContext
A ReportingConfiguration provides configuration information to a ReportingTask at the time of initialization

  • Method Details

    • getIdentifier

      String getIdentifier()
      Returns:
      the identifier for this ReportingTask

    • getName

      String getName()
      Returns:
      the configured name for this ReportingTask

    • 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 - unit of time for scheduling
      Returns:
      period of time

    • getControllerServiceLookup

      ControllerServiceLookup getControllerServiceLookup()
      Returns:
      the ControllerServiceLookup which can be used to obtain Controller Services

    • getSchedulingPeriod

      String getSchedulingPeriod()
      Returns:
      a String representation of the scheduling period

    • getSchedulingStrategy

      SchedulingStrategy getSchedulingStrategy()
      Returns:
      the SchedulingStrategy that is used to trigger the task to run

    • getLogger

      ComponentLog getLogger()
      Returns:
      a logger that can be used to log important events in a standard way and generate bulletins when appropriate

    • getNodeTypeProvider

      NodeTypeProvider getNodeTypeProvider()
      Returns:
      the NodeTypeProvider which can be used to detect the node type of this NiFi instance.
      Since:
      Apache NiFi 1.5.0