nl.nn.adapterframework.ftp

Class FtpSender

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.ftp.FtpSender

All Implemented Interfaces:

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

Deprecated.

@Deprecated
 @ConfigurationWarning(value="Please replace with FtpFileSystemSender")
public class FtpSender
extends SenderWithParametersBase
implements HasKeystore, HasTruststore

FTP client voor het versturen van files via FTP.

Author:

John Dekker

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
FtpSender() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	configure() Deprecated. configure() is called once at startup of the framework in the configure method of the owner of this sender.
FtpSession.FtpType	getFtpType() Deprecated.
String	getKeyManagerAlgorithm() Deprecated.
String	getKeystore() Deprecated.
String	getKeystoreAlias() Deprecated.
String	getKeystoreAliasAuthAlias() Deprecated.
String	getKeystoreAliasPassword() Deprecated.
String	getKeystoreAuthAlias() Deprecated.
String	getKeystorePassword() Deprecated.
KeystoreType	getKeystoreType() Deprecated.
FtpSession.Prot	getProt() Deprecated.
String	getRemoteDirectory() Deprecated.
String	getRemoteFilenamePattern() Deprecated.
String	getTrustManagerAlgorithm() Deprecated.
String	getTruststore() Deprecated.
String	getTruststoreAuthAlias() Deprecated.
String	getTruststorePassword() Deprecated.
KeystoreType	getTruststoreType() Deprecated.
boolean	isAllowSelfSignedCertificates() Deprecated.
boolean	isIgnoreCertificateExpiredException() Deprecated.
boolean	isSynchronous() Deprecated. When true, the result of sendMessage is the reply of the request.
boolean	isVerifyHostname() Deprecated.
SenderResult	sendMessage(Message message, PipeLineSession session) Deprecated. Send a message to some destination (as configured in the Sender object).
void	setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck) Deprecated. (ftps) if true, the server certificate can be self signed
void	setAuthAlias(String alias) Deprecated. name of the alias to obtain credentials to authenticatie on remote server
void	setConsoleKnownHostsVerifier(boolean verifier) Deprecated. (sftp)
void	setFileType(FtpSession.FileType fileType) Deprecated.
void	setFtpType(FtpSession.FtpType string) Deprecated.
void	setFtpTypeDescription(FtpSession.FtpType value) Deprecated.
void	setHost(String host) Deprecated. name or ip adres of remote host
void	setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException) Deprecated. If true, CertificateExpiredExceptions are ignored
void	setKeyboardInteractive(boolean keyboardInteractive) Deprecated. when true, keyboardinteractive is used to login
void	setKeyManagerAlgorithm(String keyManagerAlgorithm) Deprecated. selects the algorithm to generate keymanagers.
void	setKeystore(String certificate) Deprecated. Resource url to keystore or certificate.
void	setKeystoreAlias(String alias) Deprecated. Alias to obtain specific certificate or key in keystore
void	setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias) Deprecated. Authentication alias to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAliasPassword(String keystoreAliasPassword) Deprecated. Default password to authenticate access to certificate or key indicated by keystoreAlias
void	setKeystoreAuthAlias(String keystoreAuthAlias) Deprecated. Authentication alias used to obtain keystore password
void	setKeystorePassword(String keystorePassword) Deprecated. Default password to access keystore
void	setKeystoreType(KeystoreType keystoreType) Deprecated. Type of keystore
void	setKnownHostsPath(String knownHostsPath) Deprecated. (sftp) path to file with knownhosts
void	setMessageIsContent(boolean messageIsContent) Deprecated. if true, the contents of the message is send, otherwise it message contains the local filenames of the files to be send
void	setPassive(boolean b) Deprecated. 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 passwd) Deprecated. name of the password to authenticatie on remote server
void	setPort(int port) Deprecated. portnumber of remote host
void	setPrefCSEncryption(String prefCSEncryption) Deprecated. (sftp) optional preferred encryption from client to server for sftp protocol
void	setPrefSCEncryption(String prefSCEncryption) Deprecated. (sftp) optional preferred encryption from server to client for sftp protocol
void	setPrivateKeyAuthAlias(String privateKeyAuthAlias) Deprecated. (sftp) name of the alias to obtain credentials for passphrase of private key file
void	setPrivateKeyFilePath(String privateKeyFilePath) Deprecated. (sftp) path to private key file for sftp authentication
void	setPrivateKeyPassword(String passPhrase) Deprecated. (sftp) passphrase of private key file
void	setProt(FtpSession.Prot prot) Deprecated. Sets the Data Channel Protection Level.
void	setProtP(boolean b) Deprecated.
void	setProxyAuthAlias(String proxyAuthAlias) Deprecated. name of the alias to obtain credentials to authenticate on proxy
void	setProxyHost(String proxyHost) Deprecated. proxy host name
void	setProxyPassword(String proxyPassword) Deprecated. default password in case proxy requires authentication
void	setProxyPort(int proxyPort) Deprecated. proxy port
void	setProxyTransportType(int proxyTransportType) Deprecated. (sftp) transport type in case of sftp (1=standard, 2=http, 3=socks4, 4=socks5)
void	setProxyUsername(String proxyUsername) Deprecated. default user name in case proxy requires authentication
void	setRemoteDirectory(String remoteDirectory) Deprecated. remote directory in which files have to be uploaded
void	setRemoteFilenamePattern(String string) Deprecated. filename pattern for uploaded files
void	setTrustManagerAlgorithm(String trustManagerAlgorithm) Deprecated. selects the algorithm to generate trustmanagers.
void	setTruststore(String truststore) Deprecated. (ftps) resource url to truststore to be used for authentication
void	setTruststoreAuthAlias(String truststoreAuthAlias) Deprecated. (ftps) alias used to obtain truststore password
void	setTruststorePassword(String truststorePassword) Deprecated. (ftps)
void	setTruststoreType(KeystoreType truststoreType) Deprecated. (ftps)
void	setUsername(String username) Deprecated. name of the user to authenticatie on remote server
void	setVerifyHostname(boolean verifyHostname) Deprecated. (ftps) when true, the hostname in the certificate will be checked against the actual hostname

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

close, createBean, getLogPrefix, getName, open, setApplicationContext, setName

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.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.core.ISender

close, open, sendMessageOrThrow

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

getName, setName

Constructor Detail

FtpSender

public FtpSender()

Deprecated.

Method Detail

configure

public void configure()
               throws ConfigurationException

Deprecated.

Description copied from interface: ISender

configure() is called once at startup of the framework in the configure method of the owner of this sender. Purpose of this method is to check whether the static configuration of the sender is correct. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

isSynchronous

public boolean isSynchronous()

Deprecated.

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

Overrides:

isSynchronous in class SenderBase

sendMessage

public SenderResult sendMessage(Message message,
                                PipeLineSession session)
                         throws SenderException,
                                TimeoutException

Deprecated.

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

setRemoteDirectory

public void setRemoteDirectory(String remoteDirectory)

Deprecated.

remote directory in which files have to be uploaded

getRemoteDirectory

public String getRemoteDirectory()

Deprecated.

setRemoteFilenamePattern

public void setRemoteFilenamePattern(String string)

Deprecated.

filename pattern for uploaded files

getRemoteFilenamePattern

public String getRemoteFilenamePattern()

Deprecated.

setHost

public void setHost(String host)

Deprecated.

name or ip adres of remote host

setPort

public void setPort(int port)

Deprecated.

portnumber of remote host

Default value

21

setAuthAlias

public void setAuthAlias(String alias)

Deprecated.

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

setUsername

public void setUsername(String username)

Deprecated.

name of the user to authenticatie on remote server

setPassword

public void setPassword(String passwd)

Deprecated.

name of the password to authenticatie on remote server

setProxyHost

public void setProxyHost(String proxyHost)

Deprecated.

proxy host name

setProxyPort

public void setProxyPort(int proxyPort)

Deprecated.

proxy port

Default value

1080

setProxyAuthAlias

public void setProxyAuthAlias(String proxyAuthAlias)

Deprecated.

name of the alias to obtain credentials to authenticate on proxy

setProxyUsername

public void setProxyUsername(String proxyUsername)

Deprecated.

default user name in case proxy requires authentication

setProxyPassword

public void setProxyPassword(String proxyPassword)

Deprecated.

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 string)

Deprecated.

getFtpType

public FtpSession.FtpType getFtpType()

Deprecated.

setFileType

public void setFileType(FtpSession.FileType fileType)

Deprecated.

setMessageIsContent

public void setMessageIsContent(boolean messageIsContent)

Deprecated.

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)

Deprecated.

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 proxyTransportType)

Deprecated.

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

Default value

4

setPrefCSEncryption

public void setPrefCSEncryption(String prefCSEncryption)

Deprecated.

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

setPrefSCEncryption

public void setPrefSCEncryption(String prefSCEncryption)

Deprecated.

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

setPrivateKeyFilePath

public void setPrivateKeyFilePath(String privateKeyFilePath)

Deprecated.

(sftp) path to private key file for sftp authentication

setPrivateKeyAuthAlias

public void setPrivateKeyAuthAlias(String privateKeyAuthAlias)

Deprecated.

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

setPrivateKeyPassword

public void setPrivateKeyPassword(String passPhrase)

Deprecated.

(sftp) passphrase of private key file

setKnownHostsPath

public void setKnownHostsPath(String knownHostsPath)

Deprecated.

(sftp) path to file with knownhosts

setConsoleKnownHostsVerifier

public void setConsoleKnownHostsVerifier(boolean verifier)

Deprecated.

(sftp)

Default value

false

setKeystore

public void setKeystore(String certificate)

Deprecated.

Description copied from interface: HasKeystore

Resource url to keystore or certificate. If none specified, the JVMs default keystore will be used.

Specified by:

setKeystore in interface HasKeystore

getKeystore

public String getKeystore()

Deprecated.

Specified by:

getKeystore in interface HasKeystore

setKeystoreType

public void setKeystoreType(KeystoreType keystoreType)

Deprecated.

Description copied from interface: HasKeystore

Type of keystore

Specified by:

setKeystoreType in interface HasKeystore

getKeystoreType

public KeystoreType getKeystoreType()

Deprecated.

Specified by:

getKeystoreType in interface HasKeystore

setKeyManagerAlgorithm

public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

Deprecated.

selects the algorithm to generate keymanagers. can be left empty to use the servers default algorithm

Specified by:

setKeyManagerAlgorithm in interface HasKeystore

Default value

websphere: ibmx509

getKeyManagerAlgorithm

public String getKeyManagerAlgorithm()

Deprecated.

Specified by:

getKeyManagerAlgorithm in interface HasKeystore

setKeystoreAuthAlias

public void setKeystoreAuthAlias(String keystoreAuthAlias)

Deprecated.

Description copied from interface: HasKeystore

Authentication alias used to obtain keystore password

Specified by:

setKeystoreAuthAlias in interface HasKeystore

getKeystoreAuthAlias

public String getKeystoreAuthAlias()

Deprecated.

Specified by:

getKeystoreAuthAlias in interface HasKeystore

setKeystorePassword

public void setKeystorePassword(String keystorePassword)

Deprecated.

Description copied from interface: HasKeystore

Default password to access keystore

Specified by:

setKeystorePassword in interface HasKeystore

getKeystorePassword

public String getKeystorePassword()

Deprecated.

Specified by:

getKeystorePassword in interface HasKeystore

setKeystoreAlias

public void setKeystoreAlias(String alias)

Deprecated.

Description copied from interface: HasKeystore

Alias to obtain specific certificate or key in keystore

Specified by:

setKeystoreAlias in interface HasKeystore

getKeystoreAlias

public String getKeystoreAlias()

Deprecated.

Specified by:

getKeystoreAlias in interface HasKeystore

setKeystoreAliasAuthAlias

public void setKeystoreAliasAuthAlias(String keystoreAliasAuthAlias)

Deprecated.

Description copied from interface: HasKeystore

Authentication alias to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasAuthAlias in interface HasKeystore

getKeystoreAliasAuthAlias

public String getKeystoreAliasAuthAlias()

Deprecated.

Specified by:

getKeystoreAliasAuthAlias in interface HasKeystore

setKeystoreAliasPassword

public void setKeystoreAliasPassword(String keystoreAliasPassword)

Deprecated.

Description copied from interface: HasKeystore

Default password to authenticate access to certificate or key indicated by keystoreAlias

Specified by:

setKeystoreAliasPassword in interface HasKeystore

getKeystoreAliasPassword

public String getKeystoreAliasPassword()

Deprecated.

Specified by:

getKeystoreAliasPassword in interface HasKeystore

setTruststore

public void setTruststore(String truststore)

Deprecated.

(ftps) resource url to truststore to be used for authentication

Specified by:

setTruststore in interface HasTruststore

getTruststore

public String getTruststore()

Deprecated.

Specified by:

getTruststore in interface HasTruststore

setTruststoreType

public void setTruststoreType(KeystoreType truststoreType)

Deprecated.

(ftps)

Specified by:

setTruststoreType in interface HasTruststore

Default value

jks

getTruststoreType

public KeystoreType getTruststoreType()

Deprecated.

Specified by:

getTruststoreType in interface HasTruststore

setTrustManagerAlgorithm

public void setTrustManagerAlgorithm(String trustManagerAlgorithm)

Deprecated.

selects the algorithm to generate trustmanagers. can be left empty to use the servers default algorithm

Specified by:

setTrustManagerAlgorithm in interface HasTruststore

Default value

websphere: ibmx509

getTrustManagerAlgorithm

public String getTrustManagerAlgorithm()

Deprecated.

Specified by:

getTrustManagerAlgorithm in interface HasTruststore

setTruststoreAuthAlias

public void setTruststoreAuthAlias(String truststoreAuthAlias)

Deprecated.

(ftps) alias used to obtain truststore password

Specified by:

setTruststoreAuthAlias in interface HasTruststore

getTruststoreAuthAlias

public String getTruststoreAuthAlias()

Deprecated.

Specified by:

getTruststoreAuthAlias in interface HasTruststore

setTruststorePassword

public void setTruststorePassword(String truststorePassword)

Deprecated.

(ftps)

Specified by:

setTruststorePassword in interface HasTruststore

Default value

getTruststorePassword

public String getTruststorePassword()

Deprecated.

Specified by:

getTruststorePassword in interface HasTruststore

setVerifyHostname

public void setVerifyHostname(boolean verifyHostname)

Deprecated.

(ftps) when true, the hostname in the certificate will be checked against the actual hostname

Specified by:

setVerifyHostname in interface HasTruststore

Default value

true

isVerifyHostname

public boolean isVerifyHostname()

Deprecated.

Specified by:

isVerifyHostname in interface HasTruststore

setAllowSelfSignedCertificates

public void setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck)

Deprecated.

(ftps) if true, the server certificate can be self signed

Specified by:

setAllowSelfSignedCertificates in interface HasTruststore

Default value

false

isAllowSelfSignedCertificates

public boolean isAllowSelfSignedCertificates()

Deprecated.

Specified by:

isAllowSelfSignedCertificates in interface HasTruststore

setIgnoreCertificateExpiredException

public void setIgnoreCertificateExpiredException(boolean ignoreCertificateExpiredException)

Deprecated.

Description copied from interface: HasTruststore

If true, CertificateExpiredExceptions are ignored

Specified by:

setIgnoreCertificateExpiredException in interface HasTruststore

isIgnoreCertificateExpiredException

public boolean isIgnoreCertificateExpiredException()

Deprecated.

Specified by:

isIgnoreCertificateExpiredException in interface HasTruststore

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)

Deprecated.

Sets the Data Channel Protection Level.

Default value

C

getProt

public FtpSession.Prot getProt()

Deprecated.

setKeyboardInteractive

public void setKeyboardInteractive(boolean keyboardInteractive)

Deprecated.

when true, keyboardinteractive is used to login

Default value

false