org.apache.nifi.controller.service

Class StandardControllerServiceNode

java.lang.Object

org.apache.nifi.controller.AbstractComponentNode

org.apache.nifi.controller.service.StandardControllerServiceNode

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, VersionedComponent, ComponentNode, ControllerServiceNode

public class StandardControllerServiceNode
extends AbstractComponentNode
implements ControllerServiceNode

Field Summary

Fields

Modifier and Type	Field and Description
private AtomicBoolean	active
private String	comment
private AtomicReference<ControllerServiceDetails>	controllerServiceHolder
private static org.slf4j.Logger	LOG
private ProcessGroup	processGroup
private Lock	readLock
private Set<Tuple<ComponentNode,PropertyDescriptor>>	referencingComponents
private ReadWriteLock	rwLock
private ControllerServiceProvider	serviceProvider
private ServiceStateTransition	stateTransition
private AtomicReference<String>	versionedComponentId
private Lock	writeLock

Constructor Summary

Constructors

Constructor and Description
StandardControllerServiceNode(LoggableComponent<ControllerService> implementation, LoggableComponent<ControllerService> proxiedControllerService, ControllerServiceInvocationHandler invocationHandler, String id, ValidationContextFactory validationContextFactory, ControllerServiceProvider serviceProvider, ComponentVariableRegistry variableRegistry, ReloadComponent reloadComponent, ExtensionManager extensionManager, ValidationTrigger validationTrigger)
StandardControllerServiceNode(LoggableComponent<ControllerService> implementation, LoggableComponent<ControllerService> proxiedControllerService, ControllerServiceInvocationHandler invocationHandler, String id, ValidationContextFactory validationContextFactory, ControllerServiceProvider serviceProvider, String componentType, String componentCanonicalClass, ComponentVariableRegistry variableRegistry, ReloadComponent reloadComponent, ExtensionManager extensionManager, ValidationTrigger validationTrigger, boolean isExtensionMissing)

Method Summary

Modifier and Type	Method and Description
void	addReference(ComponentNode referencingComponent, PropertyDescriptor propertyDescriptor)
CompletableFuture<Void>	disable(ScheduledExecutorService scheduler) Will atomically disable this service by invoking its @OnDisabled operation.
CompletableFuture<Void>	enable(ScheduledExecutorService scheduler, long administrativeYieldMillis) Will atomically enable this service by invoking its @OnEnabled operation.
BundleCoordinate	getBundleCoordinate()
String	getComments()
ConfigurableComponent	getComponent()
Class<?>	getComponentClass()
ControllerService	getControllerServiceImplementation()
ControllerServiceInvocationHandler	getInvocationHandler()
TerminationAwareLogger	getLogger()
protected ParameterContext	getParameterContext()
ParameterLookup	getParameterLookup()
Authorizable	getParentAuthorizable()
ProcessGroup	getProcessGroup()
String	getProcessGroupIdentifier()
ControllerService	getProxiedControllerService()
ControllerServiceReference	getReferences()
List<ControllerServiceNode>	getRequiredControllerServices()
Resource	getResource()
ControllerServiceState	getState()
Optional<String>	getVersionedComponentId()
private void	invokeDisable(ConfigurationContext configContext)
boolean	isActive()
boolean	isDeprecated()
boolean	isRestricted()
boolean	isValidationNecessary()
void	reload(Set<URL> additionalUrls)
void	removeReference(ComponentNode referencingComponent, PropertyDescriptor propertyDescriptor)
void	setComments(String comment)
void	setControllerServiceAndProxy(LoggableComponent<ControllerService> implementation, LoggableComponent<ControllerService> proxiedControllerService, ControllerServiceInvocationHandler invocationHandler)
void	setProcessGroup(ProcessGroup group)
void	setVersionedComponentId(String versionedComponentId)
String	toString()
private void	validateReferences()
void	verifyCanClearState()
void	verifyCanDelete()
void	verifyCanDisable()
void	verifyCanDisable(Set<ControllerServiceNode> ignoreReferences)
void	verifyCanEnable()
void	verifyCanEnable(Set<ControllerServiceNode> ignoredReferences)
void	verifyCanUpdate()
void	verifyModifiable()

Methods inherited from class org.apache.nifi.controller.AbstractComponentNode

computeValidationErrors, equals, getAdditionalClasspathResources, getAnnotationData, getCanonicalClassName, getComponentType, getEffectivePropertyValue, getEffectivePropertyValues, getExtensionManager, getIdentifier, getName, getProperties, getProperty, getPropertyDescriptor, getPropertyDescriptors, getRawPropertyValue, getRawPropertyValues, getReferencedParameterNames, getReloadComponent, getValidationContext, getValidationContextFactory, getValidationErrors, getValidationErrors, getValidationState, getValidationStatus, getValidationStatus, getVariableRegistry, hashCode, isExtensionMissing, isReferencingParameter, onParametersModified, onPropertyModified, pauseValidationTrigger, performValidation, performValidation, performValidation, refreshProperties, reloadAdditionalResourcesIfNecessary, resetValidationState, resumeValidationTrigger, setAdditionalResourcesFingerprint, setAnnotationData, setExtensionMissing, setName, setProperties, validateReferencedControllerServices, verifyCanUpdateBundle, verifyCanUpdateProperties

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

authorize, checkAuthorization, getAdditionalClasspathResources, getAnnotationData, getCanonicalClassName, getComponentType, getEffectivePropertyValue, getEffectivePropertyValues, getIdentifier, getName, getProperties, getProperty, getPropertyDescriptor, getPropertyDescriptors, getRawPropertyValue, getRawPropertyValues, getReferencedParameterNames, getValidationErrors, getValidationStatus, getValidationStatus, getVariableRegistry, isExtensionMissing, isReferencingParameter, onParametersModified, pauseValidationTrigger, performValidation, performValidation, performValidation, refreshProperties, reloadAdditionalResourcesIfNecessary, resetValidationState, resumeValidationTrigger, setAnnotationData, setExtensionMissing, setName, setProperties, setProperties, verifyCanUpdateBundle, verifyCanUpdateProperties

Methods inherited from interface org.apache.nifi.authorization.resource.Authorizable

authorize, checkAuthorization, getRequestedResource, isAuthorized

Field Detail

LOG

private static final org.slf4j.Logger LOG

controllerServiceHolder

private final AtomicReference<ControllerServiceDetails> controllerServiceHolder

serviceProvider

private final ControllerServiceProvider serviceProvider

stateTransition

private final ServiceStateTransition stateTransition

versionedComponentId

private final AtomicReference<String> versionedComponentId

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

referencingComponents

private final Set<Tuple<ComponentNode,PropertyDescriptor>> referencingComponents

comment

private volatile String comment

processGroup

private volatile ProcessGroup processGroup

active

private final AtomicBoolean active

Constructor Detail

StandardControllerServiceNode

public StandardControllerServiceNode(LoggableComponent<ControllerService> implementation,
                                     LoggableComponent<ControllerService> proxiedControllerService,
                                     ControllerServiceInvocationHandler invocationHandler,
                                     String id,
                                     ValidationContextFactory validationContextFactory,
                                     ControllerServiceProvider serviceProvider,
                                     ComponentVariableRegistry variableRegistry,
                                     ReloadComponent reloadComponent,
                                     ExtensionManager extensionManager,
                                     ValidationTrigger validationTrigger)

StandardControllerServiceNode

public StandardControllerServiceNode(LoggableComponent<ControllerService> implementation,
                                     LoggableComponent<ControllerService> proxiedControllerService,
                                     ControllerServiceInvocationHandler invocationHandler,
                                     String id,
                                     ValidationContextFactory validationContextFactory,
                                     ControllerServiceProvider serviceProvider,
                                     String componentType,
                                     String componentCanonicalClass,
                                     ComponentVariableRegistry variableRegistry,
                                     ReloadComponent reloadComponent,
                                     ExtensionManager extensionManager,
                                     ValidationTrigger validationTrigger,
                                     boolean isExtensionMissing)

Method Detail

getComponent

public ConfigurableComponent getComponent()

Specified by:

getComponent in interface ComponentNode

getLogger

public TerminationAwareLogger getLogger()

Specified by:

getLogger in interface ComponentNode

getBundleCoordinate

public BundleCoordinate getBundleCoordinate()

Specified by:

getBundleCoordinate in interface ComponentNode

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable

isRestricted

public boolean isRestricted()

Specified by:

isRestricted in interface ComponentNode

getComponentClass

public Class<?> getComponentClass()

Specified by:

getComponentClass in interface ComponentNode

isDeprecated

public boolean isDeprecated()

Specified by:

isDeprecated in interface ComponentNode

getControllerServiceImplementation

public ControllerService getControllerServiceImplementation()

Specified by:

getControllerServiceImplementation in interface ControllerServiceNode

getProxiedControllerService

public ControllerService getProxiedControllerService()

Specified by:

getProxiedControllerService in interface ControllerServiceNode

getInvocationHandler

public ControllerServiceInvocationHandler getInvocationHandler()

Specified by:

getInvocationHandler in interface ControllerServiceNode

setControllerServiceAndProxy

public void setControllerServiceAndProxy(LoggableComponent<ControllerService> implementation,
                                         LoggableComponent<ControllerService> proxiedControllerService,
                                         ControllerServiceInvocationHandler invocationHandler)

Specified by:

setControllerServiceAndProxy in interface ControllerServiceNode

reload

public void reload(Set<URL> additionalUrls)
            throws ControllerServiceInstantiationException

Specified by:

reload in interface ComponentNode

Throws:

ControllerServiceInstantiationException

getProcessGroup

public ProcessGroup getProcessGroup()

Specified by:

getProcessGroup in interface ControllerServiceNode

setProcessGroup

public void setProcessGroup(ProcessGroup group)

Specified by:

setProcessGroup in interface ControllerServiceNode

getReferences

public ControllerServiceReference getReferences()

Specified by:

getReferences in interface ControllerServiceNode

addReference

public void addReference(ComponentNode referencingComponent,
                         PropertyDescriptor propertyDescriptor)

Specified by:

addReference in interface ControllerServiceNode

getParameterContext

protected ParameterContext getParameterContext()

Specified by:

getParameterContext in class AbstractComponentNode

getRequiredControllerServices

public List<ControllerServiceNode> getRequiredControllerServices()

Specified by:

getRequiredControllerServices in interface ControllerServiceNode

removeReference

public void removeReference(ComponentNode referencingComponent,
                            PropertyDescriptor propertyDescriptor)

Specified by:

removeReference in interface ControllerServiceNode

verifyModifiable

public void verifyModifiable()
                      throws IllegalStateException

Specified by:

verifyModifiable in class AbstractComponentNode

Throws:

IllegalStateException

verifyCanDelete

public void verifyCanDelete()

Specified by:

verifyCanDelete in interface ControllerServiceNode

verifyCanDisable

public void verifyCanDisable()

Specified by:

verifyCanDisable in interface ControllerServiceNode

verifyCanDisable

public void verifyCanDisable(Set<ControllerServiceNode> ignoreReferences)

Specified by:

verifyCanDisable in interface ControllerServiceNode

verifyCanEnable

public void verifyCanEnable()

Specified by:

verifyCanEnable in interface ControllerServiceNode

verifyCanEnable

public void verifyCanEnable(Set<ControllerServiceNode> ignoredReferences)

Specified by:

verifyCanEnable in interface ControllerServiceNode

verifyCanUpdate

public void verifyCanUpdate()

Specified by:

verifyCanUpdate in interface ControllerServiceNode

verifyCanClearState

public void verifyCanClearState()

Specified by:

verifyCanClearState in interface ControllerServiceNode

getComments

public String getComments()

Specified by:

getComments in interface ControllerServiceNode

setComments

public void setComments(String comment)

Specified by:

setComments in interface ControllerServiceNode

getState

public ControllerServiceState getState()

Specified by:

getState in interface ControllerServiceNode

isActive

public boolean isActive()

Specified by:

isActive in interface ControllerServiceNode

isValidationNecessary

public boolean isValidationNecessary()

Specified by:

isValidationNecessary in interface ComponentNode

enable

public CompletableFuture<Void> enable(ScheduledExecutorService scheduler,
                                      long administrativeYieldMillis)

Will atomically enable this service by invoking its @OnEnabled operation. It uses CAS operation on stateTransition to transition this service from DISABLED to ENABLING state. If such transition succeeds the service will be marked as 'active' (see ControllerServiceNode.isActive()). If such transition doesn't succeed then no enabling logic will be performed and the method will exit. In other words it is safe to invoke this operation multiple times and from multiple threads.
This operation will also perform re-try of service enabling in the event of exception being thrown by previous invocation of @OnEnabled.
Upon successful invocation of @OnEnabled this service will be transitioned to ENABLED state.
In the event where enabling took longer then expected by the user and such user initiated disable operation, this service will be automatically disabled as soon as it reached ENABLED state.

Specified by:

enable in interface ControllerServiceNode

validateReferences

private void validateReferences()

disable

public CompletableFuture<Void> disable(ScheduledExecutorService scheduler)

Will atomically disable this service by invoking its @OnDisabled operation. It uses CAS operation on stateTransition to transition this service from ENABLED to DISABLING state. If such transition succeeds the service will be de-activated (see ControllerServiceNode.isActive()). If such transition doesn't succeed (the service is still in ENABLING state) then the service will still be transitioned to DISABLING state to ensure that no other transition could happen on this service. However in such event (e.g., its @OnEnabled finally succeeded), the enable(ScheduledExecutorService, long) operation will initiate service disabling javadoc for (see enable(ScheduledExecutorService, long)
Upon successful invocation of @OnDisabled this service will be transitioned to DISABLED state.

Specified by:

disable in interface ControllerServiceNode

invokeDisable

private void invokeDisable(ConfigurationContext configContext)

getProcessGroupIdentifier

public String getProcessGroupIdentifier()

Specified by:

getProcessGroupIdentifier in interface ComponentAuthorizable

getVersionedComponentId

public Optional<String> getVersionedComponentId()

Specified by:

getVersionedComponentId in interface VersionedComponent

setVersionedComponentId

public void setVersionedComponentId(String versionedComponentId)

Specified by:

setVersionedComponentId in interface VersionedComponent

toString

public String toString()

Overrides:

toString in class AbstractComponentNode

getParameterLookup

public ParameterLookup getParameterLookup()

Specified by:

getParameterLookup in interface ComponentNode