org.apache.nifi.controller

Interface ConfigurationContext

public interface ConfigurationContext

This context is passed to ControllerServices and Reporting Tasks in order to expose their configuration to them.

Method Summary

Methods

Modifier and Type	Method and Description
Map<PropertyDescriptor,String>	getProperties()
PropertyValue	getProperty(PropertyDescriptor property)
String	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.

Method Detail

getProperty

PropertyValue getProperty(PropertyDescriptor property)

Parameters:

property - to retrieve by name

Returns:

the configured value for the property with the given name

getProperties

Map<PropertyDescriptor,String> getProperties()

Returns:

an unmodifiable map of all configured properties for this ControllerService

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