Package org.axonframework.modelling.saga.repository.jdbc

Class JdbcSagaStore

java.lang.Object
org.axonframework.modelling.saga.repository.jdbc.JdbcSagaStore
All Implemented Interfaces:
SagaStore<Object>
public class JdbcSagaStore extends Object implements SagaStore<Object>
A SagaStore implementation that uses JDBC to store and find Saga instances.

Before using this store make sure the database contains an association value- and saga entry table. These can be constructed with SagaSqlSchema.sql_createTableAssocValueEntry(Connection) and SagaSqlSchema.sql_createTableSagaEntry(Connection) respectively. For convenience, these tables can be constructed through the createSchema() operation.

Since:
2.1
Author:
Allard Buijze, Kristian Rosenvold

  • Constructor Details

  • Method Details

    • builder

      public static JdbcSagaStore.Builder builder()
      Instantiate a Builder to be able to create a JdbcSagaStore.

      The SagaSqlSchema is defaulted to an GenericSagaSqlSchema.

      The ConnectionProvider and Serializer are hard requirements and as such should be provided.

      You can choose to provide a DataSource instead of a ConnectionProvider, but in that case the used ConnectionProvider will be a DataSourceConnectionProvider wrapped by a UnitOfWorkAwareConnectionProviderWrapper.

      Returns:
      a Builder to be able to create a JdbcSagaStore

    • loadSaga

      public <S> SagaStore.Entry<S> loadSaga(Class<S> sagaType, String sagaIdentifier)
      Description copied from interface: SagaStore
      Loads a known saga SagaStore.Entry instance with given sagaType and unique sagaIdentifier.

      Due to the concurrent nature of Sagas, it is not unlikely for a Saga to have ceased to exist after it has been found based on associations. Therefore, a repository should return null in case a Saga doesn't exists, as opposed to throwing an exception.

      Specified by:
      loadSaga in interface SagaStore<Object>
      Parameters:
      sagaType - The type of the returned saga entry
      sagaIdentifier - The unique identifier of the returned saga entry
      Returns:
      The saga entry, or null if no such saga exists

    • findSagas

      public Set<String> findSagas(Class<?> sagaType, AssociationValue associationValue)
      Description copied from interface: SagaStore
      Returns identifiers of saga instances of the given sagaType that have been associated with the given associationValue.
      Specified by:
      findSagas in interface SagaStore<Object>
      Parameters:
      sagaType - The type of the returned sagas
      associationValue - The value that the returned sagas must be associated with
      Returns:
      A set of identifiers of sagas having the correct type and association value

    • deleteSaga

      public void deleteSaga(Class<?> sagaType, String sagaIdentifier, Set<AssociationValue> associationValues)
      Description copied from interface: SagaStore
      Deletes a Saga with given sagaType and sagaIdentifier and all its associations. For convenience all known association values are passed along as well, which has the advantage that the saga store is not required to keep an index of association value to saga identifier.
      Specified by:
      deleteSaga in interface SagaStore<Object>
      Parameters:
      sagaType - The type of saga to delete
      sagaIdentifier - The identifier of the saga to delete
      associationValues - The known associations of the saga

    • updateSaga

      public void updateSaga(Class<?> sagaType, String sagaIdentifier, Object saga, AssociationValues associationValues)
      Description copied from interface: SagaStore
      Updates a given Saga after its state was modified. The tracking token of the event last handled by the Saga is also passed as a parameter. Note that the given token may be null if the Saga is not tracking the event store.
      Specified by:
      updateSaga in interface SagaStore<Object>
      Parameters:
      sagaType - The type of the Saga
      sagaIdentifier - The identifier of the Saga
      saga - The Saga instance
      associationValues - The initial association values of the Saga

    • insertSaga

      public void insertSaga(Class<?> sagaType, String sagaIdentifier, Object saga, Set<AssociationValue> associationValues)
      Description copied from interface: SagaStore
      Adds a new Saga and its initial association values to the store. The tracking token of the event last handled by the Saga (usually the event that started the Saga) is also passed as a parameter. Note that the given token may be null if the Saga is not tracking the event store.
      Specified by:
      insertSaga in interface SagaStore<Object>
      Parameters:
      sagaType - The type of the Saga
      sagaIdentifier - The identifier of the Saga
      saga - The Saga instance
      associationValues - The initial association values of the Saga

    • setSerializer

      public void setSerializer(Serializer serializer)
      Sets the Serializer instance to serialize Sagas with. Defaults to the XStream Serializer.
      Parameters:
      serializer - the Serializer instance to serialize Sagas with

    • createSchema

      public void createSchema() throws SQLException
      Creates the SQL Schema required to store Sagas and their associations.
      Throws:
      SQLException - when an error occurs preparing of executing the required statements