nl.nn.adapterframework.ftp

Class FtpFileRetrieverPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.ftp.FtpFileRetrieverPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Deprecated.

@Deprecated
 @ConfigurationWarning(value="Please replace with FtpFileSystemListener")
public class FtpFileRetrieverPipe
extends FixedForwardPipe

Pipe for retreiving files via (s)ftp. The path of the created local file is returned.

Since:

4.4

Author:

John Dekker

Field Summary

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
FtpFileRetrieverPipe() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	configure() Deprecated. checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) Deprecated. This is where the action takes place.
FtpSession	getFtpSession() Deprecated.
String	getLocalDirectory() Deprecated.
String	getLocalFilenamePattern() Deprecated.
String	getRemoteDirectory() Deprecated.
boolean	isDeleteAfterGet() Deprecated.
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	setCertificateAuthAlias(String certificateAuthAlias) Deprecated. (ftps) alias used to obtain certificate password
void	setCertificatePassword(String certificatePassword) Deprecated. (ftps)
void	setConsoleKnownHostsVerifier(boolean verifier) Deprecated. (sftp)
void	setDeleteAfterGet(boolean b) Deprecated. if true, the remote file is deleted after it is retrieved
void	setFileType(FtpSession.FileType fileType) Deprecated.
void	setFtpSession(FtpSession session) Deprecated.
void	setFtpTypeDescription(FtpSession.FtpType ftpTypeDescription) Deprecated.
void	setHost(String host) Deprecated. name or ip adres of remote host
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. (ftps) resource url to certificate to be used for authentication
void	setKeystoreType(KeystoreType keystoreType) Deprecated. (ftps)
void	setKnownHostsPath(String knownHostsPath) Deprecated. (sftp) path to file with knownhosts
void	setLocalDirectory(String string) Deprecated. local directory in which files have to be downloaded
void	setLocalFilenamePattern(String string) Deprecated. pattern (in messageformat) of the local filename
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	setProtP(boolean protP) Deprecated. (ftps) if true, the server returns data via another socket
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 string) Deprecated. remote directory
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
void	stop() Deprecated. Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

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.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

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

getMaxThreads

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

getName

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 nl.nn.adapterframework.core.IForwardTarget

getName

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Constructor Detail

FtpFileRetrieverPipe

public FtpFileRetrieverPipe()

Deprecated.

Method Detail

configure

public void configure()
               throws ConfigurationException

Deprecated.

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

stop

public void stop()

Deprecated.

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Overrides:

stop in class AbstractPipe

doPipe

public PipeRunResult doPipe(Message message,
                            PipeLineSession session)
                     throws PipeRunException

Deprecated.

Description copied from class: AbstractPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object.

Specified by:

doPipe in interface IPipe

Specified by:

doPipe in class AbstractPipe

Throws:

PipeRunException

See Also:

IPipe.doPipe(Message, PipeLineSession)

setFtpSession

public void setFtpSession(FtpSession session)

Deprecated.

getFtpSession

public FtpSession getFtpSession()

Deprecated.

setLocalFilenamePattern

public void setLocalFilenamePattern(String string)

Deprecated.

pattern (in messageformat) of the local filename

getLocalFilenamePattern

public String getLocalFilenamePattern()

Deprecated.

setLocalDirectory

public void setLocalDirectory(String string)

Deprecated.

local directory in which files have to be downloaded

getLocalDirectory

public String getLocalDirectory()

Deprecated.

setRemoteDirectory

public void setRemoteDirectory(String string)

Deprecated.

remote directory

getRemoteDirectory

public String getRemoteDirectory()

Deprecated.

setDeleteAfterGet

public void setDeleteAfterGet(boolean b)

Deprecated.

if true, the remote file is deleted after it is retrieved

Default value

false

isDeleteAfterGet

public boolean isDeleteAfterGet()

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

public void setFtpTypeDescription(FtpSession.FtpType ftpTypeDescription)

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.

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

setKeystoreType

public void setKeystoreType(KeystoreType keystoreType)

Deprecated.

(ftps)

Default value

pkcs12

setKeyManagerAlgorithm

public void setKeyManagerAlgorithm(String keyManagerAlgorithm)

Deprecated.

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

Default value

websphere: ibmx509

setCertificateAuthAlias

public void setCertificateAuthAlias(String certificateAuthAlias)

Deprecated.

(ftps) alias used to obtain certificate password

setCertificatePassword

public void setCertificatePassword(String certificatePassword)

Deprecated.

(ftps)

Default value

setTruststore

public void setTruststore(String truststore)

Deprecated.

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

setTruststoreType

public void setTruststoreType(KeystoreType truststoreType)

Deprecated.

(ftps)

Default value

jks

setTrustManagerAlgorithm

public void setTrustManagerAlgorithm(String trustManagerAlgorithm)

Deprecated.

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

Default value

websphere: ibmx509

setTruststoreAuthAlias

public void setTruststoreAuthAlias(String truststoreAuthAlias)

Deprecated.

(ftps) alias used to obtain truststore password

setTruststorePassword

public void setTruststorePassword(String truststorePassword)

Deprecated.

(ftps)

Default value

setVerifyHostname

public void setVerifyHostname(boolean verifyHostname)

Deprecated.

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

Default value

true

setAllowSelfSignedCertificates

public void setAllowSelfSignedCertificates(boolean testModeNoCertificatorCheck)

Deprecated.

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

Default value

false

setProtP

public void setProtP(boolean protP)

Deprecated.

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

Default value

false

setKeyboardInteractive

public void setKeyboardInteractive(boolean keyboardInteractive)

Deprecated.

when true, keyboardinteractive is used to login

Default value

false