org.apache.nifi.parameter

Class StandardParameterContext

java.lang.Object

org.apache.nifi.parameter.StandardParameterContext

All Implemented Interfaces:

Authorizable, ComponentAuthorizable, ParameterContext, ParameterLookup

public class StandardParameterContext
extends Object
implements ParameterContext

Field Summary

Fields

Modifier and Type	Field and Description
private String	description
private String	id
private static org.slf4j.Logger	logger
private String	name
private ParameterReferenceManager	parameterReferenceManager
private Map<ParameterDescriptor,Parameter>	parameters
private Authorizable	parentAuthorizable
private Lock	readLock
private ReadWriteLock	rwLock
private long	version
private Lock	writeLock

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

EMPTY

Constructor Summary

Constructors

Constructor and Description
StandardParameterContext(String id, String name, ParameterReferenceManager parameterReferenceManager, Authorizable parentAuthorizable)

Method Summary

Modifier and Type	Method and Description
private Parameter	createFullyPopulatedParameter(Parameter proposedParameter) When updating a Parameter, the provided 'updated' Parameter may or may not contain a value.
String	getDescription()
private ParameterDescriptor	getFullyPopulatedDescriptor(Parameter proposedParameter)
private String	getFullyPopulatedValue(Parameter proposedParameter)
String	getIdentifier()
String	getName()
Optional<Parameter>	getParameter(ParameterDescriptor parameterDescriptor)
Optional<Parameter>	getParameter(String parameterName)
ParameterReferenceManager	getParameterReferenceManager()
Map<ParameterDescriptor,Parameter>	getParameters()
Authorizable	getParentAuthorizable()
String	getProcessGroupIdentifier()
Resource	getResource()
long	getVersion()
boolean	isEmpty()
void	setDescription(String description)
void	setName(String name)
void	setParameters(Map<String,Parameter> updatedParameters)
String	toString()
private void	validateParameterSensitivity(Parameter parameter, ComponentNode componentNode)
private void	validateReferencingComponents(String parameterName, Parameter parameter, String parameterAction)
private void	validateSensitiveFlag(Parameter updatedParameter)
void	verifyCanSetParameters(Map<String,Parameter> updatedParameters)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

authorize, authorize, checkAuthorization, checkAuthorization, getRequestedResource, isAuthorized

Field Detail

logger

private static final org.slf4j.Logger logger

id

private final String id

parameterReferenceManager

private final ParameterReferenceManager parameterReferenceManager

parentAuthorizable

private final Authorizable parentAuthorizable

name

private String name

version

private long version

parameters

private final Map<ParameterDescriptor,Parameter> parameters

description

private volatile String description

rwLock

private final ReadWriteLock rwLock

readLock

private final Lock readLock

writeLock

private final Lock writeLock

Constructor Detail

StandardParameterContext

public StandardParameterContext(String id,
                                String name,
                                ParameterReferenceManager parameterReferenceManager,
                                Authorizable parentAuthorizable)

Method Detail

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

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

getFullyPopulatedValue

private String getFullyPopulatedValue(Parameter proposedParameter)

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

getParameters

public Map<ParameterDescriptor,Parameter> getParameters()

Specified by:

getParameters in interface ParameterContext

getParameterReferenceManager

public ParameterReferenceManager getParameterReferenceManager()

Specified by:

getParameterReferenceManager in interface ParameterContext

verifyCanSetParameters

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

Specified by:

verifyCanSetParameters in interface ParameterContext

validateSensitiveFlag

private void validateSensitiveFlag(Parameter updatedParameter)

validateReferencingComponents

private void validateReferencingComponents(String parameterName,
                                           Parameter parameter,
                                           String parameterAction)

validateParameterSensitivity

private void validateParameterSensitivity(Parameter parameter,
                                          ComponentNode componentNode)

toString

public String toString()

Overrides:

toString in class Object

getParentAuthorizable

public Authorizable getParentAuthorizable()

Specified by:

getParentAuthorizable in interface Authorizable

getResource

public Resource getResource()

Specified by:

getResource in interface Authorizable