org.apache.openjpa.kernel
Class OpenJPASavepoint

java.lang.Object
  extended by org.apache.openjpa.kernel.OpenJPASavepoint
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
AbstractJDBCSavepointManager.ConnectionSavepoint

public class OpenJPASavepoint
extends Object
implements 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
OpenJPASavepoint(Broker broker, String name, boolean copy)
          Constructor.
 
Method Summary
 Broker getBroker()
          Return the Broker associated with this savepoint.
 boolean getCopyFieldState()
          Whether this savepoint copies the field values of retained instances.
 String getName()
          Return the name for this savepoint.
protected  Map<StateManagerImpl,SavepointFieldManager> getStates()
          Return the map of states to savepoint data.
 void release(boolean user)
          Release this savepoint and any associated resources.
 Collection<SavepointFieldManager> rollback(Collection<OpenJPASavepoint> previous)
          Handle the rolled back state, returning saved data.
 void save(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,
                        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 String getName()
Return the name for this savepoint.


getCopyFieldState

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


getStates

protected Map<StateManagerImpl,SavepointFieldManager> getStates()
Return the map of states to savepoint data.


save

public void save(Collection<StateManagerImpl> states)
Set this savepoint, saving any state for the passed-in OpenJPAStateManagers as necessary.


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 Collection<SavepointFieldManager> rollback(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


Copyright © 2006-2012 Apache Software Foundation. All Rights Reserved.