Package org.apache.nifi.processors.standard.util

Class FTPTransfer

java.lang.Object

org.apache.nifi.processors.standard.util.FTPTransfer

All Implemented Interfaces:

Closeable, AutoCloseable, FileTransfer

public class FTPTransfer
extends Object
implements FileTransfer

Field Summary

Fields

Modifier and Type	Field	Description
static final org.apache.nifi.components.PropertyDescriptor	BUFFER_SIZE
private org.apache.commons.net.ftp.FTPClient	client
private boolean	closed
static final org.apache.nifi.components.PropertyDescriptor	CONNECTION_MODE
static final String	CONNECTION_MODE_ACTIVE
static final String	CONNECTION_MODE_PASSIVE
private final org.apache.nifi.processor.ProcessContext	ctx
private static final FTPClientProvider	FTP_CLIENT_PROVIDER
static final String	FTP_TIMEVAL_FORMAT
private String	homeDirectory
private final org.apache.nifi.logging.ComponentLog	logger
private static final Pattern	NOT_FOUND_MESSAGE_PATTERN
private static final String	OBSOLETE_PROXY_HOST
private static final String	OBSOLETE_PROXY_PASSWORD
private static final String	OBSOLETE_PROXY_PORT
private static final String	OBSOLETE_PROXY_TYPE
private static final String	OBSOLETE_PROXY_USERNAME
static final org.apache.nifi.components.PropertyDescriptor	PORT
static final org.apache.nifi.components.PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
private static final ProxySpec[]	PROXY_SPECS
private String	remoteHostName
private String	remotePassword
private String	remotePort
private String	remoteUsername
private static final int	REPLY_CODE_FILE_UNAVAILABLE
static final org.apache.nifi.components.PropertyDescriptor	TRANSFER_MODE
static final String	TRANSFER_MODE_ASCII
static final String	TRANSFER_MODE_BINARY
static final org.apache.nifi.components.PropertyDescriptor	UTF8_ENCODING

Fields inherited from interface org.apache.nifi.processor.util.file.transfer.FileTransfer

BATCH_SIZE, CONFLICT_RESOLUTION, CONFLICT_RESOLUTION_ALLOWABLE_VALUES, CONFLICT_RESOLUTION_FAIL, CONFLICT_RESOLUTION_FAIL_ALLOWABLE, CONFLICT_RESOLUTION_IGNORE, CONFLICT_RESOLUTION_IGNORE_ALLOWABLE, CONFLICT_RESOLUTION_NONE, CONFLICT_RESOLUTION_NONE_ALLOWABLE, CONFLICT_RESOLUTION_REJECT, CONFLICT_RESOLUTION_REJECT_ALLOWABLE, CONFLICT_RESOLUTION_RENAME, CONFLICT_RESOLUTION_RENAME_ALLOWABLE, CONFLICT_RESOLUTION_REPLACE, CONFLICT_RESOLUTION_REPLACE_ALLOWABLE, CONNECTION_TIMEOUT, CREATE_DIRECTORY, DATA_TIMEOUT, DELETE_ORIGINAL, DOT_RENAME, FILE_FILTER_REGEX, FILE_MODIFY_DATE_ATTR_FORMAT, FOLLOW_SYMLINK, HOSTNAME, IGNORE_DOTTED_FILES, LAST_MODIFIED_TIME, MAX_SELECTS, PASSWORD, PATH_FILTER_REGEX, PERMISSIONS, POLLING_INTERVAL, RECURSIVE_SEARCH, REJECT_ZERO_BYTE, REMOTE_GROUP, REMOTE_OWNER, REMOTE_PATH, REMOTE_POLL_BATCH_SIZE, TEMP_FILENAME, USE_COMPRESSION, USE_NATURAL_ORDERING, USERNAME

Constructor Summary

Constructors

Constructor	Description
FTPTransfer(org.apache.nifi.processor.ProcessContext context, org.apache.nifi.logging.ComponentLog logger)

Method Summary

Modifier and Type	Method	Description
void	close()
protected org.apache.commons.net.ftp.FTPClient	createClient(org.apache.nifi.context.PropertyContext context, Map<String,String> attributes)
void	deleteDirectory(org.apache.nifi.flowfile.FlowFile flowFile, String remoteDirectoryName)
void	deleteFile(org.apache.nifi.flowfile.FlowFile flowFile, String path, String remoteFileName)
void	ensureDirectoryExists(org.apache.nifi.flowfile.FlowFile flowFile, File directoryName)
private org.apache.commons.net.ftp.FTPClient	getClient(org.apache.nifi.flowfile.FlowFile flowFile)
String	getHomeDirectory(org.apache.nifi.flowfile.FlowFile flowFile)
List<FileInfo>	getListing(boolean applyFilters)
private List<FileInfo>	getListing(String path, int depth, int maxResults, boolean applyFilters)
String	getProtocolName()
org.apache.nifi.flowfile.FlowFile	getRemoteFile(String remoteFileName, org.apache.nifi.flowfile.FlowFile origFlowFile, org.apache.nifi.processor.ProcessSession session)
FileInfo	getRemoteFileInfo(org.apache.nifi.flowfile.FlowFile flowFile, String path, String remoteFileName)
boolean	isClosed()
static void	migrateProxyProperties(PropertyConfiguration config)
private FileInfo	newFileInfo(org.apache.commons.net.ftp.FTPFile file, String path)
protected int	numberPermissions(String perms)
String	put(org.apache.nifi.flowfile.FlowFile flowFile, String path, String filename, InputStream content)
void	rename(org.apache.nifi.flowfile.FlowFile flowFile, String source, String target)
private boolean	resetWorkingDirectory()
void	sendCommands(List<String> commands, org.apache.nifi.flowfile.FlowFile flowFile)
private String	setAndGetWorkingDirectory(String path)
private boolean	setWorkingDirectory(String path)
static void	validateProxySpec(org.apache.nifi.components.ValidationContext context, Collection<org.apache.nifi.components.ValidationResult> results)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.nifi.processor.util.file.transfer.FileTransfer

getAbsolutePath

Field Details

CONNECTION_MODE_ACTIVE

public static final String CONNECTION_MODE_ACTIVE

See Also:

• Constant Field Values

CONNECTION_MODE_PASSIVE

public static final String CONNECTION_MODE_PASSIVE

See Also:

• Constant Field Values

TRANSFER_MODE_ASCII

public static final String TRANSFER_MODE_ASCII

See Also:

• Constant Field Values

TRANSFER_MODE_BINARY

public static final String TRANSFER_MODE_BINARY

See Also:

• Constant Field Values

FTP_TIMEVAL_FORMAT

public static final String FTP_TIMEVAL_FORMAT

See Also:

• Constant Field Values

OBSOLETE_PROXY_TYPE

private static final String OBSOLETE_PROXY_TYPE

See Also:

• Constant Field Values

OBSOLETE_PROXY_HOST

private static final String OBSOLETE_PROXY_HOST

See Also:

• Constant Field Values

OBSOLETE_PROXY_PORT

private static final String OBSOLETE_PROXY_PORT

See Also:

• Constant Field Values

OBSOLETE_PROXY_USERNAME

private static final String OBSOLETE_PROXY_USERNAME

See Also:

• Constant Field Values

OBSOLETE_PROXY_PASSWORD

private static final String OBSOLETE_PROXY_PASSWORD

See Also:

• Constant Field Values

CONNECTION_MODE

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

TRANSFER_MODE

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

PORT

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

BUFFER_SIZE

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

UTF8_ENCODING

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

REPLY_CODE_FILE_UNAVAILABLE

private static final int REPLY_CODE_FILE_UNAVAILABLE

See Also:

• Constant Field Values

NOT_FOUND_MESSAGE_PATTERN

private static final Pattern NOT_FOUND_MESSAGE_PATTERN

FTP_CLIENT_PROVIDER

private static final FTPClientProvider FTP_CLIENT_PROVIDER

PROXY_SPECS

private static final ProxySpec[] PROXY_SPECS

PROXY_CONFIGURATION_SERVICE

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

logger

private final org.apache.nifi.logging.ComponentLog logger

ctx

private final org.apache.nifi.processor.ProcessContext ctx

closed

private boolean closed

client

private org.apache.commons.net.ftp.FTPClient client

homeDirectory

private String homeDirectory

remoteHostName

private String remoteHostName

remotePort

private String remotePort

remoteUsername

private String remoteUsername

remotePassword

private String remotePassword

Constructor Details

FTPTransfer

public FTPTransfer(org.apache.nifi.processor.ProcessContext context,
 org.apache.nifi.logging.ComponentLog logger)

Method Details

validateProxySpec

public static void validateProxySpec(org.apache.nifi.components.ValidationContext context,
 Collection<org.apache.nifi.components.ValidationResult> results)

migrateProxyProperties

public static void migrateProxyProperties(PropertyConfiguration config)

getProtocolName

public String getProtocolName()

Specified by:

getProtocolName in interface FileTransfer

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

getHomeDirectory

public String getHomeDirectory(org.apache.nifi.flowfile.FlowFile flowFile)
                        throws IOException

Specified by:

getHomeDirectory in interface FileTransfer

Throws:

IOException

getListing

public List<FileInfo> getListing(boolean applyFilters)
                          throws IOException

Specified by:

getListing in interface FileTransfer

Throws:

IOException

getListing

private List<FileInfo> getListing(String path,
 int depth,
 int maxResults,
 boolean applyFilters)
                           throws IOException

Throws:

IOException

newFileInfo

private FileInfo newFileInfo(org.apache.commons.net.ftp.FTPFile file,
 String path)

getRemoteFile

public org.apache.nifi.flowfile.FlowFile getRemoteFile(String remoteFileName,
 org.apache.nifi.flowfile.FlowFile origFlowFile,
 org.apache.nifi.processor.ProcessSession session)
                                                throws org.apache.nifi.processor.exception.ProcessException,
IOException

Specified by:

getRemoteFile in interface FileTransfer

Throws:

org.apache.nifi.processor.exception.ProcessException

IOException

getRemoteFileInfo

public FileInfo getRemoteFileInfo(org.apache.nifi.flowfile.FlowFile flowFile,
 String path,
 String remoteFileName)
                           throws IOException

Specified by:

getRemoteFileInfo in interface FileTransfer

Throws:

IOException

ensureDirectoryExists

public void ensureDirectoryExists(org.apache.nifi.flowfile.FlowFile flowFile,
 File directoryName)
                           throws IOException

Specified by:

ensureDirectoryExists in interface FileTransfer

Throws:

IOException

setAndGetWorkingDirectory

private String setAndGetWorkingDirectory(String path)
                                  throws IOException

Throws:

IOException

setWorkingDirectory

private boolean setWorkingDirectory(String path)
                             throws IOException

Throws:

IOException

resetWorkingDirectory

private boolean resetWorkingDirectory()
                               throws IOException

Throws:

IOException

put

public String put(org.apache.nifi.flowfile.FlowFile flowFile,
 String path,
 String filename,
 InputStream content)
           throws IOException

Specified by:

put in interface FileTransfer

Throws:

IOException

rename

public void rename(org.apache.nifi.flowfile.FlowFile flowFile,
 String source,
 String target)
            throws IOException

Specified by:

rename in interface FileTransfer

Throws:

IOException

deleteFile

public void deleteFile(org.apache.nifi.flowfile.FlowFile flowFile,
 String path,
 String remoteFileName)
                throws IOException

Specified by:

deleteFile in interface FileTransfer

Throws:

IOException

deleteDirectory

public void deleteDirectory(org.apache.nifi.flowfile.FlowFile flowFile,
 String remoteDirectoryName)
                     throws IOException

Specified by:

deleteDirectory in interface FileTransfer

Throws:

IOException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface FileTransfer

sendCommands

public void sendCommands(List<String> commands,
 org.apache.nifi.flowfile.FlowFile flowFile)
                  throws IOException

Throws:

IOException

createClient

protected org.apache.commons.net.ftp.FTPClient createClient(org.apache.nifi.context.PropertyContext context,
 Map<String,String> attributes)

getClient

private org.apache.commons.net.ftp.FTPClient getClient(org.apache.nifi.flowfile.FlowFile flowFile)
                                                throws IOException

Throws:

IOException

numberPermissions

protected int numberPermissions(String perms)