com.buschmais.xo.api.XOTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xo.api Show documentation

There is a newer version: 2.5.0

package com.buschmais.xo.api;

/**
 * Defines the interface for {@link XOManager} transactions.
 */
public interface XOTransaction {


    /**
     * Defines a transaction lifecycle callback which can be registered.
     */
    public interface Synchronization {

        /**
         * Called before the transaction is completed.
         */
        void beforeCompletion();

        /**
         * Called after the transaction has been completed.
         *
         * @param committed true if the transaction as been committed, false if the transaction was rolled back.
         */
        void afterCompletion(boolean committed);
    }

    /**
     * Begin a transaction.
     */
    void begin();

    /**
     * Commit all changes of the current transaction.
     */
    void commit();

    /**
     * Rollback all changes from the current transaction.
     */
    void rollback();

    /**
     * Determine the state of the transaction associated with this {@link XOManager}.
     *
     * @return true if there  is an active transaction.
     */
    boolean isActive();

    /**
     * Register a {@link Synchronization}.
     *
     * @param synchronization The a {@link Synchronization}.
     */
    void registerSynchronization(Synchronization synchronization);

    /**
     * Unregister a {@link Synchronization}.
     *
     * @param synchronization The a {@link Synchronization}.
     */
    void unregisterSynchronization(Synchronization synchronization);
}