org.apache.nifi.processors.standard

Class GetFile

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.GetFile

All Implemented Interfaces:

ConfigurableComponent, Processor

@TriggerWhenEmpty
 @InputRequirement(value=INPUT_FORBIDDEN)
 @Tags(value={"local","files","filesystem","ingest","ingress","get","source","input"})
 @CapabilityDescription(value="Creates FlowFiles from files in a directory.  NiFi will ignore files it doesn\'t have at least read permissions for.")
 @WritesAttribute(attribute="filename",description="The filename is set to the name of the file on disk") @WritesAttribute(attribute="path",description="The path is set to the relative path of the file\'s directory on disk. For example, if the <Input Directory> property is set to /tmp, files picked up from /tmp will have the path attribute set to ./. If the <Recurse Subdirectories> property is set to true and a file is picked up from /tmp/abc/1/2/3, then the path attribute will be set to abc/1/2/3") @WritesAttribute(attribute="file.creationTime",description="The date and time that the file was created. May not work on all file systems") @WritesAttribute(attribute="file.lastModifiedTime",description="The date and time that the file was last modified. May not work on all file systems") @WritesAttribute(attribute="file.lastAccessTime",description="The date and time that the file was last accessed. May not work on all file systems") @WritesAttribute(attribute="file.owner",description="The owner of the file. May not work on all file systems") @WritesAttribute(attribute="file.group",description="The group owner of the file. May not work on all file systems") @WritesAttribute(attribute="file.permissions",description="The read/write/execute permissions of the file. May not work on all file systems") @WritesAttribute(attribute="absolute.path",description="The full/absolute path from where a file was picked up. The current \'path\' attribute is still populated, but may be a relative path")
 @SeeAlso(value={PutFile.class,FetchFile.class})
 @Restriction(requiredPermission=READ_FILESYSTEM,explanation="Provides operator the ability to read from any file that NiFi has access to.") @Restriction(requiredPermission=WRITE_FILESYSTEM,explanation="Provides operator the ability to delete any file that NiFi has access to.")
public class GetFile
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	BATCH_SIZE
static PropertyDescriptor	DIRECTORY
static String	FILE_CREATION_TIME_ATTRIBUTE
static PropertyDescriptor	FILE_FILTER
static String	FILE_GROUP_ATTRIBUTE
static String	FILE_LAST_ACCESS_TIME_ATTRIBUTE
static String	FILE_LAST_MODIFY_TIME_ATTRIBUTE
static String	FILE_MODIFY_DATE_ATTR_FORMAT
static String	FILE_OWNER_ATTRIBUTE
static String	FILE_PERMISSIONS_ATTRIBUTE
private BlockingQueue<File>	fileQueue
static PropertyDescriptor	IGNORE_HIDDEN_FILES
private Set<File>	inProcess
static PropertyDescriptor	KEEP_SOURCE_FILE
private Lock	listingLock
static PropertyDescriptor	MAX_AGE
static PropertyDescriptor	MAX_SIZE
static PropertyDescriptor	MIN_AGE
static PropertyDescriptor	MIN_SIZE
static PropertyDescriptor	PATH_FILTER
static PropertyDescriptor	POLLING_INTERVAL
private List<PropertyDescriptor>	properties
private AtomicLong	queueLastUpdated
private Lock	queueLock
private Set<File>	recentlyProcessed
static PropertyDescriptor	RECURSE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships

Constructor Summary

Constructors

Constructor and Description
GetFile()

Method Summary

Modifier and Type	Method and Description
private FileFilter	createFileFilter(ProcessContext context, Path inputDirectory)
protected Map<String,String>	getAttributesFromFile(Path file)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onScheduled(ProcessContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
private Set<File>	performListing(File directory, FileFilter filter, boolean recurseSubdirectories)

Methods inherited from class org.apache.nifi.processor.AbstractProcessor

onTrigger

Methods inherited from class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getControllerServiceLookup, getIdentifier, getLogger, getNodeTypeProvider, initialize, isConfigurationRestored, isScheduled, toString, updateConfiguredRestoredTrue, updateScheduledFalse, updateScheduledTrue

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

customValidate, equals, getPropertyDescriptor, getPropertyDescriptors, getSupportedDynamicPropertyDescriptor, hashCode, onPropertyModified, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.nifi.processor.Processor

isStateful

Methods inherited from interface org.apache.nifi.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

Field Detail

DIRECTORY

public static final PropertyDescriptor DIRECTORY

RECURSE

public static final PropertyDescriptor RECURSE

KEEP_SOURCE_FILE

public static final PropertyDescriptor KEEP_SOURCE_FILE

FILE_FILTER

public static final PropertyDescriptor FILE_FILTER

PATH_FILTER

public static final PropertyDescriptor PATH_FILTER

MIN_AGE

public static final PropertyDescriptor MIN_AGE

MAX_AGE

public static final PropertyDescriptor MAX_AGE

MIN_SIZE

public static final PropertyDescriptor MIN_SIZE

MAX_SIZE

public static final PropertyDescriptor MAX_SIZE

IGNORE_HIDDEN_FILES

public static final PropertyDescriptor IGNORE_HIDDEN_FILES

POLLING_INTERVAL

public static final PropertyDescriptor POLLING_INTERVAL

BATCH_SIZE

public static final PropertyDescriptor BATCH_SIZE

FILE_CREATION_TIME_ATTRIBUTE

public static final String FILE_CREATION_TIME_ATTRIBUTE

See Also:

Constant Field Values

FILE_LAST_MODIFY_TIME_ATTRIBUTE

public static final String FILE_LAST_MODIFY_TIME_ATTRIBUTE

See Also:

Constant Field Values

FILE_LAST_ACCESS_TIME_ATTRIBUTE

public static final String FILE_LAST_ACCESS_TIME_ATTRIBUTE

See Also:

Constant Field Values

FILE_OWNER_ATTRIBUTE

public static final String FILE_OWNER_ATTRIBUTE

See Also:

Constant Field Values

FILE_GROUP_ATTRIBUTE

public static final String FILE_GROUP_ATTRIBUTE

See Also:

Constant Field Values

FILE_PERMISSIONS_ATTRIBUTE

public static final String FILE_PERMISSIONS_ATTRIBUTE

See Also:

Constant Field Values

FILE_MODIFY_DATE_ATTR_FORMAT

public static final String FILE_MODIFY_DATE_ATTR_FORMAT

See Also:

Constant Field Values

REL_SUCCESS

public static final Relationship REL_SUCCESS

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

fileQueue

private final BlockingQueue<File> fileQueue

inProcess

private final Set<File> inProcess

recentlyProcessed

private final Set<File> recentlyProcessed

queueLock

private final Lock queueLock

listingLock

private final Lock listingLock

queueLastUpdated

private final AtomicLong queueLastUpdated

Constructor Detail

GetFile

public GetFile()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

onScheduled

@OnScheduled
public void onScheduled(ProcessContext context)

createFileFilter

private FileFilter createFileFilter(ProcessContext context,
                                    Path inputDirectory)

performListing

private Set<File> performListing(File directory,
                                 FileFilter filter,
                                 boolean recurseSubdirectories)

getAttributesFromFile

protected Map<String,String> getAttributesFromFile(Path file)

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)
               throws ProcessException

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException