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
The
ITransactionalStorage
is responsible for storing and
retrieving-back messages under transaction control.- Since:
- 4.1
- Author:
- Gerrit van Brakel
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.frankframework.core.IMessageBrowser
IMessageBrowser.HideMethod, IMessageBrowser.SortOrder, IMessageBrowser.StorageType
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
void
getMessage
(String storageKey) Retrieves and deletes the message.getType()
void
open()
Prepares the object for operation.void
Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes.void
Possible values areE
(error store),M
(message store),L
(message log for Pipe) orA
(message log for Receiver).
Receiver will always set type toE
for errorStorage and always set type toA
for messageLog.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:
-
-
Method Details
-
open
Prepares the object for operation. After this method is called the storeMessage() and retrieveMessage() methods may be called- Throws:
Exception
-
close
void close() -
configure
- 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
Retrieves and deletes the message.- Throws:
ListenerException
-
setSlotId
Optional identifier for this storage, to be able to share the physical storage between a number of receivers and pipes. -
getSlotId
String getSlotId() -
setType
Possible values areE
(error store),M
(message store),L
(message log for Pipe) orA
(message log for Receiver).
Receiver will always set type toE
for errorStorage and always set type toA
for messageLog. SenderPipe will set type toL
for messageLog (when type isn't specified).
SeeMessageStoreSender
for typeM
.- Default value
E
for errorStorage on ReceiverA
for messageLog on ReceiverL
for messageLog on Pipe
-
getType
String getType()
-