Package org.frankframework.filesystem

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

java.lang.Object

org.frankframework.filesystem.FileSystemMessageBrowser<F,FS>

All Implemented Interfaces:

IMessageBrowser<F>, IXAEnabled

public class FileSystemMessageBrowser<F,FS extends IBasicFileSystem<F>>
extends Object
implements IMessageBrowser<F>

Nested Class Summary

Nested classes/interfaces inherited from interface org.frankframework.core.IMessageBrowser

IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
FileSystemMessageBrowser(FS fileSystem, String folder, String messageIdPropertyKey)

Method Summary

Modifier and Type	Method	Description
RawMessageWrapper<F>	browseMessage(String storageKey)	Retrieves the message, but does not delete.
protected boolean	contains(String value, ThrowingFunction<IMessageBrowsingIteratorItem,String,ListenerException> field)
boolean	containsCorrelationId(String correlationId)
boolean	containsMessageId(String originalMessageId)	Check if the storage contains message with the given original messageId (as passed to storeMessage).
void	deleteMessage(String storageKey)	Deletes the message.
IMessageBrowsingIteratorItem	getContext(String storageKey)	Retrieves the message context as an iteratorItem.
IMessageBrowsingIterator	getIterator()	Gets an enumeration of messages.
IMessageBrowsingIterator	getIterator(Date startTime, Date endTime, IMessageBrowser.SortOrder order)
int	getMessageCount()
List<MessageBrowserField>	getStorageFields()	Retrieves the field names of the storage
boolean	isTransacted()	indicates implementing object is under transaction control, using XA-transactions

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.frankframework.core.IMessageBrowser

getHideMethod, getHideRegex, setHideMethod, setHideRegex

Field Details

log

protected org.apache.logging.log4j.Logger log

Constructor Details

FileSystemMessageBrowser

public FileSystemMessageBrowser(FS fileSystem,
 String folder,
 String messageIdPropertyKey)

Method Details

isTransacted

public boolean isTransacted()

Description copied from interface: IXAEnabled

indicates implementing object is under transaction control, using XA-transactions

Specified by:

isTransacted in interface IXAEnabled

getIterator

public IMessageBrowsingIterator getIterator()
                                     throws ListenerException

Description copied from interface: IMessageBrowser

Gets an enumeration of messages. This includes setting up connections, sessions etc.

Specified by:

getIterator in interface IMessageBrowser<F>

Throws:

ListenerException

getIterator

public IMessageBrowsingIterator getIterator(Date startTime,
 Date endTime,
 IMessageBrowser.SortOrder order)
                                     throws ListenerException

Specified by:

getIterator in interface IMessageBrowser<F>

Throws:

ListenerException

getContext

public IMessageBrowsingIteratorItem getContext(String storageKey)
                                        throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message context as an iteratorItem. The result can be used in the methods above that use an iteratorItem. Use this method as try-with-resources to close the connections.

Specified by:

getContext in interface IMessageBrowser<F>

Throws:

ListenerException

contains

protected boolean contains(String value,
 ThrowingFunction<IMessageBrowsingIteratorItem,String,ListenerException> field)
                    throws ListenerException

Throws:

ListenerException

containsMessageId

public boolean containsMessageId(String originalMessageId)
                          throws ListenerException

Description copied from interface: IMessageBrowser

Check if the storage contains message with the given original messageId (as passed to storeMessage).

Specified by:

containsMessageId in interface IMessageBrowser<F>

Throws:

ListenerException

containsCorrelationId

public boolean containsCorrelationId(String correlationId)
                              throws ListenerException

Specified by:

containsCorrelationId in interface IMessageBrowser<F>

Throws:

ListenerException

browseMessage

public RawMessageWrapper<F> browseMessage(String storageKey)
                                   throws ListenerException

Description copied from interface: IMessageBrowser

Retrieves the message, but does not delete.

Specified by:

browseMessage in interface IMessageBrowser<F>

Throws:

ListenerException

deleteMessage

public void deleteMessage(String storageKey)
                   throws ListenerException

Description copied from interface: IMessageBrowser

Deletes the message.

Specified by:

deleteMessage in interface IMessageBrowser<F>

Throws:

ListenerException

getMessageCount

public int getMessageCount()
                    throws ListenerException

Specified by:

getMessageCount in interface IMessageBrowser<F>

Throws:

ListenerException

getStorageFields

public List<MessageBrowserField> getStorageFields()

Description copied from interface: IMessageBrowser

Retrieves the field names of the storage

Specified by:

getStorageFields in interface IMessageBrowser<F>