Package 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	Description
private ConfigurationContext	configurationContext
private boolean	enabled
private String	identifier
private ComponentLog	logger
private NodeTypeProvider	nodeTypeProvider
private ControllerServiceLookup	serviceLookup
private StateManager	stateManager

Constructor Summary

Constructors

Constructor	Description
AbstractControllerService()

Method Summary

Modifier and Type	Method	Description
final void	abstractClearConfigContext()
final void	abstractStoreConfigContext(ConfigurationContext configContext)
final void	disabled()
final void	enabled()
protected ConfigurationContext	getConfigurationContext()
protected final ControllerServiceLookup	getControllerServiceLookup()
String	getIdentifier()
protected ComponentLog	getLogger()
protected final NodeTypeProvider	getNodeTypeProvider()
protected PropertyValue	getProperty(PropertyDescriptor descriptor)
protected StateManager	getStateManager()
protected void	init(ControllerServiceInitializationContext config)	Provides a mechanism by which subclasses can perform initialization of the Controller Service before it is scheduled to be run
final void	initialize(ControllerServiceInitializationContext context)	Provides the Controller Service with access to objects that may be of use throughout the life of the service.
boolean	isEnabled()

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

Methods inherited from interface org.apache.nifi.controller.ControllerService

isStateful, migrateProperties

Field Details

identifier

private String identifier

serviceLookup

private ControllerServiceLookup serviceLookup

logger

private ComponentLog logger

stateManager

private StateManager stateManager

configurationContext

private volatile ConfigurationContext configurationContext

enabled

private volatile boolean enabled

nodeTypeProvider

private NodeTypeProvider nodeTypeProvider

Constructor Details

AbstractControllerService

public AbstractControllerService()

Method Details

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

getControllerServiceLookup

protected final ControllerServiceLookup getControllerServiceLookup()

Returns:

the ControllerServiceLookup that was passed to the init(ControllerServiceInitializationContext) method

getNodeTypeProvider

protected final NodeTypeProvider getNodeTypeProvider()

Returns:

the NodeTypeProvider that was passed to the init(ControllerServiceInitializationContext) method

init

protected void init(ControllerServiceInitializationContext config)
             throws InitializationException

Provides a mechanism by which subclasses can perform initialization of the Controller Service before it is scheduled to be run

Parameters:

config - of initialization context

Throws:

InitializationException - if unable to init

enabled

@OnEnabled
public final void enabled()

disabled

@OnDisabled
public final void disabled()

isEnabled

public boolean isEnabled()

getLogger

protected ComponentLog getLogger()

Returns:

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

getStateManager

protected StateManager getStateManager()

Returns:

the StateManager that can be used to store and retrieve state for this Controller Service

abstractStoreConfigContext

@OnEnabled
public final void abstractStoreConfigContext(ConfigurationContext configContext)

abstractClearConfigContext

@OnDisabled
public final void abstractClearConfigContext()

getConfigurationContext

protected ConfigurationContext getConfigurationContext()

getProperty

protected PropertyValue getProperty(PropertyDescriptor descriptor)