nl.nn.adapterframework.filesystem

Class FileSystemListener<F,FS extends IBasicFileSystem<F>>

java.lang.Object

nl.nn.adapterframework.filesystem.FileSystemListener<F,FS>

All Implemented Interfaces:

HasPhysicalDestination, IConfigurable, IConfigurationAware, IHasProcessState<F>, IListener<F>, INamedObject, IProvidesMessageBrowsers<F>, IPullingListener<F>, IScopeProvider, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

DirectoryListener, FtpFileSystemListener, MailListener, Samba2Listener, SftpFileSystemListener

public abstract class FileSystemListener<F,FS extends IBasicFileSystem<F>>
extends Object
implements IPullingListener<F>, HasPhysicalDestination, IProvidesMessageBrowsers<F>

listener that looks in a FileSystem for files. When a file is found, it is moved to an process-folder, so that it isn't found more then once. The name of the moved file is passed to the pipeline.

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILENAME_KEY
static String	FILEPATH_KEY
protected org.apache.logging.log4j.Logger	log
static String	ORIGINAL_FILENAME_KEY

Constructor Summary

Constructors

Constructor and Description
FileSystemListener()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<F> rawMessage, PipeLineSession pipeLineSession) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
RawMessageWrapper<F>	changeProcessState(RawMessageWrapper<F> message, ProcessState toState, String reason) Change the processState of the message to the specified state, if that state is supported.
protected boolean	checkForExistenceOfFolder(String attributeName, String folderName)
void	close() Close all resources used for listening.
void	closeThread(Map<String,Object> threadContext) Finalizes a message receiving thread.
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
protected abstract FS	createFileSystem()
Message	extractMessage(RawMessageWrapper<F> rawMessage, Map<String,Object> context) Returns the filename, or the contents
Map<String,Object>	extractMessageProperties(F rawMessage, String originalFilename)
String	getDomain()
IMessageBrowser<F>	getMessageBrowser(ProcessState state) returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).
String	getPhysicalDestinationName()
RawMessageWrapper<F>	getRawMessage(Map<String,Object> threadContext) Retrieves messages from queue or other channel, but does no processing on it.
String	getStateFolder(ProcessState state)
Set<ProcessState>	knownProcessStates() Provides the set of ProcessStates used by this listener.
void	open() Prepares the listener for receiving messages.
Map<String,Object>	openThread() Prepares a thread for receiving messages.
void	setCharset(String charset) Charset to be used for extracting the contents
void	setCreateFolders(boolean createFolders) If set to true, the folders to look for files and to move files to when being processed and after being processed are created if they are specified and do not exist
void	setCreateInputDirectory(boolean createInputDirectory) Deprecated.
void	setDelete(boolean b) If set true, the file processed will be deleted after being processed, and not stored
void	setDisableMessageBrowsers(boolean disableMessageBrowsers) If set true, no browsers for process folders are generated
void	setErrorFolder(String errorFolder) Folder where files are stored after being processed, in case the exit-state was not equal to success
void	setExcludeWildcard(String excludeWildcard) Filter of files to be excluded when looking in inputFolder.
void	setExcludeWildCard(String excludeWildcard) Deprecated.
void	setFileTimeSensitive(boolean b) If true, the file modification time is used in addition to the filename to determine if a file has been seen before
void	setHoldFolder(String holdFolder) Folder where messages from the error folder can be put on Hold, temporarily
void	setInProcessFolder(String inProcessFolder) Folder where files are stored while being processed
void	setInputDirectory(String inputDirectory) Deprecated.
void	setInputFolder(String inputFolder) Folder that is scanned for files.
void	setLogFolder(String logFolder) Folder where a copy of every file that is received is stored
void	setMessageIdPropertyKey(String messageIdPropertyKey) Key of Property to use as messageId.
void	setMessageType(String messageType) Determines the contents of the message that is sent to the pipeline.
void	setMinStableTime(long minStableTime) Minimal age of file in milliseconds, to avoid receiving a file while it is still being written
void	setName(String name) The functional name of the object.
void	setNumberOfBackups(int i) Number of copies held of a file with the same name.
void	setOutputDirectory(String outputDirectory) Deprecated.
void	setOutputFormat(DocumentFormat outputFormat) OutputFormat of message for messageType=info
void	setOverwrite(boolean overwrite) If set true, the destination file will be deleted if it already exists
void	setProcessedDirectory(String processedDirectory) Deprecated.
void	setProcessedFolder(String processedFolder) Folder where files are stored after being processed
void	setStoreMetadataInSessionKey(String storeMetadataInSessionKey) If set, an XML with all message properties is provided under this key
void	setWildcard(String wildcard) Filter of files to look for in inputFolder e.g.
void	setWildCard(String wildcard) Deprecated.
Map<ProcessState,Set<ProcessState>>	targetProcessStates() Provides the set of ProcessStates that a message in the specified state can be moved to, e.g.

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

getApplicationContext, getName

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

ORIGINAL_FILENAME_KEY

public static final String ORIGINAL_FILENAME_KEY

See Also:

Constant Field Values

FILENAME_KEY

public static final String FILENAME_KEY

See Also:

Constant Field Values

FILEPATH_KEY

public static final String FILEPATH_KEY

See Also:

Constant Field Values

Constructor Detail

FileSystemListener

public FileSystemListener()

Method Detail

createFileSystem

protected abstract FS createFileSystem()

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IListener

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. 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 IListener<F>

Throws:

ConfigurationException

knownProcessStates

public Set<ProcessState> knownProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates used by this listener.

Specified by:

knownProcessStates in interface IHasProcessState<F>

targetProcessStates

public Map<ProcessState,Set<ProcessState>> targetProcessStates()

Description copied from interface: IHasProcessState

Provides the set of ProcessStates that a message in the specified state can be moved to, e.g. from a MessageBrowser for that state.

Specified by:

targetProcessStates in interface IHasProcessState<F>

open

public void open()
          throws ListenerException

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<F>

Throws:

ListenerException

checkForExistenceOfFolder

protected boolean checkForExistenceOfFolder(String attributeName,
                                            String folderName)
                                     throws ListenerException

Throws:

ListenerException

close

public void close()
           throws ListenerException

Description copied from interface: IListener

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

Specified by:

close in interface IListener<F>

Throws:

ListenerException

openThread

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

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<F>

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored. May not be null, must be a mutable map type.

Throws:

ListenerException

closeThread

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

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<F>

Throws:

ListenerException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

getDomain

public String getDomain()

Specified by:

getDomain in interface HasPhysicalDestination

getRawMessage

public RawMessageWrapper<F> getRawMessage(@Nonnull
                                          Map<String,Object> threadContext)
                                   throws ListenerException

Description copied from interface: IPullingListener

Retrieves messages from queue or other channel, but does no processing on it. 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.

Any thread-specific properties should be stored in and retrieved from the threadContext.

Specified by:

getRawMessage in interface IPullingListener<F>

Throws:

ListenerException

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  RawMessageWrapper<F> rawMessage,
                                  PipeLineSession pipeLineSession)
                           throws ListenerException

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<F>

Throws:

ListenerException

extractMessage

public Message extractMessage(@Nonnull
                              RawMessageWrapper<F> rawMessage,
                              @Nonnull
                              Map<String,Object> context)
                       throws ListenerException

Returns the filename, or the contents

Specified by:

extractMessage in interface IListener<F>

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a Map threadContext depending on caller.

Returns:

input Message for adapter.

Throws:

ListenerException

extractMessageProperties

@Nonnull
public Map<String,Object> extractMessageProperties(@Nonnull
                                                            F rawMessage,
                                                            @Nullable
                                                            String originalFilename)
                                                     throws ListenerException

Throws:

ListenerException

changeProcessState

public RawMessageWrapper<F> changeProcessState(RawMessageWrapper<F> message,
                                               ProcessState toState,
                                               String reason)
                                        throws ListenerException

Description copied from interface: IHasProcessState

Change the processState of the message to the specified state, if that state is supported. If it is not supported, nothing changes, and false is returned.

Specified by:

changeProcessState in interface IHasProcessState<F>

Returns:

the moved message, or null if no message was moved.

Throws:

ListenerException

getStateFolder

public String getStateFolder(ProcessState state)

getMessageBrowser

public IMessageBrowser<F> getMessageBrowser(ProcessState state)

Description copied from interface: IProvidesMessageBrowsers

returns a browser of messages that are in ProcessState 'state', and are stored in a storage managed by the listener itself (as opposed to a storage configured as a messageLog or errorStorage in the configuration).

Specified by:

getMessageBrowser in interface IProvidesMessageBrowsers<F>

setName

public void setName(String name)

Description copied from interface: INamedObject

The functional name of the object.

Specified by:

setName in interface INamedObject

setInputDirectory

@Deprecated
 @ConfigurationWarning(value="attribute \'inputDirectory\' has been replaced by \'inputFolder\'")
public void setInputDirectory(String inputDirectory)

Deprecated.

setInputFolder

public void setInputFolder(String inputFolder)

Folder that is scanned for files. If not set, the root is scanned

setOutputDirectory

@Deprecated
 @ConfigurationWarning(value="attribute \'outputDirectory\' has been replaced by \'inProcessFolder\'")
public void setOutputDirectory(String outputDirectory)

Deprecated.

setInProcessFolder

public void setInProcessFolder(String inProcessFolder)

Folder where files are stored while being processed

setProcessedDirectory

@Deprecated
 @ConfigurationWarning(value="attribute \'processedDirectory\' has been replaced by \'processedFolder\'")
public void setProcessedDirectory(String processedDirectory)

Deprecated.

setProcessedFolder

public void setProcessedFolder(String processedFolder)

Folder where files are stored after being processed

setErrorFolder

public void setErrorFolder(String errorFolder)

Folder where files are stored after being processed, in case the exit-state was not equal to success

setHoldFolder

public void setHoldFolder(String holdFolder)

Folder where messages from the error folder can be put on Hold, temporarily

setLogFolder

public void setLogFolder(String logFolder)

Folder where a copy of every file that is received is stored

setCreateFolders

public void setCreateFolders(boolean createFolders)

If set to true, the folders to look for files and to move files to when being processed and after being processed are created if they are specified and do not exist

Default value

false

setCreateInputDirectory

@Deprecated
 @ConfigurationWarning(value="attribute \'createInputDirectory\' has been replaced by \'createFolders\'")
public void setCreateInputDirectory(boolean createInputDirectory)

Deprecated.

setDelete

public void setDelete(boolean b)

If set true, the file processed will be deleted after being processed, and not stored

Default value

false

setNumberOfBackups

public void setNumberOfBackups(int i)

Number of copies held of a file with the same name. Backup files have a dot and a number suffixed to their name. If set to 0, no backups will be kept.

Default value

0

setOverwrite

public void setOverwrite(boolean overwrite)

If set true, the destination file will be deleted if it already exists

Default value

false

setMessageType

public void setMessageType(String messageType)

Determines the contents of the message that is sent to the pipeline. Can be 'name', for the filename, 'path', for the full file path, 'contents' for the contents of the file, 'info' for file information. For any other value, the attributes of the file are searched and used

Default value

path

setFileTimeSensitive

public void setFileTimeSensitive(boolean b)

If true, the file modification time is used in addition to the filename to determine if a file has been seen before

Default value

false

setMinStableTime

public void setMinStableTime(long minStableTime)

Minimal age of file in milliseconds, to avoid receiving a file while it is still being written

Default value

1000

setMessageIdPropertyKey

public void setMessageIdPropertyKey(String messageIdPropertyKey)

Key of Property to use as messageId. If not set, the filename of the file as it was received in the inputFolder is used as the messageId

Default value

for MailFileSystems: Message-ID

setDisableMessageBrowsers

public void setDisableMessageBrowsers(boolean disableMessageBrowsers)

If set true, no browsers for process folders are generated

Default value

false

setWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'wildCard\' has been renamed to \'wildcard\'")
public void setWildCard(String wildcard)

Deprecated.

setWildcard

public void setWildcard(String wildcard)

Filter of files to look for in inputFolder e.g. '*.inp'.

setExcludeWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'excludeWildCard\' has been renamed to \'excludeWildcard\'")
public void setExcludeWildCard(String excludeWildcard)

Deprecated.

setExcludeWildcard

public void setExcludeWildcard(String excludeWildcard)

Filter of files to be excluded when looking in inputFolder.

setStoreMetadataInSessionKey

public void setStoreMetadataInSessionKey(String storeMetadataInSessionKey)

If set, an XML with all message properties is provided under this key

setCharset

public void setCharset(String charset)

Charset to be used for extracting the contents

setOutputFormat

public void setOutputFormat(DocumentFormat outputFormat)

OutputFormat of message for messageType=info

Default value

XML