Interface ITransactionalStorage<S extends Serializable>

All Superinterfaces:
HasName, IMessageBrowser<S>, IXAEnabled, NameAware
All Known Implementing Classes:
DummyTransactionalStorage, EsbJmsTransactionalStorage, JdbcTransactionalStorage, JmsTransactionalStorage, MessageStoreSender

@FrankDocGroup(TRANSACTIONAL_STORAGE) public interface ITransactionalStorage<S extends Serializable> extends IMessageBrowser<S>, NameAware, HasName
Marks an implementation as responsible for storing and retrieving-back messages under transaction control.
Since:
4.1
Author:
Gerrit van Brakel
See Also:
  • Field Details Link icon

  • Method Details Link icon

    • start Link icon

      void start()
      Prepares the object for operation. After this method is called the storeMessage() and retrieveMessage() methods may be called
    • stop Link icon

      void stop()
    • configure Link icon

      void configure() throws ConfigurationException
      Throws:
      ConfigurationException
    • storeMessage Link icon

      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 Link icon

      RawMessageWrapper<S> getMessage(String storageKey) throws ListenerException
      Retrieves and deletes the message.
      Throws:
      ListenerException
    • setSlotId Link icon

      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 Link icon

      String getSlotId()
    • setType Link icon

      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 Link icon

      String getType()