Package org.apache.nifi.controller

Interface ConfigurationContext

All Superinterfaces:
PropertyContext
public interface ConfigurationContext extends PropertyContext
This context is passed to ControllerServices and Reporting Tasks in order to expose their configuration to them.

  • Method Details

    • getProperties

      Map<PropertyDescriptor,String> getProperties()
      Returns:
      an unmodifiable map of all configured properties for this ControllerService

    • getAnnotationData

      String getAnnotationData()
      Returns:
      the annotation data configured for the component

    • getSchedulingPeriod

      String getSchedulingPeriod()
      Returns:
      a String representation of the scheduling period, or null if the component does not have a scheduling period (e.g., for ControllerServices)

    • 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 component's onTrigger method and the time at which the method is invoked again. This method will return null if the component does not have a scheduling period (e.g., for ControllerServices)
      Parameters:
      timeUnit - unit of time for scheduling
      Returns:
      period of time or null if component does not have a scheduling period

    • getName

      String getName()
      Returns the component's (ControllerService, ReportingTask, ParameterProvider, e.g.) name
      Returns:
      the String name of this component