Package org.apache.openjpa.kernel

Class OpenJPASavepoint

  • All Implemented Interfaces:
    java.io.Serializable
    Direct Known Subclasses:
    AbstractJDBCSavepointManager.ConnectionSavepoint
    public class OpenJPASavepoint
extends java.lang.Object
implements java.io.Serializable
    Represents a savepoint where operations afterwards can be rolled back and restored to this point
    Since:
    0.3.4
    Author:
    Steve Kim
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      OpenJPASavepoint​(Broker broker, java.lang.String name, boolean copy)
      Constructor.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      Broker getBroker()
      Return the Broker associated with this savepoint.
      boolean getCopyFieldState()
      Whether this savepoint copies the field values of retained instances.
      java.lang.String getName()
      Return the name for this savepoint.
      protected java.util.Map<StateManagerImpl,​org.apache.openjpa.kernel.SavepointFieldManager> getStates()
      Return the map of states to savepoint data.
      void release​(boolean user)
      Release this savepoint and any associated resources.
      java.util.Collection<org.apache.openjpa.kernel.SavepointFieldManager> rollback​(java.util.Collection<OpenJPASavepoint> previous)
      Handle the rolled back state, returning saved data.
      void save​(java.util.Collection<StateManagerImpl> states)
      Set this savepoint, saving any state for the passed-in OpenJPAStateManagers as necessary.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • OpenJPASavepoint

        public OpenJPASavepoint​(Broker broker,
                        java.lang.String name,
                        boolean copy)
        Constructor. Indicate whether to copy field data into memory.

    • Method Detail

      • getBroker

        public Broker getBroker()
        Return the Broker associated with this savepoint.

      • getName

        public java.lang.String getName()
        Return the name for this savepoint.

      • getCopyFieldState

        public boolean getCopyFieldState()
        Whether this savepoint copies the field values of retained instances.

      • getStates

        protected java.util.Map<StateManagerImpl,​org.apache.openjpa.kernel.SavepointFieldManager> getStates()
        Return the map of states to savepoint data.

      • release

        public void release​(boolean user)
        Release this savepoint and any associated resources. Releases will happen in reverse order of creation.
        Parameters:
        user - if true, user initiated, otherwise a side effect of another savepoint's release/rollback

      • rollback

        public java.util.Collection<org.apache.openjpa.kernel.SavepointFieldManager> rollback​(java.util.Collection<OpenJPASavepoint> previous)
        Handle the rolled back state, returning saved data. Subclasses should return the collection returned from this method.
        Parameters:
        previous - previous savepoints set in the transaction