Package org.apache.nifi.processor.util.file.transfer

Interface FileTransfer

All Superinterfaces:

AutoCloseable, Closeable

public interface FileTransfer
extends Closeable

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyDescriptor	BATCH_SIZE
static final PropertyDescriptor	CONFLICT_RESOLUTION
static final AllowableValue[]	CONFLICT_RESOLUTION_ALLOWABLE_VALUES
static final String	CONFLICT_RESOLUTION_FAIL
static final AllowableValue	CONFLICT_RESOLUTION_FAIL_ALLOWABLE
static final String	CONFLICT_RESOLUTION_IGNORE
static final AllowableValue	CONFLICT_RESOLUTION_IGNORE_ALLOWABLE
static final String	CONFLICT_RESOLUTION_NONE
static final AllowableValue	CONFLICT_RESOLUTION_NONE_ALLOWABLE
static final String	CONFLICT_RESOLUTION_REJECT
static final AllowableValue	CONFLICT_RESOLUTION_REJECT_ALLOWABLE
static final String	CONFLICT_RESOLUTION_RENAME
static final AllowableValue	CONFLICT_RESOLUTION_RENAME_ALLOWABLE
static final String	CONFLICT_RESOLUTION_REPLACE
static final AllowableValue	CONFLICT_RESOLUTION_REPLACE_ALLOWABLE
static final PropertyDescriptor	CONNECTION_TIMEOUT
static final PropertyDescriptor	CREATE_DIRECTORY
static final PropertyDescriptor	DATA_TIMEOUT
static final PropertyDescriptor	DELETE_ORIGINAL
static final PropertyDescriptor	DOT_RENAME
static final PropertyDescriptor	FILE_FILTER_REGEX
static final String	FILE_MODIFY_DATE_ATTR_FORMAT
static final PropertyDescriptor	FOLLOW_SYMLINK
static final PropertyDescriptor	HOSTNAME
static final PropertyDescriptor	IGNORE_DOTTED_FILES
static final PropertyDescriptor	LAST_MODIFIED_TIME
static final PropertyDescriptor	MAX_SELECTS
static final PropertyDescriptor	PASSWORD
static final PropertyDescriptor	PATH_FILTER_REGEX
static final PropertyDescriptor	PERMISSIONS
static final PropertyDescriptor	POLLING_INTERVAL
static final PropertyDescriptor	RECURSIVE_SEARCH
static final PropertyDescriptor	REJECT_ZERO_BYTE
static final PropertyDescriptor	REMOTE_GROUP
static final PropertyDescriptor	REMOTE_OWNER
static final PropertyDescriptor	REMOTE_PATH
static final PropertyDescriptor	REMOTE_POLL_BATCH_SIZE
static final PropertyDescriptor	TEMP_FILENAME
static final PropertyDescriptor	USE_COMPRESSION
static final PropertyDescriptor	USE_NATURAL_ORDERING
static final PropertyDescriptor	USERNAME

Method Summary

Modifier and Type	Method	Description
void	deleteDirectory(FlowFile flowFile, String remoteDirectoryName)
void	deleteFile(FlowFile flowFile, String path, String remoteFileName)
void	ensureDirectoryExists(FlowFile flowFile, File remoteDirectory)
default String	getAbsolutePath(FlowFile flowFile, String remotePath)	Compute an absolute file path for the given remote path.
String	getHomeDirectory(FlowFile flowFile)
List<FileInfo>	getListing(boolean applyFilters)
String	getProtocolName()
FlowFile	getRemoteFile(String remoteFileName, FlowFile flowFile, ProcessSession session)
FileInfo	getRemoteFileInfo(FlowFile flowFile, String path, String remoteFileName)
boolean	isClosed()
String	put(FlowFile flowFile, String path, String filename, InputStream content)
void	rename(FlowFile flowFile, String source, String target)

Methods inherited from interface java.io.Closeable

close

Field Details

HOSTNAME

static final PropertyDescriptor HOSTNAME

USERNAME

static final PropertyDescriptor USERNAME

PASSWORD

static final PropertyDescriptor PASSWORD

DATA_TIMEOUT

static final PropertyDescriptor DATA_TIMEOUT

CONNECTION_TIMEOUT

static final PropertyDescriptor CONNECTION_TIMEOUT

REMOTE_PATH

static final PropertyDescriptor REMOTE_PATH

CREATE_DIRECTORY

static final PropertyDescriptor CREATE_DIRECTORY

USE_COMPRESSION

static final PropertyDescriptor USE_COMPRESSION

RECURSIVE_SEARCH

static final PropertyDescriptor RECURSIVE_SEARCH

FOLLOW_SYMLINK

static final PropertyDescriptor FOLLOW_SYMLINK

FILE_FILTER_REGEX

static final PropertyDescriptor FILE_FILTER_REGEX

PATH_FILTER_REGEX

static final PropertyDescriptor PATH_FILTER_REGEX

MAX_SELECTS

static final PropertyDescriptor MAX_SELECTS

REMOTE_POLL_BATCH_SIZE

static final PropertyDescriptor REMOTE_POLL_BATCH_SIZE

DELETE_ORIGINAL

static final PropertyDescriptor DELETE_ORIGINAL

POLLING_INTERVAL

static final PropertyDescriptor POLLING_INTERVAL

IGNORE_DOTTED_FILES

static final PropertyDescriptor IGNORE_DOTTED_FILES

USE_NATURAL_ORDERING

static final PropertyDescriptor USE_NATURAL_ORDERING

FILE_MODIFY_DATE_ATTR_FORMAT

static final String FILE_MODIFY_DATE_ATTR_FORMAT

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_REPLACE

static final String CONFLICT_RESOLUTION_REPLACE

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_REPLACE_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_REPLACE_ALLOWABLE

CONFLICT_RESOLUTION_RENAME

static final String CONFLICT_RESOLUTION_RENAME

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_RENAME_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_RENAME_ALLOWABLE

CONFLICT_RESOLUTION_IGNORE

static final String CONFLICT_RESOLUTION_IGNORE

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_IGNORE_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_IGNORE_ALLOWABLE

CONFLICT_RESOLUTION_REJECT

static final String CONFLICT_RESOLUTION_REJECT

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_REJECT_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_REJECT_ALLOWABLE

CONFLICT_RESOLUTION_FAIL

static final String CONFLICT_RESOLUTION_FAIL

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_FAIL_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_FAIL_ALLOWABLE

CONFLICT_RESOLUTION_NONE

static final String CONFLICT_RESOLUTION_NONE

See Also:

• Constant Field Values

CONFLICT_RESOLUTION_NONE_ALLOWABLE

static final AllowableValue CONFLICT_RESOLUTION_NONE_ALLOWABLE

CONFLICT_RESOLUTION_ALLOWABLE_VALUES

static final AllowableValue[] CONFLICT_RESOLUTION_ALLOWABLE_VALUES

CONFLICT_RESOLUTION

static final PropertyDescriptor CONFLICT_RESOLUTION

REJECT_ZERO_BYTE

static final PropertyDescriptor REJECT_ZERO_BYTE

DOT_RENAME

static final PropertyDescriptor DOT_RENAME

TEMP_FILENAME

static final PropertyDescriptor TEMP_FILENAME

LAST_MODIFIED_TIME

static final PropertyDescriptor LAST_MODIFIED_TIME

PERMISSIONS

static final PropertyDescriptor PERMISSIONS

REMOTE_OWNER

static final PropertyDescriptor REMOTE_OWNER

REMOTE_GROUP

static final PropertyDescriptor REMOTE_GROUP

BATCH_SIZE

static final PropertyDescriptor BATCH_SIZE

Method Details

getHomeDirectory

String getHomeDirectory(FlowFile flowFile)
                 throws IOException

Throws:

IOException

getListing

List<FileInfo> getListing(boolean applyFilters)
                   throws IOException

Throws:

IOException

getRemoteFile

FlowFile getRemoteFile(String remoteFileName,
 FlowFile flowFile,
 ProcessSession session)
                throws ProcessException,
IOException

Throws:

ProcessException

IOException

getRemoteFileInfo

FileInfo getRemoteFileInfo(FlowFile flowFile,
 String path,
 String remoteFileName)
                    throws IOException

Throws:

IOException

put

String put(FlowFile flowFile,
 String path,
 String filename,
 InputStream content)
    throws IOException

Throws:

IOException

rename

void rename(FlowFile flowFile,
 String source,
 String target)
     throws IOException

Throws:

IOException

deleteFile

void deleteFile(FlowFile flowFile,
 String path,
 String remoteFileName)
         throws IOException

Throws:

IOException

deleteDirectory

void deleteDirectory(FlowFile flowFile,
 String remoteDirectoryName)
              throws IOException

Throws:

IOException

isClosed

boolean isClosed()

getProtocolName

String getProtocolName()

ensureDirectoryExists

void ensureDirectoryExists(FlowFile flowFile,
 File remoteDirectory)
                    throws IOException

Throws:

IOException

getAbsolutePath

default String getAbsolutePath(FlowFile flowFile,
 String remotePath)
                        throws IOException

Compute an absolute file path for the given remote path.

Parameters:

flowFile - is used to setup file transfer client with its attribute values, to get user home directory

remotePath - the target remote path

Returns:

The absolute path for the given remote path

Throws:

IOException