nl.nn.adapterframework.ftp

Class FtpSession

java.lang.Object

nl.nn.adapterframework.ftp.FtpSession

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, HasKeystore, HasTruststore, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

FtpFileSystem, FtpListener

public class FtpSession
extends Object
implements IConfigurable, HasKeystore, HasTruststore

Helper class for sftp and ftp.

Author:

John Dekker

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FtpSession.FileType
static class	FtpSession.FtpType
static class	FtpSession.Prot

Field Summary

Fields

Modifier and Type	Field and Description
org.apache.commons.net.ftp.FTPClient	ftpClient
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
FtpSession()

Method Summary

Modifier and Type	Method and Description
protected void	checkReply(String cmd)
void	closeClient()
void	configure()
void	deleteRemote(String remoteDirectory, String filename, boolean closeAfterDelete)
String	get(ParameterList params, PipeLineSession session, String localDirectory, String remoteDirectory, String filenames, String localFilenamePattern, boolean closeAfterGet)
boolean	isConsoleKnownHostsVerifier()
List<String>	ls(String remoteDirectory, boolean filesOnly, boolean closeAfterSend)
String	lsAsString(String remoteDirectory, boolean filesOnly, boolean closeAfterSend)
void	openClient(String remoteDirectory)
String	put(ParameterList params, PipeLineSession session, String message, String remoteDirectory, String remoteFilenamePattern, boolean closeAfterSend)
void	setAllowSelfSignedCertificates(boolean b) (ftps) If true, self signed certificates are accepted
void	setAuthAlias(String string) Name of the alias to obtain credentials to authenticatie on remote server
void	setCertificate(String string) Deprecated.
void	setCertificateAuthAlias(String string) Deprecated.
void	setCertificatePassword(String string) Deprecated.
void	setCertificateType(KeystoreType value) Deprecated.
void	setConsoleKnownHostsVerifier(boolean b) (sftp)
void	setFileType(FtpSession.FileType value)
void	setFtpType(FtpSession.FtpType value) FTP protocol to use
void	setFtpTypeDescription(FtpSession.FtpType value) Deprecated.
void	setHost(String string) Name or ip address of remote host
void	setIgnoreCertificateExpiredException(boolean b) (ftps) If true, CertificateExpiredExceptions are ignored
void	setKeyboardInteractive(boolean keyboardInteractive) When true, keyboardinteractive is used to login
void	setKeyManagerAlgorithm(String keyManagerAlgorithm) (ftps) Key manager algorithm.
void	setKeystore(String string) (ftps) Resource url to keystore or certificate to be used for authentication.
void	setKeystoreAlias(String string) (ftps) Alias to obtain specific certificate or key in keystore
void	setKeystoreAliasAuthAlias(String string) (ftps) Authentication alias to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAliasPassword(String string) (ftps) Default password to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAuthAlias(String string) (ftps) Authentication alias used to obtain keystore password
void	setKeystorePassword(String string) (ftps) Default password to access keystore
void	setKeystoreType(KeystoreType value) (ftps) Type of keystore
void	setKnownHostsPath(String string) (sftp) Path to file with knownhosts
void	setMessageIsContent(boolean b) If true, the contents of the message is send, otherwise it message contains the local filenames of the files to be send
void	setName(String name) The functional name of the object.
void	setPassive(boolean b) If true, passive ftp is used: before data is sent, a pasv command is issued, and the connection is set up by the server
void	setPassword(String string) Password to authenticatie on remote server
void	setPort(int i) Port number of remote host
void	setPrefCSEncryption(String string) (sftp) Optional preferred encryption from client to server for sftp protocol
void	setPrefSCEncryption(String string) (sftp) Optional preferred encryption from server to client for sftp protocol
void	setPrivateKeyAuthAlias(String string) (sftp) Name of the alias to obtain credentials for passphrase of private key file
void	setPrivateKeyFilePath(String string) (sftp) Path to private key file for sftp authentication
void	setPrivateKeyPassword(String password) (sftp) Passphrase of private key file
void	setProt(FtpSession.Prot prot) Sets the Data Channel Protection Level.
void	setProtP(boolean b) Deprecated.
void	setProxyAuthAlias(String string) alias to obtain credentials to authenticate on proxy
void	setProxyHost(String string) Proxy hostname
void	setProxyPassword(String string) Default password in case proxy requires authentication
void	setProxyPort(int i) Proxy port
void	setProxyTransportType(int i) (sftp) Transport type in case of sftp (1=standard, 2=http, 3=socks4, 4=socks5)
void	setProxyUsername(String string) Default user name in case proxy requires authentication
void	setTrustManagerAlgorithm(String trustManagerAlgorithm) (ftps) Trust manager algorithm.
void	setTruststore(String string) (ftps) Resource url to truststore to be used for authenticating peer.
void	setTruststoreAuthAlias(String string) (ftps) Authentication alias used to obtain truststore password
void	setTruststorePassword(String string) (ftps) Default password to access truststore
void	setTruststoreType(KeystoreType value) (ftps) Type of truststore
void	setUsername(String string) Name of the user to authenticatie on remote server
void	setVerifyHostname(boolean b) (ftps) If true, the hostname in the certificate will be checked against the actual hostname of the peer

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.encryption.HasKeystore

getKeyManagerAlgorithm, getKeystore, getKeystoreAlias, getKeystoreAliasAuthAlias, getKeystoreAliasPassword, getKeystoreAuthAlias, getKeystorePassword, getKeystoreType

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.encryption.HasTruststore

getTrustManagerAlgorithm, getTruststore, getTruststoreAuthAlias, getTruststorePassword, getTruststoreType, isAllowSelfSignedCertificates, isIgnoreCertificateExpiredException, isVerifyHostname

Field Detail

log

protected org.apache.logging.log4j.Logger log

ftpClient

public org.apache.commons.net.ftp.FTPClient ftpClient

Constructor Detail

FtpSession

public FtpSession()

Method Detail

configure

public void configure()
               throws ConfigurationException

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

openClient

public void openClient(String remoteDirectory)
                throws FtpConnectException

Throws:

FtpConnectException

checkReply

protected void checkReply(String cmd)
                   throws IOException

Throws:

IOException

closeClient

public void closeClient()

put

public String put(ParameterList params,
                  PipeLineSession session,
                  String message,
                  String remoteDirectory,
                  String remoteFilenamePattern,
                  boolean closeAfterSend)
           throws Exception

Throws:

Exception

ls

public List<String> ls(String remoteDirectory,
                       boolean filesOnly,
                       boolean closeAfterSend)
                throws Exception

Throws:

Exception

lsAsString

public String lsAsString(String remoteDirectory,
                         boolean filesOnly,
                         boolean closeAfterSend)
                  throws Exception

Throws:

Exception

get

public String get(ParameterList params,
                  PipeLineSession session,
                  String localDirectory,
                  String remoteDirectory,
                  String filenames,
                  String localFilenamePattern,
                  boolean closeAfterGet)
           throws Exception

Throws:

Exception

deleteRemote

public void deleteRemote(String remoteDirectory,
                         String filename,
                         boolean closeAfterDelete)
                  throws Exception

Throws:

Exception

setHost

public void setHost(String string)

Name or ip address of remote host

setPort

public void setPort(int i)

Port number of remote host

Default value

21

setAuthAlias

public void setAuthAlias(String string)

Name of the alias to obtain credentials to authenticatie on remote server

setUsername

public void setUsername(String string)

Name of the user to authenticatie on remote server

setPassword

public void setPassword(String string)

Password to authenticatie on remote server

setProxyHost

public void setProxyHost(String string)

Proxy hostname

setProxyPort

public void setProxyPort(int i)

Proxy port

Default value

1080

setProxyAuthAlias

public void setProxyAuthAlias(String string)

alias to obtain credentials to authenticate on proxy

setProxyUsername

public void setProxyUsername(String string)

Default user name in case proxy requires authentication

setProxyPassword

public void setProxyPassword(String string)

Default password in case proxy requires authentication

setFtpTypeDescription

@Deprecated
 @ConfigurationWarning(value="use attribute ftpType instead")
public void setFtpTypeDescription(FtpSession.FtpType value)

Deprecated.

setFtpType

public void setFtpType(FtpSession.FtpType value)

FTP protocol to use

Default value

FTP

setFileType

public void setFileType(FtpSession.FileType value)

setMessageIsContent

public void setMessageIsContent(boolean b)

If true, the contents of the message is send, otherwise it message contains the local filenames of the files to be send

Default value

false

setPassive

public void setPassive(boolean b)

If true, passive ftp is used: before data is sent, a pasv command is issued, and the connection is set up by the server

Default value

true

setProxyTransportType

public void setProxyTransportType(int i)

(sftp) Transport type in case of sftp (1=standard, 2=http, 3=socks4, 4=socks5)

Default value

4

setPrefCSEncryption

public void setPrefCSEncryption(String string)

(sftp) Optional preferred encryption from client to server for sftp protocol

setPrefSCEncryption

public void setPrefSCEncryption(String string)

(sftp) Optional preferred encryption from server to client for sftp protocol

setPrivateKeyFilePath

public void setPrivateKeyFilePath(String string)

(sftp) Path to private key file for sftp authentication

setPrivateKeyAuthAlias

public void setPrivateKeyAuthAlias(String string)

(sftp) Name of the alias to obtain credentials for passphrase of private key file

setPrivateKeyPassword

public void setPrivateKeyPassword(String password)

(sftp) Passphrase of private key file

setKnownHostsPath

public void setKnownHostsPath(String string)

(sftp) Path to file with knownhosts

setConsoleKnownHostsVerifier

public void setConsoleKnownHostsVerifier(boolean b)

(sftp)

Default value

false

isConsoleKnownHostsVerifier

public boolean isConsoleKnownHostsVerifier()

setCertificate

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystore instead")
public void setCertificate(String string)

Deprecated.

setCertificateType

@Deprecated
 @ConfigurationWarning(value="has been replaced with keystoreType")
public void setCertificateType(KeystoreType value)

Deprecated.

setCertificateAuthAlias

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystoreAuthAlias instead")
public void setCertificateAuthAlias(String string)

Deprecated.

setCertificatePassword

@Deprecated
 @ConfigurationWarning(value="Please use attribute keystorePassword instead")
public void setCertificatePassword(String string)

Deprecated.

setKeystore

public void setKeystore(String string)

(ftps) Resource url to keystore or certificate to be used for authentication. If none specified, the JVMs default keystore will be used.

Specified by:

setKeystore in interface HasKeystore

setKeystoreType

public void setKeystoreType(KeystoreType value)

(ftps) Type of keystore

Specified by:

setKeystoreType in interface HasKeystore

Default value

pkcs12

setKeystoreAuthAlias

public void setKeystoreAuthAlias(String string)

(ftps) Authentication alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

setKeystorePassword

public void setKeystorePassword(String string)

(ftps) Default password to access keystore

Specified by:

setKeystorePassword in interface HasKeystore

setKeyManagerAlgorithm

public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

(ftps) Key manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setKeyManagerAlgorithm in interface HasKeystore

setKeystoreAlias

public void setKeystoreAlias(String string)

(ftps) Alias to obtain specific certificate or key in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias

public void setKeystoreAliasAuthAlias(String string)

(ftps) Authentication alias to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword

public void setKeystoreAliasPassword(String string)

(ftps) Default password to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasPassword in interface HasKeystore

setTruststore

public void setTruststore(String string)

(ftps) Resource url to truststore to be used for authenticating peer. If none specified, the JVMs default truststore will be used.

Specified by:

setTruststore in interface HasTruststore

setTruststoreType

public void setTruststoreType(KeystoreType value)

(ftps) Type of truststore

Specified by:

setTruststoreType in interface HasTruststore

Default value

jks

setTruststoreAuthAlias

public void setTruststoreAuthAlias(String string)

(ftps) Authentication alias used to obtain truststore password

Specified by:

setTruststoreAuthAlias in interface HasTruststore

setTruststorePassword

public void setTruststorePassword(String string)

(ftps) Default password to access truststore

Specified by:

setTruststorePassword in interface HasTruststore

setTrustManagerAlgorithm

public void setTrustManagerAlgorithm(String trustManagerAlgorithm)

(ftps) Trust manager algorithm. Can be left empty to use the servers default algorithm

Specified by:

setTrustManagerAlgorithm in interface HasTruststore

setVerifyHostname

public void setVerifyHostname(boolean b)

(ftps) If true, the hostname in the certificate will be checked against the actual hostname of the peer

Specified by:

setVerifyHostname in interface HasTruststore

setAllowSelfSignedCertificates

public void setAllowSelfSignedCertificates(boolean b)

(ftps) If true, self signed certificates are accepted

Specified by:

setAllowSelfSignedCertificates in interface HasTruststore

Default value

false

setIgnoreCertificateExpiredException

public void setIgnoreCertificateExpiredException(boolean b)

(ftps) If true, CertificateExpiredExceptions are ignored

Specified by:

setIgnoreCertificateExpiredException in interface HasTruststore

Default value

false

setProtP

@Deprecated
 @ConfigurationWarning(value="use attribute prot=\"P\" instead")
public void setProtP(boolean b)

Deprecated.

(ftps) if true, the server returns data via a SSL socket

Default value

false

setProt

public void setProt(FtpSession.Prot prot)

Sets the Data Channel Protection Level.

Default value

C

setKeyboardInteractive

public void setKeyboardInteractive(boolean keyboardInteractive)

When true, keyboardinteractive is used to login

Default value

false

setName

public void setName(String name)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject