org.apache.nifi.processors.standard

Class PutFile

java.lang.Object

org.apache.nifi.components.AbstractConfigurableComponent

org.apache.nifi.processor.AbstractSessionFactoryProcessor

org.apache.nifi.processor.AbstractProcessor

org.apache.nifi.processors.standard.PutFile

All Implemented Interfaces:

ConfigurableComponent, Processor

@EventDriven
 @SupportsBatching
 @InputRequirement(value=INPUT_REQUIRED)
 @Tags(value={"put","local","copy","archive","files","filesystem"})
 @CapabilityDescription(value="Writes the contents of a FlowFile to the local file system")
 @SeeAlso(value={FetchFile.class,GetFile.class})
 @ReadsAttribute(attribute="filename",
                description="The filename to use when writing the FlowFile to disk.")
 @Restricted(restrictions=@Restriction(requiredPermission=WRITE_FILESYSTEM,explanation="Provides operator the ability to write to any file that NiFi has access to."))
public class PutFile
extends AbstractProcessor

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyDescriptor	CHANGE_GROUP
static PropertyDescriptor	CHANGE_LAST_MODIFIED_TIME
static PropertyDescriptor	CHANGE_OWNER
static PropertyDescriptor	CHANGE_PERMISSIONS
static PropertyDescriptor	CONFLICT_RESOLUTION
static PropertyDescriptor	CREATE_DIRS
static PropertyDescriptor	DIRECTORY
static String	FAIL_RESOLUTION
static String	FILE_MODIFY_DATE_ATTR_FORMAT
static String	FILE_MODIFY_DATE_ATTRIBUTE
static String	IGNORE_RESOLUTION
static PropertyDescriptor	MAX_DESTINATION_FILES
static int	MAX_FILE_LOCK_ATTEMPTS
static Pattern	NUM_PATTERN
private static Validator	PERMISSIONS_VALIDATOR
private List<PropertyDescriptor>	properties
static Relationship	REL_FAILURE
static Relationship	REL_SUCCESS
private Set<Relationship>	relationships
static String	REPLACE_RESOLUTION
static Pattern	RWX_PATTERN

Constructor Summary

Constructors

Constructor and Description
PutFile()

Method Summary

Modifier and Type	Method and Description
private long	getFilesNumberInFolder(Path folder, String filename)
Set<Relationship>	getRelationships()
protected List<PropertyDescriptor>	getSupportedPropertyDescriptors()
protected void	init(ProcessorInitializationContext context)
void	onTrigger(ProcessContext context, ProcessSession session)
protected String	stringPermissions(String perms, boolean directory)

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

REPLACE_RESOLUTION

public static final String REPLACE_RESOLUTION

See Also:

Constant Field Values

IGNORE_RESOLUTION

public static final String IGNORE_RESOLUTION

See Also:

Constant Field Values

FAIL_RESOLUTION

public static final String FAIL_RESOLUTION

See Also:

Constant Field Values

FILE_MODIFY_DATE_ATTRIBUTE

public static final String FILE_MODIFY_DATE_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

RWX_PATTERN

public static final Pattern RWX_PATTERN

NUM_PATTERN

public static final Pattern NUM_PATTERN

PERMISSIONS_VALIDATOR

private static final Validator PERMISSIONS_VALIDATOR

DIRECTORY

public static final PropertyDescriptor DIRECTORY

MAX_DESTINATION_FILES

public static final PropertyDescriptor MAX_DESTINATION_FILES

CONFLICT_RESOLUTION

public static final PropertyDescriptor CONFLICT_RESOLUTION

CHANGE_LAST_MODIFIED_TIME

public static final PropertyDescriptor CHANGE_LAST_MODIFIED_TIME

CHANGE_PERMISSIONS

public static final PropertyDescriptor CHANGE_PERMISSIONS

CHANGE_OWNER

public static final PropertyDescriptor CHANGE_OWNER

CHANGE_GROUP

public static final PropertyDescriptor CHANGE_GROUP

CREATE_DIRS

public static final PropertyDescriptor CREATE_DIRS

MAX_FILE_LOCK_ATTEMPTS

public static final int MAX_FILE_LOCK_ATTEMPTS

See Also:

Constant Field Values

REL_SUCCESS

public static final Relationship REL_SUCCESS

REL_FAILURE

public static final Relationship REL_FAILURE

properties

private List<PropertyDescriptor> properties

relationships

private Set<Relationship> relationships

Constructor Detail

PutFile

public PutFile()

Method Detail

init

protected void init(ProcessorInitializationContext context)

Overrides:

init in class AbstractSessionFactoryProcessor

getRelationships

public Set<Relationship> getRelationships()

Specified by:

getRelationships in interface Processor

Overrides:

getRelationships in class AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class AbstractConfigurableComponent

onTrigger

public void onTrigger(ProcessContext context,
                      ProcessSession session)

Specified by:

onTrigger in class AbstractProcessor

getFilesNumberInFolder

private long getFilesNumberInFolder(Path folder,
                                    String filename)

stringPermissions

protected String stringPermissions(String perms,
                                   boolean directory)