org.apache.nifi.parameter

Class FileParameterProvider

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.parameter.AbstractParameterProvider

org.apache.nifi.parameter.FileParameterProvider

All Implemented Interfaces:

ConfigurableComponent, ParameterProvider, VerifiableParameterProvider

@Tags(value="file")
 @CapabilityDescription(value="Fetches parameters from files.  Parameter groups are indicated by a set of directories, and files within the directories map to parameter names. The content of the file becomes the parameter value.")
 @Restricted(restrictions=@Restriction(requiredPermission=READ_FILESYSTEM,explanation="Provides operator the ability to read from any file that NiFi has access to."))
public class FileParameterProvider
extends AbstractParameterProvider
implements VerifiableParameterProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileParameterProvider.MultiDirectoryExistsValidator
private static class	FileParameterProvider.ParameterValueEncoding

Field Summary

Fields

Modifier and Type	Field and Description
private static AllowableValue	BASE64_ENCODING
private static Charset	DEFAULT_CHARSET
private static int	MAX_SIZE_LIMIT
static PropertyDescriptor	PARAMETER_GROUP_DIRECTORIES
static PropertyDescriptor	PARAMETER_VALUE_BYTE_LIMIT
static PropertyDescriptor	PARAMETER_VALUE_ENCODING
private static AllowableValue	PLAIN_TEXT
private List<PropertyDescriptor>	properties

Constructor Summary

Constructors

Constructor and Description
FileParameterProvider()

Method Summary

Modifier and Type	Method and Description
List<ParameterGroup>	fetchParameters(ConfigurationContext context)
private Collection<File>	getDirectories(ConfigurationContext context, PropertyDescriptor descriptor)
private ParameterGroup	getParameterGroup(ConfigurationContext context, File directory, String groupName)
private String	getParameterValue(String rawValue, FileParameterProvider.ParameterValueEncoding encoding)
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

customValidate, 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

MAX_SIZE_LIMIT

private static final int MAX_SIZE_LIMIT

See Also:

Constant Field Values

DEFAULT_CHARSET

private static final Charset DEFAULT_CHARSET

BASE64_ENCODING

private static final AllowableValue BASE64_ENCODING

PLAIN_TEXT

private static final AllowableValue PLAIN_TEXT

PARAMETER_GROUP_DIRECTORIES

public static final PropertyDescriptor PARAMETER_GROUP_DIRECTORIES

PARAMETER_VALUE_BYTE_LIMIT

public static final PropertyDescriptor PARAMETER_VALUE_BYTE_LIMIT

PARAMETER_VALUE_ENCODING

public static final PropertyDescriptor PARAMETER_VALUE_ENCODING

properties

private List<PropertyDescriptor> properties

Constructor Detail

FileParameterProvider

public FileParameterProvider()

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

getParameterValue

private String getParameterValue(String rawValue,
                                 FileParameterProvider.ParameterValueEncoding encoding)

getDirectories

private Collection<File> getDirectories(ConfigurationContext context,
                                        PropertyDescriptor descriptor)

getParameterGroup

private ParameterGroup getParameterGroup(ConfigurationContext context,
                                         File directory,
                                         String groupName)