Package org.apache.nifi.controller.parameter

Class StandardParameterProviderNode

java.lang.Object

org.apache.nifi.controller.AbstractComponentNode

org.apache.nifi.controller.parameter.StandardParameterProviderNode

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, ComponentNode, ParameterProviderNode

public class StandardParameterProviderNode
extends AbstractComponentNode
implements ParameterProviderNode

Field Summary

Fields

Modifier and Type	Field	Description
private String	comment
private final List<ParameterGroup>	fetchedParameterGroups
private static final Pattern	PARAMETER_NAME_PATTERN
private final AtomicReference<ParameterProviderDetails>	parameterProviderRef
private final Authorizable	parentAuthorizable
private final Lock	readLock
private final Set<ParameterContext>	referencingParameterContexts
private final ReadWriteLock	rwLock
private final ControllerServiceLookup	serviceLookup
private final Lock	writeLock

Constructor Summary

Constructors

Constructor	Description
StandardParameterProviderNode(LoggableComponent<ParameterProvider> parameterProvider, String id, Authorizable parentAuthorizable, ControllerServiceProvider controllerServiceProvider, ValidationContextFactory validationContextFactory, String componentType, String canonicalClassName, ReloadComponent reloadComponent, ExtensionManager extensionManager, ValidationTrigger validationTrigger, boolean isExtensionMissing)
StandardParameterProviderNode(LoggableComponent<ParameterProvider> parameterProvider, String id, Authorizable parentAuthorizable, ControllerServiceProvider controllerServiceProvider, ValidationContextFactory validationContextFactory, ReloadComponent reloadComponent, ExtensionManager extensionManager, ValidationTrigger validationTrigger)

Method Summary

Modifier and Type	Method	Description
void	addReference(ParameterContext reference)
private List<Parameter>	configureParameters(Collection<Parameter> parameters, ParameterGroupConfiguration groupConfiguration)	Filters the list of parameters based on the parameter names and sets the sensitivity accordingly
protected String	determineClasloaderIsolationKey()
void	fetchParameters()
Optional<ParameterGroup>	findFetchedParameterGroup(String parameterGroupName)
BundleCoordinate	getBundleCoordinate()
String	getComments()
ConfigurableComponent	getComponent()
Class<?>	getComponentClass()
ConfigurationContext	getConfigurationContext()
List<ParametersApplication>	getFetchedParametersToApply(Collection<ParameterGroupConfiguration> parameterGroupConfigurations)
private Map<String,Parameter>	getFetchedParameterUpdateMap(ParameterContext parameterContext, ParameterGroupConfiguration parameterGroupConfiguration)	Using the existing parameters from the ParameterContext and the fetched parameters in the provider, constructs a map from Parameter name to updated Parameter (or null if the parameter has been removed in the fetch).
TerminationAwareLogger	getLogger()
protected ParameterContext	getParameterContext()
Collection<ParameterGroupConfiguration>	getParameterGroupConfigurations()
ParameterLookup	getParameterLookup()
ParameterProvider	getParameterProvider()
Authorizable	getParentAuthorizable()
Optional<ProcessGroup>	getParentProcessGroup()
String	getProcessGroupIdentifier()
Set<ParameterContext>	getReferences()
Resource	getResource()
boolean	isDeprecated()
boolean	isRestricted()
boolean	isValidationNecessary()
void	reload(Set<URL> additionalUrls)
void	removeReference(ParameterContext reference)
void	setComments(String comment)
void	setParameterProvider(LoggableComponent<ParameterProvider> parameterProvider)
private static List<Parameter>	toProvidedParameters(Collection<Parameter> parameters)	Sets provided = true on all parameters in the list
String	toString()
protected List<ValidationResult>	validateConfig()
void	verifyCanApplyParameters(Collection<ParameterGroupConfiguration> parameterGroupConfigurations)
void	verifyCanClearState()
void	verifyCanDelete()
void	verifyCanFetchParameters()
List<ConfigVerificationResult>	verifyConfiguration(ConfigurationContext context, ComponentLog logger, ExtensionManager extensionManager)
void	verifyModifiable()

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

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

Methods inherited from class java.lang.Object

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

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

authorize, checkAuthorization, getRequestedResource, isAuthorized

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

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

Field Details

PARAMETER_NAME_PATTERN

private static final Pattern PARAMETER_NAME_PATTERN

parameterProviderRef

private final AtomicReference<ParameterProviderDetails> parameterProviderRef

serviceLookup

private final ControllerServiceLookup serviceLookup

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

referencingParameterContexts

private final Set<ParameterContext> referencingParameterContexts

fetchedParameterGroups

private final List<ParameterGroup> fetchedParameterGroups

comment

private volatile String comment

parentAuthorizable

private final Authorizable parentAuthorizable

Constructor Details

StandardParameterProviderNode

public StandardParameterProviderNode(LoggableComponent<ParameterProvider> parameterProvider,
 String id,
 Authorizable parentAuthorizable,
 ControllerServiceProvider controllerServiceProvider,
 ValidationContextFactory validationContextFactory,
 ReloadComponent reloadComponent,
 ExtensionManager extensionManager,
 ValidationTrigger validationTrigger)

StandardParameterProviderNode

public StandardParameterProviderNode(LoggableComponent<ParameterProvider> parameterProvider,
 String id,
 Authorizable parentAuthorizable,
 ControllerServiceProvider controllerServiceProvider,
 ValidationContextFactory validationContextFactory,
 String componentType,
 String canonicalClassName,
 ReloadComponent reloadComponent,
 ExtensionManager extensionManager,
 ValidationTrigger validationTrigger,
 boolean isExtensionMissing)

Method Details

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

getParameterContext

protected ParameterContext getParameterContext()

Specified by:

getParameterContext in class AbstractComponentNode

getComponent

public ConfigurableComponent getComponent()

Specified by:

getComponent in interface ComponentNode

getBundleCoordinate

public BundleCoordinate getBundleCoordinate()

Specified by:

getBundleCoordinate in interface ComponentNode

getLogger

public TerminationAwareLogger getLogger()

Specified by:

getLogger in interface ComponentNode

getParameterProvider

public ParameterProvider getParameterProvider()

Specified by:

getParameterProvider in interface ParameterProviderNode

setParameterProvider

public void setParameterProvider(LoggableComponent<ParameterProvider> parameterProvider)

Specified by:

setParameterProvider in interface ParameterProviderNode

reload

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

Specified by:

reload in interface ComponentNode

Throws:

ParameterProviderInstantiationException

isValidationNecessary

public boolean isValidationNecessary()

Specified by:

isValidationNecessary in interface ComponentNode

getParentProcessGroup

public Optional<ProcessGroup> getParentProcessGroup()

Specified by:

getParentProcessGroup in interface ComponentNode

getConfigurationContext

public ConfigurationContext getConfigurationContext()

Specified by:

getConfigurationContext in interface ParameterProviderNode

verifyModifiable

public void verifyModifiable()
                      throws IllegalStateException

Specified by:

verifyModifiable in class AbstractComponentNode

Throws:

IllegalStateException

getComments

public String getComments()

Specified by:

getComments in interface ParameterProviderNode

setComments

public void setComments(String comment)

Specified by:

setComments in interface ParameterProviderNode

verifyCanClearState

public void verifyCanClearState()

Specified by:

verifyCanClearState in interface ParameterProviderNode

toString

public String toString()

Overrides:

toString in class AbstractComponentNode

getProcessGroupIdentifier

public String getProcessGroupIdentifier()

Specified by:

getProcessGroupIdentifier in interface ComponentAuthorizable

getParameterLookup

public ParameterLookup getParameterLookup()

Specified by:

getParameterLookup in interface ComponentNode

getReferences

public Set<ParameterContext> getReferences()

Specified by:

getReferences in interface ParameterProviderNode

addReference

public void addReference(ParameterContext reference)

Specified by:

addReference in interface ParameterProviderNode

removeReference

public void removeReference(ParameterContext reference)

Specified by:

removeReference in interface ParameterProviderNode

validateConfig

protected List<ValidationResult> validateConfig()

Specified by:

validateConfig in class AbstractComponentNode

verifyCanFetchParameters

public void verifyCanFetchParameters()

Specified by:

verifyCanFetchParameters in interface ParameterProviderNode

fetchParameters

public void fetchParameters()

Specified by:

fetchParameters in interface ParameterProviderNode

findFetchedParameterGroup

public Optional<ParameterGroup> findFetchedParameterGroup(String parameterGroupName)

Specified by:

findFetchedParameterGroup in interface ParameterProviderNode

verifyCanApplyParameters

public void verifyCanApplyParameters(Collection<ParameterGroupConfiguration> parameterGroupConfigurations)

Specified by:

verifyCanApplyParameters in interface ParameterProviderNode

verifyCanDelete

public void verifyCanDelete()

Specified by:

verifyCanDelete in interface ParameterProviderNode

verifyConfiguration

public List<ConfigVerificationResult> verifyConfiguration(ConfigurationContext context,
 ComponentLog logger,
 ExtensionManager extensionManager)

Specified by:

verifyConfiguration in interface ParameterProviderNode

getFetchedParameterUpdateMap

private Map<String,Parameter> getFetchedParameterUpdateMap(ParameterContext parameterContext,
 ParameterGroupConfiguration parameterGroupConfiguration)

Using the existing parameters from the ParameterContext and the fetched parameters in the provider, constructs a map from Parameter name to updated Parameter (or null if the parameter has been removed in the fetch).

Parameters:

parameterContext - A ParameterContext

parameterGroupConfiguration - The configuration for the fetched parameter group

Returns:

A map from name to Parameter (or null if parameter should be removed)

configureParameters

private List<Parameter> configureParameters(Collection<Parameter> parameters,
 ParameterGroupConfiguration groupConfiguration)

Filters the list of parameters based on the parameter names and sets the sensitivity accordingly

Parameters:

parameters - A list of Parameters

groupConfiguration - The user's configuration of the fetched parameters

Returns:

A list of parameters with the configured sensitivities (only those found in the configuration will be included)

toProvidedParameters

private static List<Parameter> toProvidedParameters(Collection<Parameter> parameters)

Sets provided = true on all parameters in the list

Parameters:

parameters - A list of Parameters

Returns:

An equivalent list, but with provided = true

getParameterGroupConfigurations

public Collection<ParameterGroupConfiguration> getParameterGroupConfigurations()

Specified by:

getParameterGroupConfigurations in interface ParameterProviderNode

getFetchedParametersToApply

public List<ParametersApplication> getFetchedParametersToApply(Collection<ParameterGroupConfiguration> parameterGroupConfigurations)

Specified by:

getFetchedParametersToApply in interface ParameterProviderNode

determineClasloaderIsolationKey

protected String determineClasloaderIsolationKey()

Overrides:

determineClasloaderIsolationKey in class AbstractComponentNode