org.apache.nifi.parameter

Class EnvironmentVariableParameterProvider

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.parameter.AbstractParameterProvider

org.apache.nifi.parameter.EnvironmentVariableParameterProvider

All Implemented Interfaces:

ConfigurableComponent, ParameterProvider, VerifiableParameterProvider

@Tags(value={"environment","variable"})
 @CapabilityDescription(value="Fetches parameters from environment variables")
 @Restricted(restrictions=@Restriction(requiredPermission=ACCESS_ENVIRONMENT_CREDENTIALS,explanation="Provides operator the ability to read environment variables, which may contain environment credentials."))
public class EnvironmentVariableParameterProvider
extends AbstractParameterProvider
implements VerifiableParameterProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	EnvironmentVariableParameterProvider.CommaSeparatedEnvironmentVariableInclusionStrategy
(package private) static interface	EnvironmentVariableParameterProvider.EnvironmentVariableInclusionStrategy
(package private) static class	EnvironmentVariableParameterProvider.IncludeAllEnvironmentVariableInclusionStrategy
private static class	EnvironmentVariableParameterProvider.InclusionStrategyValue
(package private) static class	EnvironmentVariableParameterProvider.RegexEnvironmentVariableInclusionStrategy

Field Summary

Fields

Modifier and Type	Field and Description
private static AllowableValue	COMMA_SEPARATED_STRATEGY
static PropertyDescriptor	ENVIRONMENT_VARIABLE_INCLUSION_STRATEGY
private Map<String,String>	environmentVariables
private static AllowableValue	INCLUDE_ALL_STRATEGY
static PropertyDescriptor	INCLUDE_ENVIRONMENT_VARIABLES
static PropertyDescriptor	PARAMETER_GROUP_NAME
private List<PropertyDescriptor>	properties
private static AllowableValue	REGEX_STRATEGY

Constructor Summary

Constructors

Constructor and Description
EnvironmentVariableParameterProvider()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
List<ParameterGroup>	fetchParameters(ConfigurationContext context)
private EnvironmentVariableParameterProvider.EnvironmentVariableInclusionStrategy	getStrategy(ConfigurationContext context)
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ParameterProviderInitializationContext config)
List<ConfigVerificationResult>	verify(ConfigurationContext context, ComponentLog verificationLogger)

Methods inherited from class org.apache.nifi.parameter.AbstractParameterProvider

getIdentifier, getLogger, getName, getNodeTypeProvider, initialize

Methods inherited from class org.apache.nifi.components.AbstractConfigurableComponent

equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, 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

Field Detail

environmentVariables

private final Map<String,String> environmentVariables

INCLUDE_ALL_STRATEGY

private static final AllowableValue INCLUDE_ALL_STRATEGY

COMMA_SEPARATED_STRATEGY

private static final AllowableValue COMMA_SEPARATED_STRATEGY

REGEX_STRATEGY

private static final AllowableValue REGEX_STRATEGY

ENVIRONMENT_VARIABLE_INCLUSION_STRATEGY

public static final PropertyDescriptor ENVIRONMENT_VARIABLE_INCLUSION_STRATEGY

INCLUDE_ENVIRONMENT_VARIABLES

public static final PropertyDescriptor INCLUDE_ENVIRONMENT_VARIABLES

PARAMETER_GROUP_NAME

public static final PropertyDescriptor PARAMETER_GROUP_NAME

properties

private List<PropertyDescriptor> properties

Constructor Detail

EnvironmentVariableParameterProvider

public EnvironmentVariableParameterProvider()

Method Detail

init

protected void init(ParameterProviderInitializationContext config)

Overrides:

init in class AbstractParameterProvider

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

fetchParameters

public List<ParameterGroup> fetchParameters(ConfigurationContext context)

Specified by:

fetchParameters in interface ParameterProvider

verify

public List<ConfigVerificationResult> verify(ConfigurationContext context,
                                             ComponentLog verificationLogger)

Specified by:

verify in interface VerifiableParameterProvider

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

getStrategy

private EnvironmentVariableParameterProvider.EnvironmentVariableInclusionStrategy getStrategy(ConfigurationContext context)