Package org.apache.nifi.parameter

Class StandardParameterContext

java.lang.Object

org.apache.nifi.parameter.StandardParameterContext

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, ParameterContext, ParameterLookup

Direct Known Subclasses:

ReferenceOnlyParameterContext

public class StandardParameterContext
extends Object
implements ParameterContext

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	StandardParameterContext.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private String	description
private final String	id
private final List<ParameterContext>	inheritedParameterContexts
private static final org.slf4j.Logger	logger
private String	name
private ParameterProvider	parameterProvider
private ParameterProviderConfiguration	parameterProviderConfiguration
private final ParameterProviderLookup	parameterProviderLookup
private final ParameterReferenceManager	parameterReferenceManager
private final Map<ParameterDescriptor,Parameter>	parameters
private final Authorizable	parentAuthorizable
private final Lock	readLock
private final ReadWriteLock	rwLock
private AtomicLong	version
private final Lock	writeLock

Fields inherited from interface org.apache.nifi.parameter.ParameterLookup

EMPTY

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StandardParameterContext(String id, String name, ParameterReferenceManager parameterReferenceManager, Authorizable parentAuthorizable, ParameterProviderLookup parameterProviderLookup, ParameterProviderConfiguration parameterProviderConfiguration)

Method Summary

Modifier and Type	Method	Description
private void	alertReferencingComponents(Map<String,ParameterUpdate> parameterUpdates)	Alerts all referencing components of any relevant updates.
void	authorize(Authorizer authorizer, RequestAction action, NiFiUser user)
private void	authorizeParameterProviderRead(Authorizer authorizer, ParameterProvider parameterProvider, NiFiUser user)
private void	combineOverrides(Map<ParameterDescriptor,List<Parameter>> existingOverrides, Map<ParameterDescriptor,List<Parameter>> newOverrides)
void	configureParameterProvider(ParameterProviderConfiguration parameterProviderConfiguration)
private Parameter	createFullyPopulatedParameter(Parameter proposedParameter)	When updating a Parameter, the provided 'updated' Parameter may or may not contain a value.
boolean	equals(Object obj)	A ParameterContext's identity is its identifier.
String	getDescription()
Map<ParameterDescriptor,Parameter>	getEffectiveParameters()
private Map<ParameterDescriptor,Parameter>	getEffectiveParameters(List<ParameterContext> parameterContexts)	Constructs an effective view of the parameters, including nested parameters, assuming the given list of ParameterContexts.
private Map<ParameterDescriptor,Parameter>	getEffectiveParameters(List<ParameterContext> parameterContexts, Map<ParameterDescriptor,Parameter> proposedParameters)
private Map<ParameterDescriptor,Parameter>	getEffectiveParameters(List<ParameterContext> parameterContexts, Map<ParameterDescriptor,Parameter> proposedParameters, Map<ParameterDescriptor,List<Parameter>> allOverrides)
private Map<ParameterDescriptor,Parameter>	getEffectiveParameters(Map<ParameterDescriptor,Parameter> proposedParameters)	Constructs an effective view of the parameters, including nested parameters, assuming the given map of parameters.
Map<String,Parameter>	getEffectiveParameterUpdates(Map<String,Parameter> parameterUpdates, List<ParameterContext> inheritedParameterContexts)
private Map<String,Parameter>	getEffectiveParameterUpdates(Map<ParameterDescriptor,Parameter> currentEffectiveParameters, Map<ParameterDescriptor,Parameter> effectiveProposedParameters)	Returns a map that can be used to indicate all effective parameters updates, including removed parameters.
private ParameterDescriptor	getFullyPopulatedDescriptor(Parameter proposedParameter)
String	getIdentifier()
List<String>	getInheritedParameterContextNames()
List<ParameterContext>	getInheritedParameterContexts()
String	getName()
Optional<Parameter>	getParameter(String parameterName)
Optional<Parameter>	getParameter(ParameterDescriptor parameterDescriptor)
ParameterProvider	getParameterProvider()
ParameterProviderConfiguration	getParameterProviderConfiguration()
ParameterProviderLookup	getParameterProviderLookup()
private ParameterProviderNode	getParameterProviderNode(ParameterProvider parameterProvider)
ParameterReferenceManager	getParameterReferenceManager()
Map<ParameterDescriptor,Parameter>	getParameters()
Authorizable	getParentAuthorizable()
String	getProcessGroupIdentifier()
private Map<ParameterDescriptor,Parameter>	getProposedParameters(Map<String,Parameter> proposedParameterUpdates)
Resource	getResource()
long	getVersion()
int	hashCode()	A ParameterContext's identity is its identifier.
boolean	hasReferencingComponents(Parameter parameter)
boolean	inheritsFrom(String parameterContextId)
boolean	isAuthorized(Authorizer authorizer, RequestAction action, NiFiUser user)
boolean	isEmpty()
private Map<ParameterDescriptor,List<Parameter>>	overrideParameters(Map<ParameterDescriptor,Parameter> existingParameters, Map<ParameterDescriptor,Parameter> overridingParameters, ParameterContext overridingContext)
private void	registerParameterProvider(ParameterProvider parameterProvider)
void	setDescription(String description)
void	setInheritedParameterContexts(List<ParameterContext> inheritedParameterContexts)
void	setName(String name)
void	setParameters(Map<String,Parameter> updatedParameters)
String	toString()
private ParameterDescriptor	unescape(ParameterDescriptor descriptor)
private Map<String,ParameterUpdate>	updateParameters(Map<ParameterDescriptor,Parameter> currentParameters, Map<String,Parameter> updatedParameters, boolean performUpdate)	Returns a map from parameter name to ParameterUpdate for any actual updates to parameters.
private void	validateParameterSensitivity(Parameter parameter, ComponentNode componentNode)
private void	validateReferencingComponents(String parameterName, Parameter parameter, boolean duringUpdate)
private void	validateSensitiveFlag(Map<ParameterDescriptor,Parameter> currentParameters, Parameter updatedParameter)
void	verifyCanSetParameters(Map<String,Parameter> updatedParameters)
private void	verifyCanSetParameters(Map<String,Parameter> updatedParameters, boolean duringUpdate)	Ensures that it is legal to update the Parameters for this Parameter Context to match the given set of Parameters
void	verifyCanSetParameters(Map<ParameterDescriptor,Parameter> currentParameters, Map<String,Parameter> updatedParameters, boolean duringUpdate)
void	verifyCanUpdateParameterContext(Map<String,Parameter> parameterUpdates, List<ParameterContext> inheritedParameterContexts)
private void	verifyCanUpdateParameterContext(Map<String,Parameter> parameterUpdates, List<ParameterContext> inheritedParameterContexts, boolean duringUpdate)
private void	verifyNoCycles(List<ParameterContext> parameterContexts)	Verifies that no cycles would exist in the ParameterContext reference graph, if this ParameterContext were to inherit from the given list of ParameterContexts.
private void	verifyNoCycles(Stack<String> traversedIds, List<ParameterContext> parameterContexts)	A helper method for performing a depth first search to verify there are no cycles in the proposed list of ParameterContexts.
private void	verifyProvidedParameters(Map<String,Parameter> parameterUpdates)

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, checkAuthorization, getRequestedResource

Field Details

logger

private static final org.slf4j.Logger logger

id

private final String id

parameterReferenceManager

private final ParameterReferenceManager parameterReferenceManager

parameterProviderLookup

private final ParameterProviderLookup parameterProviderLookup

parentAuthorizable

private final Authorizable parentAuthorizable

name

private String name

version

private AtomicLong version

parameters

private final Map<ParameterDescriptor,Parameter> parameters

inheritedParameterContexts

private final List<ParameterContext> inheritedParameterContexts

parameterProvider

private ParameterProvider parameterProvider

parameterProviderConfiguration

private ParameterProviderConfiguration parameterProviderConfiguration

description

private volatile String description

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

Constructor Details

StandardParameterContext

protected StandardParameterContext(String id,
 String name,
 ParameterReferenceManager parameterReferenceManager,
 Authorizable parentAuthorizable,
 ParameterProviderLookup parameterProviderLookup,
 ParameterProviderConfiguration parameterProviderConfiguration)

Method Details

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface ComponentAuthorizable

Specified by:

getIdentifier in interface ParameterContext

getProcessGroupIdentifier

public String getProcessGroupIdentifier()

Specified by:

getProcessGroupIdentifier in interface ComponentAuthorizable

getName

public String getName()

Specified by:

getName in interface ParameterContext

setName

public void setName(String name)

Specified by:

setName in interface ParameterContext

setDescription

public void setDescription(String description)

Specified by:

setDescription in interface ParameterContext

getDescription

public String getDescription()

Specified by:

getDescription in interface ParameterContext

setParameters

public void setParameters(Map<String,Parameter> updatedParameters)

Specified by:

setParameters in interface ParameterContext

getProposedParameters

private Map<ParameterDescriptor,Parameter> getProposedParameters(Map<String,Parameter> proposedParameterUpdates)

alertReferencingComponents

private void alertReferencingComponents(Map<String,ParameterUpdate> parameterUpdates)

Alerts all referencing components of any relevant updates.

Parameters:

parameterUpdates - A map from parameter name to ParameterUpdate (empty if none are applicable)

updateParameters

private Map<String,ParameterUpdate> updateParameters(Map<ParameterDescriptor,Parameter> currentParameters,
 Map<String,Parameter> updatedParameters,
 boolean performUpdate)

Returns a map from parameter name to ParameterUpdate for any actual updates to parameters.

Parameters:

currentParameters - The current parameters

updatedParameters - An updated parameters map

performUpdate - If true, this will actually perform the updates on the currentParameters map. Otherwise, the updates are simply collected and returned.

Returns:

A map from parameter name to ParameterUpdate for any actual parameters

createFullyPopulatedParameter

private Parameter createFullyPopulatedParameter(Parameter proposedParameter)

When updating a Parameter, the provided 'updated' Parameter may or may not contain a value. This is done because once a Parameter is set, a user may want to change the description of the Parameter but cannot include the value of the Parameter in the request if the Parameter is sensitive (because the value of the Parameter, when retrieved, is masked for sensitive Parameters). As a result, a call may be made to setParameters(Map) that includes a Parameter whose value is null. If we encounter this, we do not want to change the value of the Parameter, so we want to insert into our Map a Parameter object whose value is equal to the current value for that Parameter (if any). This method, then, takes a Parameter whose value may or may not be populated and returns a Parameter whose value is populated, if there is an appropriate value to populate it with.

Parameters:

proposedParameter - the proposed parameter

Returns:

a Parameter whose descriptor is the same as the given proposed parameter but whose value has been populated based on the existing value for that Parameter (if any) if the given proposed parameter does not have its value populated

getFullyPopulatedDescriptor

private ParameterDescriptor getFullyPopulatedDescriptor(Parameter proposedParameter)

getVersion

public long getVersion()

Specified by:

getVersion in interface ParameterLookup

getParameter

public Optional<Parameter> getParameter(String parameterName)

Specified by:

getParameter in interface ParameterLookup

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface ParameterLookup

getParameter

public Optional<Parameter> getParameter(ParameterDescriptor parameterDescriptor)

Specified by:

getParameter in interface ParameterContext

unescape

private ParameterDescriptor unescape(ParameterDescriptor descriptor)

getParameters

public Map<ParameterDescriptor,Parameter> getParameters()

Specified by:

getParameters in interface ParameterContext

getEffectiveParameters

public Map<ParameterDescriptor,Parameter> getEffectiveParameters()

Specified by:

getEffectiveParameters in interface ParameterContext

getEffectiveParameterUpdates

public Map<String,Parameter> getEffectiveParameterUpdates(Map<String,Parameter> parameterUpdates,
 List<ParameterContext> inheritedParameterContexts)

Specified by:

getEffectiveParameterUpdates in interface ParameterContext

getEffectiveParameters

private Map<ParameterDescriptor,Parameter> getEffectiveParameters(Map<ParameterDescriptor,Parameter> proposedParameters)

Constructs an effective view of the parameters, including nested parameters, assuming the given map of parameters. This allows an inspection of what parameters would be available if the given parameters were set in this ParameterContext.

Parameters:

proposedParameters - A Map of proposed parameters that should be used in place of the current parameters

Returns:

The view of the parameters with all overriding applied

getEffectiveParameters

private Map<ParameterDescriptor,Parameter> getEffectiveParameters(List<ParameterContext> parameterContexts)

Constructs an effective view of the parameters, including nested parameters, assuming the given list of ParameterContexts. This allows an inspection of what parameters would be available if the given list were set in this ParameterContext.

Parameters:

parameterContexts - An ordered list of ParameterContexts from which to inherit

Returns:

The view of the parameters with all overriding applied

getEffectiveParameters

private Map<ParameterDescriptor,Parameter> getEffectiveParameters(List<ParameterContext> parameterContexts,
 Map<ParameterDescriptor,Parameter> proposedParameters)

getEffectiveParameters

private Map<ParameterDescriptor,Parameter> getEffectiveParameters(List<ParameterContext> parameterContexts,
 Map<ParameterDescriptor,Parameter> proposedParameters,
 Map<ParameterDescriptor,List<Parameter>> allOverrides)

combineOverrides

private void combineOverrides(Map<ParameterDescriptor,List<Parameter>> existingOverrides,
 Map<ParameterDescriptor,List<Parameter>> newOverrides)

overrideParameters

private Map<ParameterDescriptor,List<Parameter>> overrideParameters(Map<ParameterDescriptor,Parameter> existingParameters,
 Map<ParameterDescriptor,Parameter> overridingParameters,
 ParameterContext overridingContext)

getParameterReferenceManager

public ParameterReferenceManager getParameterReferenceManager()

Specified by:

getParameterReferenceManager in interface ParameterContext

getParameterProviderLookup

public ParameterProviderLookup getParameterProviderLookup()

Specified by:

getParameterProviderLookup in interface ParameterContext

getParameterProvider

public ParameterProvider getParameterProvider()

Specified by:

getParameterProvider in interface ParameterContext

configureParameterProvider

public void configureParameterProvider(ParameterProviderConfiguration parameterProviderConfiguration)

Specified by:

configureParameterProvider in interface ParameterContext

getParameterProviderConfiguration

public ParameterProviderConfiguration getParameterProviderConfiguration()

Specified by:

getParameterProviderConfiguration in interface ParameterContext

registerParameterProvider

private void registerParameterProvider(ParameterProvider parameterProvider)

getParameterProviderNode

private ParameterProviderNode getParameterProviderNode(ParameterProvider parameterProvider)

verifyNoCycles

private void verifyNoCycles(List<ParameterContext> parameterContexts)

Verifies that no cycles would exist in the ParameterContext reference graph, if this ParameterContext were to inherit from the given list of ParameterContexts.

Parameters:

parameterContexts - A list of proposed ParameterContexts

verifyNoCycles

private void verifyNoCycles(Stack<String> traversedIds,
 List<ParameterContext> parameterContexts)

A helper method for performing a depth first search to verify there are no cycles in the proposed list of ParameterContexts.

Parameters:

traversedIds - A collection of already traversed ids in the graph

parameterContexts - The ParameterContexts for which to check for cycles

Throws:

IllegalStateException - If a cycle was detected

verifyCanUpdateParameterContext

public void verifyCanUpdateParameterContext(Map<String,Parameter> parameterUpdates,
 List<ParameterContext> inheritedParameterContexts)

Specified by:

verifyCanUpdateParameterContext in interface ParameterContext

verifyCanUpdateParameterContext

private void verifyCanUpdateParameterContext(Map<String,Parameter> parameterUpdates,
 List<ParameterContext> inheritedParameterContexts,
 boolean duringUpdate)

verifyProvidedParameters

private void verifyProvidedParameters(Map<String,Parameter> parameterUpdates)

setInheritedParameterContexts

public void setInheritedParameterContexts(List<ParameterContext> inheritedParameterContexts)

Specified by:

setInheritedParameterContexts in interface ParameterContext

getEffectiveParameterUpdates

private Map<String,Parameter> getEffectiveParameterUpdates(Map<ParameterDescriptor,Parameter> currentEffectiveParameters,
 Map<ParameterDescriptor,Parameter> effectiveProposedParameters)

Returns a map that can be used to indicate all effective parameters updates, including removed parameters.

Parameters:

currentEffectiveParameters - A current map of effective parameters

effectiveProposedParameters - A map of effective parameters that would result if a proposed update were applied

Returns:

a map that can be used to indicate all effective parameters updates, including removed parameters

hasReferencingComponents

public boolean hasReferencingComponents(Parameter parameter)

Specified by:

hasReferencingComponents in interface ParameterContext

getInheritedParameterContexts

public List<ParameterContext> getInheritedParameterContexts()

Specified by:

getInheritedParameterContexts in interface ParameterContext

getInheritedParameterContextNames

public List<String> getInheritedParameterContextNames()

Specified by:

getInheritedParameterContextNames in interface ParameterContext

inheritsFrom

public boolean inheritsFrom(String parameterContextId)

Specified by:

inheritsFrom in interface ParameterContext

verifyCanSetParameters

public void verifyCanSetParameters(Map<String,Parameter> updatedParameters)

Specified by:

verifyCanSetParameters in interface ParameterContext

verifyCanSetParameters

private void verifyCanSetParameters(Map<String,Parameter> updatedParameters,
 boolean duringUpdate)

Ensures that it is legal to update the Parameters for this Parameter Context to match the given set of Parameters

Parameters:

updatedParameters - the updated set of parameters, keyed by Parameter name

duringUpdate - If true, this check will be treated as if a ParameterContext update is imminent, meaning referencing components may not be active even for updated values. If false, a parameter value update will be valid even if referencing components are active because it will be assumed that these will be stopped prior to the actual update.

Throws:

IllegalStateException - if setting the given set of Parameters is not legal

verifyCanSetParameters

public void verifyCanSetParameters(Map<ParameterDescriptor,Parameter> currentParameters,
 Map<String,Parameter> updatedParameters,
 boolean duringUpdate)

validateSensitiveFlag

private void validateSensitiveFlag(Map<ParameterDescriptor,Parameter> currentParameters,
 Parameter updatedParameter)

validateReferencingComponents

private void validateReferencingComponents(String parameterName,
 Parameter parameter,
 boolean duringUpdate)

validateParameterSensitivity

private void validateParameterSensitivity(Parameter parameter,
 ComponentNode componentNode)

toString

public String toString()

Overrides:

toString in class Object

authorize

public void authorize(Authorizer authorizer,
 RequestAction action,
 NiFiUser user)
               throws AccessDeniedException

Specified by:

authorize in interface Authorizable

Throws:

AccessDeniedException

isAuthorized

public boolean isAuthorized(Authorizer authorizer,
 RequestAction action,
 NiFiUser user)

Specified by:

isAuthorized in interface Authorizable

authorizeParameterProviderRead

private void authorizeParameterProviderRead(Authorizer authorizer,
 ParameterProvider parameterProvider,
 NiFiUser user)

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable

equals

public boolean equals(Object obj)

A ParameterContext's identity is its identifier.

Overrides:

equals in class Object

Parameters:

obj - Another object

Returns:

Whether this is equal to the object

hashCode

public int hashCode()

A ParameterContext's identity is its identifier.

Overrides:

hashCode in class Object

Returns:

The hash code