Package org.frankframework.receivers

Class DirectoryListener

java.lang.Object

org.frankframework.filesystem.AbstractFileSystemListener<Path,LocalFileSystem>

org.frankframework.receivers.DirectoryListener

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IHasProcessState<Path>, IListener<Path>, IProvidesMessageBrowsers<Path>, IPullingListener<Path>, IScopeProvider, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@Category(BASIC)
public class DirectoryListener
extends AbstractFileSystemListener<Path,LocalFileSystem>

Listener that looks for files in a LocalFileSystem. The DirectoryListener keeps track of the file process by storing it in different folders. The application may create the folders if you (a) set the root attribute and (b) set the attribute createFolders to true. The attribute messageType dictates what information of the file is passed to the pipeline. This may be the name, canonical path, the entire file, or the file's metadata.

Example usage:

 <DirectoryListener
        name="directoryListener"
        messageType="info"
        root="${rootdirectory}"
        inputFolder="in"
        inProcessFolder="inProcess"
        errorFolder="error"
        createFolders="true"
 />
 

Nested Class Summary

Nested classes/interfaces inherited from class org.frankframework.filesystem.AbstractFileSystemListener

AbstractFileSystemListener.IMessageType, AbstractFileSystemListener.MessageType

Field Summary

Fields inherited from class org.frankframework.filesystem.AbstractFileSystemListener

FILENAME_KEY, FILEPATH_KEY, log, ORIGINAL_FILENAME_KEY

Constructor Summary

Constructors

Constructor	Description
DirectoryListener()

Method Summary

Modifier and Type	Method	Description
protected LocalFileSystem	createFileSystem()
void	setMessageType(AbstractFileSystemListener.MessageType messageType)	Determines the contents of the message that is sent to the pipeline.
void	setRoot(String root)	Optional base folder, that serves as root for all other folders

Methods inherited from class org.frankframework.filesystem.AbstractFileSystemListener

afterMessageProcessed, changeProcessState, checkForExistenceOfFolder, closeThread, configure, extractMessage, extractMessageProperties, getDomain, getMessageBrowser, getPhysicalDestinationName, getRawMessage, getStateFolder, knownProcessStates, openThread, setCharset, setCreateFolders, setDelete, setDisableMessageBrowsers, setErrorFolder, setExcludeWildcard, setFileTimeSensitive, setHoldFolder, setInProcessFolder, setInputFolder, setLogFolder, setMessageIdPropertyKey, setMessageType, setMinStableTime, setName, setNumberOfBackups, setOutputFormat, setOverwrite, setProcessedFolder, setStoreMetadataInSessionKey, setWildcard, start, stop, targetProcessStates

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Constructor Details

DirectoryListener

public DirectoryListener()

Method Details

createFileSystem

protected LocalFileSystem createFileSystem()

Specified by:

createFileSystem in class AbstractFileSystemListener<Path,LocalFileSystem>

setRoot

public void setRoot(String root)

Optional base folder, that serves as root for all other folders

setMessageType

public void setMessageType(AbstractFileSystemListener.MessageType messageType)

Determines the contents of the message that is sent to the pipeline. The value of the attribute matching the searchKey is returned when using ATTRIBUTE

Default value

PATH