org.eclipse.emf.cdo.server
Interface IStoreAccessor.CommitContext

All Superinterfaces:
CDORevisionProvider
Enclosing interface:
IStoreAccessor

public static interface IStoreAccessor.CommitContext
extends CDORevisionProvider

Represents the state of a single, logical commit operation which is driven through multiple calls to several methods on the IStoreAccessor API. All these method calls get the same CommitContext instance passed so that the implementor of the IStoreAccessor can track the state and progress of the commit operation.

Since:
2.0
No Implement
This interface is not intended to be implemented by clients.

Method Summary
 CDOCommitInfo createCommitInfo()
           
 CDOBranchPoint getBranchPoint()
          Returns the branch ID and timestamp of this commit operation.
 String getCommitComment()
           
 CDOID[] getDetachedObjects()
          Returns an array of the removed object that are part of the commit operation represented by this CommitContext.
 Map<CDOID,EClass> getDetachedObjectTypes()
          Returns a map with an EClass value per CDOID type.
 org.eclipse.emf.cdo.spi.common.revision.InternalCDORevisionDelta[] getDirtyObjectDeltas()
          Returns an array of the dirty object deltas that are part of the commit operation represented by this CommitContext.
 org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision[] getDirtyObjects()
          Returns an array of the dirty objects that are part of the commit operation represented by this CommitContext.
 Map<CDOID,CDOID> getIDMappings()
          Returns an unmodifiable map from all temporary IDs to their persistent counter parts.
 ExtendedDataInputStream getLobs()
          Returns a stream that all lobs can be read from.
 org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision[] getNewObjects()
          Returns an array of the new objects that are part of the commit operation represented by this CommitContext.
 org.eclipse.emf.cdo.spi.common.model.InternalCDOPackageUnit[] getNewPackageUnits()
          Returns an array of the new package units that are part of the commit operation represented by this CommitContext.
 org.eclipse.emf.cdo.spi.common.model.InternalCDOPackageRegistry getPackageRegistry()
          Returns the temporary, transactional package manager associated with the commit operation represented by this CommitContext.
 List<RWOLockManager.LockState<Object,IView>> getPostCommmitLockStates()
           
 long getPreviousTimeStamp()
           
 String getRollbackMessage()
           
 ITransaction getTransaction()
          Returns the transactional view (ITransaction) which is the scope of the commit operation represented by this CommitContext.
 String getUserID()
           
 List<CDOIDReference> getXRefs()
           
 boolean isAutoReleaseLocksEnabled()
           
 
Methods inherited from interface org.eclipse.emf.cdo.common.revision.CDORevisionProvider
getRevision
 

Method Detail

getTransaction

ITransaction getTransaction()
Returns the transactional view (ITransaction) which is the scope of the commit operation represented by this CommitContext.

Since:
4.0

getBranchPoint

CDOBranchPoint getBranchPoint()
Returns the branch ID and timestamp of this commit operation.

Since:
3.0

getPreviousTimeStamp

long getPreviousTimeStamp()
Since:
4.0

getUserID

String getUserID()
Since:
3.0

getCommitComment

String getCommitComment()
Since:
3.0

isAutoReleaseLocksEnabled

boolean isAutoReleaseLocksEnabled()
Since:
3.0

getPackageRegistry

org.eclipse.emf.cdo.spi.common.model.InternalCDOPackageRegistry getPackageRegistry()
Returns the temporary, transactional package manager associated with the commit operation represented by this CommitContext. In addition to the packages registered with the session this package manager also contains the new packages that are part of this commit operation.


getNewPackageUnits

org.eclipse.emf.cdo.spi.common.model.InternalCDOPackageUnit[] getNewPackageUnits()
Returns an array of the new package units that are part of the commit operation represented by this CommitContext.


getNewObjects

org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision[] getNewObjects()
Returns an array of the new objects that are part of the commit operation represented by this CommitContext.


getDirtyObjects

org.eclipse.emf.cdo.spi.common.revision.InternalCDORevision[] getDirtyObjects()
Returns an array of the dirty objects that are part of the commit operation represented by this CommitContext.


getDirtyObjectDeltas

org.eclipse.emf.cdo.spi.common.revision.InternalCDORevisionDelta[] getDirtyObjectDeltas()
Returns an array of the dirty object deltas that are part of the commit operation represented by this CommitContext.


getDetachedObjects

CDOID[] getDetachedObjects()
Returns an array of the removed object that are part of the commit operation represented by this CommitContext.

Since:
2.0

getDetachedObjectTypes

Map<CDOID,EClass> getDetachedObjectTypes()
Returns a map with an EClass value per CDOID type.

Since:
4.0

getLobs

ExtendedDataInputStream getLobs()
Returns a stream that all lobs can be read from. The format of the data delivered through the stream is:

  1. int: the number of lobs to be read from the stream.
  2. The following data can be read from the stream in a loop with one iteration per lob in the stream:
    1. int + byte[]: the id of the lob (prepended by the size of the id).
    2. long: the size of the lob. The foollowing interpretation applies:
      • A positive size indicates a blob and means the number of bytes that can be read.
      • A negative size indicates a clob and means the number of characters that can be read.

Since:
4.0

getIDMappings

Map<CDOID,CDOID> getIDMappings()
Returns an unmodifiable map from all temporary IDs to their persistent counter parts.


createCommitInfo

CDOCommitInfo createCommitInfo()
Since:
4.0

getRollbackMessage

String getRollbackMessage()
Since:
3.0

getXRefs

List<CDOIDReference> getXRefs()
Since:
4.0

getPostCommmitLockStates

List<RWOLockManager.LockState<Object,IView>> getPostCommmitLockStates()
Since:
4.1


Copyright (c) 2004 - 2011 Eike Stepper (Berlin, Germany) and others.