org.apache.nifi.processors.standard

Class FetchFile

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.FetchFile

All Implemented Interfaces:

ConfigurableComponent, Processor

@InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"local","files","filesystem","ingest","ingress","get","source","input","fetch"})
 @CapabilityDescription(value="Reads the contents of a file from disk and streams it into the contents of an incoming FlowFile. Once this is done, the file is optionally moved elsewhere or deleted to help keep the file system organized.")
 @SeeAlso(value={GetFile.class,PutFile.class,ListFile.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 FetchFile
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
(package private) static AllowableValue	COMPLETION_DELETE
(package private) static AllowableValue	COMPLETION_MOVE
(package private) static AllowableValue	COMPLETION_NONE
(package private) static PropertyDescriptor	COMPLETION_STRATEGY
(package private) static AllowableValue	CONFLICT_FAIL
(package private) static AllowableValue	CONFLICT_KEEP_INTACT
(package private) static AllowableValue	CONFLICT_RENAME
(package private) static AllowableValue	CONFLICT_REPLACE
(package private) static PropertyDescriptor	CONFLICT_STRATEGY
(package private) static PropertyDescriptor	FILE_NOT_FOUND_LOG_LEVEL
(package private) static PropertyDescriptor	FILENAME
(package private) static PropertyDescriptor	MOVE_DESTINATION_DIR
(package private) static PropertyDescriptor	PERM_DENIED_LOG_LEVEL
(package private) static Relationship	REL_FAILURE
(package private) static Relationship	REL_NOT_FOUND
(package private) static Relationship	REL_PERMISSION_DENIED
(package private) static Relationship	REL_SUCCESS

Constructor Summary

Constructors

Constructor and Description
FetchFile()

Method Summary

Modifier and Type	Method and Description
protected Collection<ValidationResult>	customValidate(ValidationContext validationContext)
protected void	delete(File file)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected boolean	isDirectory(File file)
protected boolean	isReadable(File file)
protected boolean	isWritable(File file)
protected void	move(File source, File target, boolean overwrite)
void	onTrigger(ProcessContext context, ProcessSession session)
private void	performCompletionAction(String completionStrategy, File file, String targetDirectoryName, FlowFile flowFile, ProcessContext context)

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

onTrigger

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

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

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

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

COMPLETION_NONE

static final AllowableValue COMPLETION_NONE

COMPLETION_MOVE

static final AllowableValue COMPLETION_MOVE

COMPLETION_DELETE

static final AllowableValue COMPLETION_DELETE

CONFLICT_REPLACE

static final AllowableValue CONFLICT_REPLACE

CONFLICT_KEEP_INTACT

static final AllowableValue CONFLICT_KEEP_INTACT

CONFLICT_FAIL

static final AllowableValue CONFLICT_FAIL

CONFLICT_RENAME

static final AllowableValue CONFLICT_RENAME

FILENAME

static final PropertyDescriptor FILENAME

COMPLETION_STRATEGY

static final PropertyDescriptor COMPLETION_STRATEGY

MOVE_DESTINATION_DIR

static final PropertyDescriptor MOVE_DESTINATION_DIR

CONFLICT_STRATEGY

static final PropertyDescriptor CONFLICT_STRATEGY

FILE_NOT_FOUND_LOG_LEVEL

static final PropertyDescriptor FILE_NOT_FOUND_LOG_LEVEL

PERM_DENIED_LOG_LEVEL

static final PropertyDescriptor PERM_DENIED_LOG_LEVEL

REL_SUCCESS

static final Relationship REL_SUCCESS

REL_NOT_FOUND

static final Relationship REL_NOT_FOUND

REL_PERMISSION_DENIED

static final Relationship REL_PERMISSION_DENIED

REL_FAILURE

static final Relationship REL_FAILURE

Constructor Detail

FetchFile

public FetchFile()

Method Detail

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

customValidate

protected Collection<ValidationResult> customValidate(ValidationContext validationContext)

Overrides:

customValidate in class AbstractConfigurableComponent

onTrigger

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

Specified by:

onTrigger in class AbstractProcessor

Throws:

ProcessException

performCompletionAction

private void performCompletionAction(String completionStrategy,
                                     File file,
                                     String targetDirectoryName,
                                     FlowFile flowFile,
                                     ProcessContext context)

move

protected void move(File source,
                    File target,
                    boolean overwrite)
             throws IOException

Throws:

IOException

delete

protected void delete(File file)
               throws IOException

Throws:

IOException

isReadable

protected boolean isReadable(File file)

isWritable

protected boolean isWritable(File file)

isDirectory

protected boolean isDirectory(File file)