org.apache.nifi.processors.standard.util

Class SFTPTransfer

java.lang.Object

org.apache.nifi.processors.standard.util.SFTPTransfer

All Implemented Interfaces:

Closeable, AutoCloseable, FileTransfer

public class SFTPTransfer
extends Object
implements FileTransfer

Field Summary

Fields

Modifier and Type	Field and Description
private String	activeHostname
private String	activePassword
private String	activePort
private String	activePrivateKeyPassphrase
private String	activePrivateKeyPath
private String	activeUsername
static PropertyDescriptor	CIPHERS_ALLOWED
private boolean	closed
private PropertyContext	ctx
private static Set<String>	DEFAULT_CIPHER_NAMES
private static Set<String>	DEFAULT_KEY_ALGORITHM_NAMES
private static Set<String>	DEFAULT_KEY_EXCHANGE_ALGORITHM_NAMES
private static Set<String>	DEFAULT_MESSAGE_AUTHENTICATION_CODE_NAMES
static PropertyDescriptor	DISABLE_DIRECTORY_LISTING Property which is used to decide if the ensureDirectoryExists(FlowFile, File) method should perform a SFTPClient.ls(String) before calling SFTPClient.mkdir(String).
private boolean	disableDirectoryListing
private static String	DOT_PREFIX
private String	homeDir
static PropertyDescriptor	HOST_KEY_FILE
static PropertyDescriptor	KEY_ALGORITHMS_ALLOWED
static PropertyDescriptor	KEY_EXCHANGE_ALGORITHMS_ALLOWED
private ComponentLog	logger
static PropertyDescriptor	MESSAGE_AUTHENTICATION_CODES_ALLOWED
static PropertyDescriptor	PORT
static PropertyDescriptor	PRIVATE_KEY_PASSPHRASE
static PropertyDescriptor	PRIVATE_KEY_PATH
static PropertyDescriptor	PROXY_CONFIGURATION_SERVICE
private static ProxySpec[]	PROXY_SPECS
private static String	RELATIVE_CURRENT_DIRECTORY
private static String	RELATIVE_PARENT_DIRECTORY
private net.schmizz.sshj.sftp.SFTPClient	sftpClient
private static SSHClientProvider	SSH_CLIENT_PROVIDER
private net.schmizz.sshj.SSHClient	sshClient
static PropertyDescriptor	STRICT_HOST_KEY_CHECKING
static PropertyDescriptor	USE_KEEPALIVE_ON_TIMEOUT

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
SFTPTransfer(PropertyContext propertyContext, ComponentLog logger)

Method Summary

Modifier and Type	Method and Description
private void	appendPermission(StringBuilder builder, Set<net.schmizz.sshj.xfer.FilePermission> permissions, net.schmizz.sshj.xfer.FilePermission filePermission, String permString)
void	close()
private static String	convertFactorySetToString(Set<String> factorySetNames) Converts a set of names into an alphabetically ordered comma separated value list.
void	deleteDirectory(FlowFile flowFile, String remoteDirectoryName)
void	deleteFile(FlowFile flowFile, String path, String remoteFileName)
void	ensureDirectoryExists(FlowFile flowFile, File directoryName)
String	getHomeDirectory(FlowFile flowFile)
List<FileInfo>	getListing(boolean applyFilters)
protected void	getListing(String path, int depth, int maxResults, List<FileInfo> listing, boolean applyFilters)
private String	getMessage(net.schmizz.sshj.sftp.SFTPException e)
String	getProtocolName()
FlowFile	getRemoteFile(String remoteFileName, FlowFile origFlowFile, ProcessSession session)
FileInfo	getRemoteFileInfo(FlowFile flowFile, String path, String filename)
protected net.schmizz.sshj.sftp.SFTPClient	getSFTPClient(FlowFile flowFile)
boolean	isClosed()
private boolean	isIncludedDirectory(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo, boolean recursionEnabled, boolean symlinksEnabled) Include remote resources when recursion is enabled or when symbolic links are enabled and the resource is a directory link
private boolean	isIncludedFile(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo, boolean symlinksEnabled) Include remote resources when regular file found or when symbolic links are enabled and the resource is a link
private boolean	isSymlink(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo)
private FileInfo	newFileInfo(net.schmizz.sshj.sftp.RemoteResourceInfo entry, 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)
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

SSH_CLIENT_PROVIDER

private static final SSHClientProvider SSH_CLIENT_PROVIDER

DOT_PREFIX

private static final String DOT_PREFIX

See Also:

Constant Field Values

RELATIVE_CURRENT_DIRECTORY

private static final String RELATIVE_CURRENT_DIRECTORY

See Also:

Constant Field Values

RELATIVE_PARENT_DIRECTORY

private static final String RELATIVE_PARENT_DIRECTORY

See Also:

Constant Field Values

DEFAULT_KEY_ALGORITHM_NAMES

private static final Set<String> DEFAULT_KEY_ALGORITHM_NAMES

DEFAULT_CIPHER_NAMES

private static final Set<String> DEFAULT_CIPHER_NAMES

DEFAULT_MESSAGE_AUTHENTICATION_CODE_NAMES

private static final Set<String> DEFAULT_MESSAGE_AUTHENTICATION_CODE_NAMES

DEFAULT_KEY_EXCHANGE_ALGORITHM_NAMES

private static final Set<String> DEFAULT_KEY_EXCHANGE_ALGORITHM_NAMES

PRIVATE_KEY_PATH

public static final PropertyDescriptor PRIVATE_KEY_PATH

PRIVATE_KEY_PASSPHRASE

public static final PropertyDescriptor PRIVATE_KEY_PASSPHRASE

HOST_KEY_FILE

public static final PropertyDescriptor HOST_KEY_FILE

STRICT_HOST_KEY_CHECKING

public static final PropertyDescriptor STRICT_HOST_KEY_CHECKING

PORT

public static final PropertyDescriptor PORT

USE_KEEPALIVE_ON_TIMEOUT

public static final PropertyDescriptor USE_KEEPALIVE_ON_TIMEOUT

KEY_ALGORITHMS_ALLOWED

public static final PropertyDescriptor KEY_ALGORITHMS_ALLOWED

CIPHERS_ALLOWED

public static final PropertyDescriptor CIPHERS_ALLOWED

MESSAGE_AUTHENTICATION_CODES_ALLOWED

public static final PropertyDescriptor MESSAGE_AUTHENTICATION_CODES_ALLOWED

KEY_EXCHANGE_ALGORITHMS_ALLOWED

public static final PropertyDescriptor KEY_EXCHANGE_ALGORITHMS_ALLOWED

DISABLE_DIRECTORY_LISTING

public static final PropertyDescriptor DISABLE_DIRECTORY_LISTING

Property which is used to decide if the ensureDirectoryExists(FlowFile, File) method should perform a SFTPClient.ls(String) before calling SFTPClient.mkdir(String). In most cases, the code should call ls before mkdir, but some weird permission setups (chmod 100) on a directory would cause the 'ls' to throw a permission exception.

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 PropertyContext ctx

sshClient

private net.schmizz.sshj.SSHClient sshClient

sftpClient

private net.schmizz.sshj.sftp.SFTPClient sftpClient

closed

private volatile boolean closed

homeDir

private String homeDir

activeHostname

private String activeHostname

activePort

private String activePort

activeUsername

private String activeUsername

activePassword

private String activePassword

activePrivateKeyPath

private String activePrivateKeyPath

activePrivateKeyPassphrase

private String activePrivateKeyPassphrase

disableDirectoryListing

private final boolean disableDirectoryListing

Constructor Detail

SFTPTransfer

public SFTPTransfer(PropertyContext propertyContext,
                    ComponentLog logger)

Method Detail

convertFactorySetToString

private static String convertFactorySetToString(Set<String> factorySetNames)

Converts a set of names into an alphabetically ordered comma separated value list.

Parameters:

factorySetNames - The set of names

Returns:

An alphabetically ordered comma separated value list of names

validateProxySpec

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

getProtocolName

public String getProtocolName()

Specified by:

getProtocolName in interface FileTransfer

getListing

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

Specified by:

getListing in interface FileTransfer

Throws:

IOException

getListing

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

Throws:

IOException

isIncludedFile

private boolean isIncludedFile(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo,
                               boolean symlinksEnabled)

Include remote resources when regular file found or when symbolic links are enabled and the resource is a link

Parameters:

remoteResourceInfo - Remote Resource Information

symlinksEnabled - Follow symbolic links enabled

Returns:

Included file status

isIncludedDirectory

private boolean isIncludedDirectory(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo,
                                    boolean recursionEnabled,
                                    boolean symlinksEnabled)

Include remote resources when recursion is enabled or when symbolic links are enabled and the resource is a directory link

Parameters:

remoteResourceInfo - Remote Resource Information

recursionEnabled - Recursion enabled status

symlinksEnabled - Follow symbolic links enabled

Returns:

Included directory status

isSymlink

private boolean isSymlink(net.schmizz.sshj.sftp.RemoteResourceInfo remoteResourceInfo)

newFileInfo

private FileInfo newFileInfo(net.schmizz.sshj.sftp.RemoteResourceInfo entry,
                             String path)

appendPermission

private void appendPermission(StringBuilder builder,
                              Set<net.schmizz.sshj.xfer.FilePermission> permissions,
                              net.schmizz.sshj.xfer.FilePermission filePermission,
                              String permString)

getRemoteFile

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

Specified by:

getRemoteFile in interface FileTransfer

Throws:

ProcessException

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

ensureDirectoryExists

public void ensureDirectoryExists(FlowFile flowFile,
                                  File directoryName)
                           throws IOException

Specified by:

ensureDirectoryExists in interface FileTransfer

Throws:

IOException

getMessage

private String getMessage(net.schmizz.sshj.sftp.SFTPException e)

getSFTPClient

protected net.schmizz.sshj.sftp.SFTPClient getSFTPClient(FlowFile flowFile)
                                                  throws IOException

Throws:

IOException

getHomeDirectory

public String getHomeDirectory(FlowFile flowFile)
                        throws IOException

Specified by:

getHomeDirectory in interface FileTransfer

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

isClosed

public boolean isClosed()

Specified by:

isClosed in interface FileTransfer

getRemoteFileInfo

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

Specified by:

getRemoteFileInfo in interface FileTransfer

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

numberPermissions

protected int numberPermissions(String perms)