org.apache.nifi.controller

Class AbstractControllerService

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.controller.AbstractControllerService

All Implemented Interfaces:

ConfigurableComponent, ControllerService

public abstract class AbstractControllerService
extends AbstractConfigurableComponent
implements ControllerService

Field Summary

Fields

Modifier and Type	Field and Description
private ConfigurationContext	configContext
private String	identifier
private ComponentLog	logger
private ControllerServiceLookup	serviceLookup

Constructor Summary

Constructors

Constructor and Description
AbstractControllerService()

Method Summary

Methods

Modifier and Type	Method and Description
protected ControllerServiceLookup	getControllerServiceLookup()
String	getIdentifier()
protected ComponentLog	getLogger()
protected Map<PropertyDescriptor,String>	getProperties()
protected PropertyValue	getProperty(PropertyDescriptor descriptor)
protected void	init(ControllerServiceInitializationContext config) Provides a mechanism by which subclasses can perform initialization of the Reporting Task before it is scheduled to be run
void	initialize(ControllerServiceInitializationContext context) Provides the Controller Service with access to objects that may be of use throughout the life of the service.
void	onConfigurationChange(ConfigurationContext 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

Field Detail

identifier

private String identifier

serviceLookup

private ControllerServiceLookup serviceLookup

configContext

private volatile ConfigurationContext configContext

logger

private ComponentLog logger

Constructor Detail

AbstractControllerService

public AbstractControllerService()

Method Detail

initialize

public final void initialize(ControllerServiceInitializationContext context)
                      throws InitializationException

Description copied from interface: ControllerService

Provides the Controller Service with access to objects that may be of use throughout the life of the service. This method will be called before any properties are set

Specified by:

initialize in interface ControllerService

Parameters:

context - of initialization

Throws:

InitializationException - if unable to init

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ConfigurableComponent

Returns:

the unique identifier that the framework assigned to this component

onConfigurationChange

@OnConfigured
public void onConfigurationChange(ConfigurationContext context)

getProperty

protected final PropertyValue getProperty(PropertyDescriptor descriptor)

Parameters:

descriptor - to retrieve value of

Returns:

the currently configured value for the given PropertyDescriptor

getProperties

protected final Map<PropertyDescriptor,String> getProperties()

Returns:

an unmodifiable map of all configured properties for this ControllerService

getControllerServiceLookup

protected final ControllerServiceLookup getControllerServiceLookup()

Returns:

the ControllerServiceLookup that was passed to the #init(ProcessorInitializationContext) method

init

protected void init(ControllerServiceInitializationContext 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 - of initialization context

Throws:

InitializationException - if unable to init

getLogger

protected ComponentLog getLogger()

Returns:

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