nl.nn.adapterframework.ftp

Class FtpListener

java.lang.Object

nl.nn.adapterframework.ftp.FtpSession

nl.nn.adapterframework.ftp.FtpListener

All Implemented Interfaces:

IConfigurable, IConfigurationAware, IListener<String>, INamedObject, IPullingListener<String>, IScopeProvider, HasKeystore, HasTruststore, RunStateEnquiring, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Deprecated.

@Deprecated
 @ConfigurationWarning(value="Please replace with FtpFileSystemListener")
public class FtpListener
extends FtpSession
implements IPullingListener<String>, RunStateEnquiring

Listener that polls a directory via FTP for files according to a wildcard. When a file is found, it is moved to an outputdirectory, so that it isn't found more then once. The name of the moved file is passed to the pipeline.

Author:

John Dekker

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.ftp.FtpSession

FtpSession.FileType, FtpSession.FtpType, FtpSession.Prot

Field Summary

Fields inherited from class nl.nn.adapterframework.ftp.FtpSession

ftpClient, log

Constructor Summary

Constructors

Constructor and Description
FtpListener() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> context) Deprecated. Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
protected boolean	canGoOn() Deprecated.
void	close() Deprecated. Close all resources used for listening.
void	closeThread(Map<String,Object> threadContext) Deprecated. Finalizes a message receiving thread.
void	configure() Deprecated. Configure does some basic checks (directoryProcessedFiles is a directory, inputDirectory is a directory, wildcard is filled etc.);
Message	extractMessage(String rawMessage, Map<String,Object> threadContext) Deprecated. Returns a string of the rawMessage
String	getIdFromRawMessage(String rawMessage, Map<String,Object> threadContext) Deprecated. Returns the name of the file in process (the 'archiveFile(File)' archived} file) concatenated with the record number.
String	getRawMessage(Map<String,Object> threadContext) Deprecated. Retrieves a single record from a file.
String	getRemoteDirectory() Deprecated.
long	getResponseTime() Deprecated.
void	open() Deprecated. Prepares the listener for receiving messages.
Map<String,Object>	openThread() Deprecated. Prepares a thread for receiving messages.
void	setRemoteDirectory(String string) Deprecated. remote directory from which files have to be downloaded
void	setResponseTime(long responseTime) Deprecated. Time in milliseconds between each poll interval
void	SetRunStateEnquirer(RunStateEnquirer enquirer) Deprecated.
String	toString() Deprecated.

Methods inherited from class nl.nn.adapterframework.ftp.FtpSession

checkReply, closeClient, deleteRemote, get, isConsoleKnownHostsVerifier, ls, lsAsString, openClient, put, setAllowSelfSignedCertificates, setAuthAlias, setCertificate, setCertificateAuthAlias, setCertificatePassword, setCertificateType, setConsoleKnownHostsVerifier, setFileType, setFtpType, setFtpTypeDescription, setHost, setIgnoreCertificateExpiredException, setKeyboardInteractive, setKeyManagerAlgorithm, setKeystore, setKeystoreAlias, setKeystoreAliasAuthAlias, setKeystoreAliasPassword, setKeystoreAuthAlias, setKeystorePassword, setKeystoreType, setKnownHostsPath, setMessageIsContent, setName, setPassive, setPassword, setPort, setPrefCSEncryption, setPrefSCEncryption, setPrivateKeyAuthAlias, setPrivateKeyFilePath, setPrivateKeyPassword, setProt, setProtP, setProxyAuthAlias, setProxyHost, setProxyPassword, setProxyPort, setProxyTransportType, setProxyUsername, setTrustManagerAlgorithm, setTruststore, setTruststoreAuthAlias, setTruststorePassword, setTruststoreType, setUsername, setVerifyHostname

Methods inherited from class java.lang.Object

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

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

getName, setName

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

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

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

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

Constructor Detail

FtpListener

public FtpListener()

Deprecated.

Method Detail

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  Object rawMessageOrWrapper,
                                  Map<String,Object> context)
                           throws ListenerException

Deprecated.

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<String>

Throws:

ListenerException

open

public void open()
          throws ListenerException

Deprecated.

Description copied from interface: IListener

Prepares the listener for receiving messages. open() is called once each time the listener is started.

Specified by:

open in interface IListener<String>

Throws:

ListenerException

close

public void close()
           throws ListenerException

Deprecated.

Description copied from interface: IListener

Close all resources used for listening. Called once once each time the listener is stopped.

Specified by:

close in interface IListener<String>

Throws:

ListenerException

openThread

public Map<String,Object> openThread()
                              throws ListenerException

Deprecated.

Description copied from interface: IPullingListener

Prepares a thread for receiving messages. Called once for each thread that will listen for messages.

Specified by:

openThread in interface IPullingListener<String>

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored.

Throws:

ListenerException

closeThread

public void closeThread(Map<String,Object> threadContext)
                 throws ListenerException

Deprecated.

Description copied from interface: IPullingListener

Finalizes a message receiving thread. Called once for each thread that listens for messages, just before IListener.close() is called.

Specified by:

closeThread in interface IPullingListener<String>

Throws:

ListenerException

configure

public void configure()
               throws ConfigurationException

Deprecated.

Configure does some basic checks (directoryProcessedFiles is a directory, inputDirectory is a directory, wildcard is filled etc.);

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<String>

Overrides:

configure in class FtpSession

Throws:

ConfigurationException

getIdFromRawMessage

public String getIdFromRawMessage(String rawMessage,
                                  Map<String,Object> threadContext)
                           throws ListenerException

Deprecated.

Returns the name of the file in process (the 'archiveFile(File)' archived} file) concatenated with the record number. As the 'archiveFile(File)' archivedFile method always renames to a unique file, the combination of this filename and the recordnumber is unique, enabling tracing in case of errors in the processing of the file. Override this method for your specific needs!

Specified by:

getIdFromRawMessage in interface IListener<String>

Returns:

Correlation ID string.

Throws:

ListenerException

getRawMessage

public String getRawMessage(Map<String,Object> threadContext)
                     throws ListenerException

Deprecated.

Retrieves a single record from a file. If the file is empty or fully processed, it looks wether there is a new file to process and returns the first record.

Specified by:

getRawMessage in interface IPullingListener<String>

Throws:

ListenerException

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

extractMessage

public Message extractMessage(String rawMessage,
                              Map<String,Object> threadContext)
                       throws ListenerException

Deprecated.

Returns a string of the rawMessage

Specified by:

extractMessage in interface IListener<String>

Returns:

input message for adapter.

Throws:

ListenerException

canGoOn

protected boolean canGoOn()

Deprecated.

SetRunStateEnquirer

public void SetRunStateEnquirer(RunStateEnquirer enquirer)

Deprecated.

Specified by:

SetRunStateEnquirer in interface RunStateEnquiring

setResponseTime

public void setResponseTime(long responseTime)

Deprecated.

Time in milliseconds between each poll interval

Default value

3600000

getResponseTime

public long getResponseTime()

Deprecated.

setRemoteDirectory

public void setRemoteDirectory(String string)

Deprecated.

remote directory from which files have to be downloaded

getRemoteDirectory

public String getRemoteDirectory()

Deprecated.