Package 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:

org.apache.nifi.components.ConfigurableComponent, org.apache.nifi.processor.Processor

@SupportsBatching
@InputRequirement(INPUT_REQUIRED)
@Tags({"put","local","copy","archive","files","filesystem"})
@CapabilityDescription("Writes the contents of a FlowFile to the local file system")
@SeeAlso({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 org.apache.nifi.processor.AbstractProcessor

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	CHANGE_GROUP
static final org.apache.nifi.components.PropertyDescriptor	CHANGE_LAST_MODIFIED_TIME
static final org.apache.nifi.components.PropertyDescriptor	CHANGE_OWNER
static final org.apache.nifi.components.PropertyDescriptor	CHANGE_PERMISSIONS
static final org.apache.nifi.components.PropertyDescriptor	CONFLICT_RESOLUTION
static final org.apache.nifi.components.PropertyDescriptor	CREATE_DIRS
private static final DateTimeFormatter	DATE_TIME_FORMATTER
static final org.apache.nifi.components.PropertyDescriptor	DIRECTORY
static final String	FAIL_RESOLUTION
static final String	FILE_MODIFY_DATE_ATTR_FORMAT
static final String	FILE_MODIFY_DATE_ATTRIBUTE
static final String	IGNORE_RESOLUTION
static final org.apache.nifi.components.PropertyDescriptor	MAX_DESTINATION_FILES
static final int	MAX_FILE_LOCK_ATTEMPTS
static final Pattern	NUM_PATTERN
private static final org.apache.nifi.components.Validator	PERMISSIONS_VALIDATOR
private static final List<org.apache.nifi.components.PropertyDescriptor>	PROPERTY_DESCRIPTORS
static final org.apache.nifi.processor.Relationship	REL_FAILURE
static final org.apache.nifi.processor.Relationship	REL_SUCCESS
private static final Set<org.apache.nifi.processor.Relationship>	RELATIONSHIPS
static final String	REPLACE_RESOLUTION
static final Pattern	RWX_PATTERN

Constructor Summary

Constructors

Constructor	Description
PutFile()

Method Summary

Modifier and Type	Method	Description
private long	getFilesNumberInFolder(Path folder, String filename)
Set<org.apache.nifi.processor.Relationship>	getRelationships()
protected List<org.apache.nifi.components.PropertyDescriptor>	getSupportedPropertyDescriptors()
void	onTrigger(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.processor.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, init, 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.components.ConfigurableComponent

getPropertyDescriptor, getPropertyDescriptors, onPropertyModified, validate

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

isStateful, migrateProperties, migrateRelationships

Field Details

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

DATE_TIME_FORMATTER

private static final DateTimeFormatter DATE_TIME_FORMATTER

RWX_PATTERN

public static final Pattern RWX_PATTERN

NUM_PATTERN

public static final Pattern NUM_PATTERN

PERMISSIONS_VALIDATOR

private static final org.apache.nifi.components.Validator PERMISSIONS_VALIDATOR

DIRECTORY

public static final org.apache.nifi.components.PropertyDescriptor DIRECTORY

MAX_DESTINATION_FILES

public static final org.apache.nifi.components.PropertyDescriptor MAX_DESTINATION_FILES

CONFLICT_RESOLUTION

public static final org.apache.nifi.components.PropertyDescriptor CONFLICT_RESOLUTION

CHANGE_LAST_MODIFIED_TIME

public static final org.apache.nifi.components.PropertyDescriptor CHANGE_LAST_MODIFIED_TIME

CHANGE_PERMISSIONS

public static final org.apache.nifi.components.PropertyDescriptor CHANGE_PERMISSIONS

CHANGE_OWNER

public static final org.apache.nifi.components.PropertyDescriptor CHANGE_OWNER

CHANGE_GROUP

public static final org.apache.nifi.components.PropertyDescriptor CHANGE_GROUP

CREATE_DIRS

public static final org.apache.nifi.components.PropertyDescriptor CREATE_DIRS

PROPERTY_DESCRIPTORS

private static final List<org.apache.nifi.components.PropertyDescriptor> PROPERTY_DESCRIPTORS

MAX_FILE_LOCK_ATTEMPTS

public static final int MAX_FILE_LOCK_ATTEMPTS

See Also:

• Constant Field Values

REL_SUCCESS

public static final org.apache.nifi.processor.Relationship REL_SUCCESS

REL_FAILURE

public static final org.apache.nifi.processor.Relationship REL_FAILURE

RELATIONSHIPS

private static final Set<org.apache.nifi.processor.Relationship> RELATIONSHIPS

Constructor Details

PutFile

public PutFile()

Method Details

getRelationships

public Set<org.apache.nifi.processor.Relationship> getRelationships()

Specified by:

getRelationships in interface org.apache.nifi.processor.Processor

Overrides:

getRelationships in class org.apache.nifi.processor.AbstractSessionFactoryProcessor

getSupportedPropertyDescriptors

protected List<org.apache.nifi.components.PropertyDescriptor> getSupportedPropertyDescriptors()

Overrides:

getSupportedPropertyDescriptors in class org.apache.nifi.components.AbstractConfigurableComponent

onTrigger

public void onTrigger(org.apache.nifi.processor.ProcessContext context,
 org.apache.nifi.processor.ProcessSession session)

Specified by:

onTrigger in class org.apache.nifi.processor.AbstractProcessor

getFilesNumberInFolder

private long getFilesNumberInFolder(Path folder,
 String filename)

stringPermissions

protected String stringPermissions(String perms,
 boolean directory)