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 and Description
static PropertyDescriptor	BUFFER_SIZE
private org.apache.commons.net.ftp.FTPClient	client
private boolean	closed
static PropertyDescriptor	CONNECTION_MODE
static String	CONNECTION_MODE_ACTIVE
static String	CONNECTION_MODE_PASSIVE
private ProcessContext	ctx
private static FTPClientProvider	FTP_CLIENT_PROVIDER
static String	FTP_TIMEVAL_FORMAT
private String	homeDirectory
static PropertyDescriptor	HTTP_PROXY_PASSWORD
static PropertyDescriptor	HTTP_PROXY_USERNAME
private ComponentLog	logger
private static Pattern	NOT_FOUND_MESSAGE_PATTERN
static PropertyDescriptor	PORT
static PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
static PropertyDescriptor	PROXY_HOST
static PropertyDescriptor	PROXY_PORT
private static ProxySpec[]	PROXY_SPECS
static PropertyDescriptor	PROXY_TYPE
static String	PROXY_TYPE_DIRECT
static String	PROXY_TYPE_HTTP
static String	PROXY_TYPE_SOCKS
private String	remoteHostName
private String	remotePassword
private String	remotePort
private String	remoteUsername
private static int	REPLY_CODE_FILE_UNAVAILABLE
static PropertyDescriptor	TRANSFER_MODE
static String	TRANSFER_MODE_ASCII
static String	TRANSFER_MODE_BINARY
static PropertyDescriptor	UTF8_ENCODING

Fields inherited from interface org.apache.nifi.processors.standard.util.FileTransfer

BATCH_SIZE, CONFLICT_RESOLUTION, CONFLICT_RESOLUTION_FAIL, CONFLICT_RESOLUTION_IGNORE, CONFLICT_RESOLUTION_NONE, CONFLICT_RESOLUTION_REJECT, CONFLICT_RESOLUTION_RENAME, CONFLICT_RESOLUTION_REPLACE, 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 and Description
FTPTransfer(ProcessContext context, ComponentLog logger)

Method Summary

Modifier and Type	Method and Description
void	close()
protected org.apache.commons.net.ftp.FTPClient	createClient(PropertyContext context, Map<String,String> attributes)
static Supplier<ProxyConfiguration>	createComponentProxyConfigSupplier(PropertyContext ctx)
void	deleteDirectory(FlowFile flowFile, String remoteDirectoryName)
void	deleteFile(FlowFile flowFile, String path, String remoteFileName)
void	ensureDirectoryExists(FlowFile flowFile, File directoryName)
private org.apache.commons.net.ftp.FTPClient	getClient(FlowFile flowFile)
String	getHomeDirectory(FlowFile flowFile)
List<FileInfo>	getListing(boolean applyFilters)
private List<FileInfo>	getListing(String path, int depth, int maxResults, boolean applyFilters)
String	getProtocolName()
FlowFile	getRemoteFile(String remoteFileName, FlowFile origFlowFile, ProcessSession session)
FileInfo	getRemoteFileInfo(FlowFile flowFile, String path, String remoteFileName)
boolean	isClosed()
private FileInfo	newFileInfo(org.apache.commons.net.ftp.FTPFile file, String path)
protected int	numberPermissions(String perms)
String	put(FlowFile flowFile, String path, String filename, InputStream content)
void	rename(FlowFile flowFile, String source, String target)
private boolean	resetWorkingDirectory()
void	sendCommands(List<String> commands, FlowFile flowFile)
private String	setAndGetWorkingDirectory(String path)
private boolean	setWorkingDirectory(String path)
static void	validateProxySpec(ValidationContext context, Collection<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.processors.standard.util.FileTransfer

getAbsolutePath

Field Detail

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

PROXY_TYPE_DIRECT

public static final String PROXY_TYPE_DIRECT

PROXY_TYPE_HTTP

public static final String PROXY_TYPE_HTTP

PROXY_TYPE_SOCKS

public static final String PROXY_TYPE_SOCKS

CONNECTION_MODE

public static final PropertyDescriptor CONNECTION_MODE

TRANSFER_MODE

public static final PropertyDescriptor TRANSFER_MODE

PORT

public static final PropertyDescriptor PORT

PROXY_TYPE

public static final PropertyDescriptor PROXY_TYPE

PROXY_HOST

public static final PropertyDescriptor PROXY_HOST

PROXY_PORT

public static final PropertyDescriptor PROXY_PORT

HTTP_PROXY_USERNAME

public static final PropertyDescriptor HTTP_PROXY_USERNAME

HTTP_PROXY_PASSWORD

public static final PropertyDescriptor HTTP_PROXY_PASSWORD

BUFFER_SIZE

public static final PropertyDescriptor BUFFER_SIZE

UTF8_ENCODING

public static final 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 PropertyDescriptor PROXY_CONFIGURATION_SERVICE

logger

private final ComponentLog logger

ctx

private final 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 Detail

FTPTransfer

public FTPTransfer(ProcessContext context,
                   ComponentLog logger)

Method Detail

validateProxySpec

public static void validateProxySpec(ValidationContext context,
                                     Collection<ValidationResult> results)

getProtocolName

public String getProtocolName()

Specified by:

getProtocolName in interface FileTransfer

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

getHomeDirectory

public String getHomeDirectory(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 FlowFile getRemoteFile(String remoteFileName,
                              FlowFile origFlowFile,
                              ProcessSession session)
                       throws ProcessException,
                              IOException

Specified by:

getRemoteFile in interface FileTransfer

Throws:

ProcessException

IOException

getRemoteFileInfo

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

Specified by:

getRemoteFileInfo in interface FileTransfer

Throws:

IOException

ensureDirectoryExists

public void ensureDirectoryExists(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(FlowFile flowFile,
                  String path,
                  String filename,
                  InputStream content)
           throws IOException

Specified by:

put in interface FileTransfer

Throws:

IOException

rename

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

Specified by:

rename in interface FileTransfer

Throws:

IOException

deleteFile

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

Specified by:

deleteFile in interface FileTransfer

Throws:

IOException

deleteDirectory

public void deleteDirectory(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,
                         FlowFile flowFile)
                  throws IOException

Throws:

IOException

createClient

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

getClient

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

Throws:

IOException

numberPermissions

protected int numberPermissions(String perms)

createComponentProxyConfigSupplier

public static Supplier<ProxyConfiguration> createComponentProxyConfigSupplier(PropertyContext ctx)