Package org.frankframework.core

Interface IMessageBrowser<M>

All Superinterfaces:

IXAEnabled

All Known Subinterfaces:

ITransactionalStorage<S>

All Known Implementing Classes:

AbstractJdbcMessageBrowser, AbstractJmsMessageBrowser, DummyTransactionalStorage, EsbJmsTransactionalStorage, FileSystemMessageBrowser, JdbcTableMessageBrowser, JdbcTransactionalStorage, JmsBrowser, JmsTransactionalStorage, MessageStoreSender

public interface IMessageBrowser<M>
extends IXAEnabled

Since:

4.3

Author:

Gerrit van Brakel

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	IMessageBrowser.HideMethod
static enum	IMessageBrowser.SortOrder
static enum	IMessageBrowser.StorageType

Method Summary

Modifier and Type	Method	Description
RawMessageWrapper<M>	browseMessage(String storageKey)	Retrieves the message, but does not delete.
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.
IMessageBrowser.HideMethod	getHideMethod()
String	getHideRegex()
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
void	setHideMethod(IMessageBrowser.HideMethod hideMethod)	(Only used when hideRegex is not empty) Specifies the way to hide
void	setHideRegex(String hideRegex)	Regular expression to mask strings in the errorStore/logStore.

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Method Details

getIterator

IMessageBrowsingIterator getIterator()
                              throws ListenerException

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

Throws:

ListenerException

getIterator

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

Throws:

ListenerException

getContext

IMessageBrowsingIteratorItem getContext(String storageKey)
                                 throws ListenerException

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.

Throws:

ListenerException

containsMessageId

boolean containsMessageId(String originalMessageId)
                   throws ListenerException

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

Throws:

ListenerException

containsCorrelationId

boolean containsCorrelationId(String correlationId)
                       throws ListenerException

Throws:

ListenerException

browseMessage

RawMessageWrapper<M> browseMessage(String storageKey)
                            throws ListenerException

Retrieves the message, but does not delete.

Throws:

ListenerException

deleteMessage

void deleteMessage(String storageKey)
            throws ListenerException

Deletes the message.

Throws:

ListenerException

getMessageCount

int getMessageCount()
             throws ListenerException

Throws:

ListenerException

setHideRegex

void setHideRegex(String hideRegex)

Regular expression to mask strings in the errorStore/logStore. Every character between to the strings in this expression will be replaced by a '*'.
For example, the regular expression (?<=<party>).*?(?=</party>) will replace every character between keys <party> and </party>
When no hideRegex is configured on the errorStore / logStore but is configured on the Receiver.setHideRegex(String), then the Receiver's hideRegex is used for the errorStore / logStore.

getHideRegex

String getHideRegex()

setHideMethod

void setHideMethod(IMessageBrowser.HideMethod hideMethod)

(Only used when hideRegex is not empty) Specifies the way to hide

Default value

ALL

getHideMethod

IMessageBrowser.HideMethod getHideMethod()

getStorageFields

List<MessageBrowserField> getStorageFields()

Retrieves the field names of the storage