Package org.frankframework.core

Interface ITransactionalStorage<S extends Serializable>

All Superinterfaces:

IMessageBrowser<S>, INamedObject, IXAEnabled

All Known Implementing Classes:

DummyTransactionalStorage, JdbcTransactionalStorage, JmsTransactionalStorage, MessageStoreSender

@FrankDocGroup(TRANSACTIONAL_STORAGE)
public interface ITransactionalStorage<S extends Serializable>
extends IMessageBrowser<S>, INamedObject

Marks an implementation as responsible for storing and retrieving-back messages under transaction control.

Since:

4.1

Author:

Gerrit van Brakel

See Also:

• Receiver

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
static final int	MAXCOMMENTLEN

Method Summary

Modifier and Type	Method	Description
void	configure()
RawMessageWrapper<S>	getMessage(String storageKey)	Retrieves and deletes the message.
String	getSlotId()
String	getType()
void	setSlotId(String string)	Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes.
void	setType(String string)	Possible values are E (error store), M (message store), L (message log for Pipe) or A (message log for Receiver). Receiver will always set type to E for errorStorage and always set type to A for messageLog.
void	start()	Prepares the object for operation.
void	stop()
String	storeMessage(String messageId, String correlationId, Date receivedDate, String comments, String label, S message)	Store the message, returns storageKey.

Methods inherited from interface org.frankframework.core.IMessageBrowser

browseMessage, containsCorrelationId, containsMessageId, deleteMessage, getContext, getHideMethod, getHideRegex, getIterator, getIterator, getMessageCount, setHideMethod, setHideRegex

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IXAEnabled

isTransacted

Field Details

MAXCOMMENTLEN

static final int MAXCOMMENTLEN

See Also:

• Constant Field Values

Method Details

start

void start()
    throws Exception

Prepares the object for operation. After this method is called the storeMessage() and retrieveMessage() methods may be called

Throws:

Exception

stop

void stop()

configure

void configure()
        throws ConfigurationException

Throws:

ConfigurationException

storeMessage

String storeMessage(String messageId,
 String correlationId,
 Date receivedDate,
 String comments,
 String label,
 S message)
             throws SenderException

Store the message, returns storageKey. The messageId should be unique.

Throws:

SenderException

getMessage

RawMessageWrapper<S> getMessage(String storageKey)
                         throws ListenerException

Retrieves and deletes the message.

Throws:

ListenerException

setSlotId

void setSlotId(String string)

Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes.

getSlotId

String getSlotId()

setType

void setType(String string)

Possible values are E (error store), M (message store), L (message log for Pipe) or A (message log for Receiver).
Receiver will always set type to E for errorStorage and always set type to A for messageLog. SenderPipe will set type to L for messageLog (when type isn't specified).
See MessageStoreSender for type M.

Default value

E for errorStorage on Receiver
A for messageLog on Receiver
L for messageLog on Pipe

getType

String getType()