nl.nn.adapterframework.receivers

Class FileRecordListener

java.lang.Object

nl.nn.adapterframework.receivers.FileRecordListener

All Implemented Interfaces:

IConfigurable, IConfigurationAware, IListener, INamedObject, IPullingListener, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Deprecated.

@Deprecated
 @ConfigurationWarning(value="Please replace with DirectoryListener, in combination with a FileLineIteratorPipe")
public class FileRecordListener
extends Object
implements IPullingListener

File listener that looks in a directory for files according to a wildcard. When a file is found, it is read in a String object and parsed to records. After reading the file, the file is renamed and moved to a directory.

Author:

Johan Verrips

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.logging.log4j.Logger	log Deprecated.

Constructor Summary

Constructors

Constructor and Description
FileRecordListener() Deprecated.

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessage, Map threadContext) Deprecated. Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
protected String	archiveFile(File file) Deprecated. Moves a file to another directory and places a UUID in the name.
void	close() Deprecated. Close all resources used for listening.
void	closeThread(Map 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(Object rawMessage, Map threadContext) Deprecated. Extracts string from message obtained from IPullingListener.getRawMessage(Map).
String	getDirectoryProcessedFiles() Deprecated.
protected File	getFileToProcess() Deprecated. Gets a file to process.
String	getIdFromRawMessage(Object rawMessage, Map threadContext) Deprecated. Returns the name of the file in process (the archived file) concatenated with the record number.
String	getInputDirectory() Deprecated.
String	getName() Deprecated.
Object	getRawMessage(Map threadContext) Deprecated. Retrieves a single record from a file.
long	getResponseTime() Deprecated.
ISender	getSender() Deprecated.
String	getStoreFileNameInSessionKey() Deprecated.
String	getWildcard() Deprecated.
void	open() Deprecated. Prepares the listener for receiving messages.
Map	openThread() Deprecated. Prepares a thread for receiving messages.
protected Iterator<String>	parseToRecords(String input) Deprecated. Parse a String to an Iterator with objects (records).
void	setDirectoryProcessedFiles(String directoryProcessedFiles) Deprecated. the directory to store processed files in
void	setInputDirectory(String inputDirectory) Deprecated. the directory name to look in for files.
void	setName(String name) Deprecated. The functional name of the object.
void	setResponseTime(long responseTime) Deprecated. The time in milliseconds to delay when no records are to be processed, and this class has to look for the arrival of a new file
void	setSender(ISender sender) Deprecated.
void	setStoreFileNameInSessionKey(String storeFileNameInSessionKey) Deprecated. when set, the name of the read file is stored under this session key
void	setWildcard(String wildcard) Deprecated. the wildcard to look for files in the specified directory, e.g.
String	toString() Deprecated.

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

getApplicationContext

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

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

log

protected org.apache.logging.log4j.Logger log

Deprecated.

Constructor Detail

FileRecordListener

public FileRecordListener()

Deprecated.

Method Detail

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  Object rawMessage,
                                  Map threadContext)
                           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

Throws:

ListenerException

archiveFile

protected String archiveFile(File file)
                      throws ListenerException

Deprecated.

Moves a file to another directory and places a UUID in the name.

Returns:

String with the name of the (renamed and moved) file

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

Throws:

ListenerException

closeThread

public void closeThread(Map 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

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

Throws:

ConfigurationException

getFileToProcess

protected File getFileToProcess()

Deprecated.

Gets a file to process.

getIdFromRawMessage

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

Deprecated.

Returns the name of the file in process (the archived file) concatenated with the record number. As te 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

Returns:

Correlation ID string.

Throws:

ListenerException

getRawMessage

public Object getRawMessage(Map 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

Throws:

ListenerException

extractMessage

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

Deprecated.

Description copied from interface: IListener

Extracts string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Specified by:

extractMessage in interface IListener

Returns:

input message for adapter.

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

Throws:

ListenerException

openThread

public Map 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

Returns:

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

Throws:

ListenerException

parseToRecords

protected Iterator<String> parseToRecords(String input)

Deprecated.

Parse a String to an Iterator with objects (records). This method currently uses the end-of-line character ("\n") as a seperator. This method is easy to extend to satisfy your project needs.

setSender

public void setSender(ISender sender)

Deprecated.

getSender

public ISender getSender()

Deprecated.

toString

public String toString()

Deprecated.

Overrides:

toString in class Object

setName

public void setName(String name)

Deprecated.

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

getName

public String getName()

Deprecated.

Specified by:

getName in interface IConfigurationAware

Specified by:

getName in interface INamedObject

setInputDirectory

public void setInputDirectory(String inputDirectory)

Deprecated.

the directory name to look in for files.

getInputDirectory

public String getInputDirectory()

Deprecated.

setWildcard

public void setWildcard(String wildcard)

Deprecated.

the wildcard to look for files in the specified directory, e.g. \"*.inp\"

getWildcard

public String getWildcard()

Deprecated.

setDirectoryProcessedFiles

public void setDirectoryProcessedFiles(String directoryProcessedFiles)

Deprecated.

the directory to store processed files in

getDirectoryProcessedFiles

public String getDirectoryProcessedFiles()

Deprecated.

setResponseTime

public void setResponseTime(long responseTime)

Deprecated.

The time in milliseconds to delay when no records are to be processed, and this class has to look for the arrival of a new file

Default value

1000

getResponseTime

public long getResponseTime()

Deprecated.

setStoreFileNameInSessionKey

public void setStoreFileNameInSessionKey(String storeFileNameInSessionKey)

Deprecated.

when set, the name of the read file is stored under this session key

getStoreFileNameInSessionKey

public String getStoreFileNameInSessionKey()

Deprecated.