Interface IStoreAccessor.CommitContext

All Superinterfaces:
CDORevisionProvider
All Known Subinterfaces:
InternalCommitContext
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
Author:
Eike Stepper
No Implement
This interface is not intended to be implemented by clients.
No Extend
This interface is not intended to be extended by clients.
  • Method Details

    • 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
    • getCommitMergeSource

      CDOBranchPoint getCommitMergeSource()
      Since:
      4.6
    • getLastUpdateTime

      long getLastUpdateTime()
      Since:
      4.2
    • getPackageRegistry

      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.
    • isClearResourcePathCache

      boolean isClearResourcePathCache()
      Since:
      4.2
    • getSecurityImpact

      byte getSecurityImpact()
      Since:
      4.3
    • isUsingEcore

      boolean isUsingEcore()
      Since:
      4.2
    • isUsingEtypes

      boolean isUsingEtypes()
      Since:
      4.2
    • getNewPackageUnits

      InternalCDOPackageUnit[] getNewPackageUnits()
      Returns an array of the new package units that are part of the commit operation represented by this CommitContext.
    • getNewObjects

      InternalCDORevision[] getNewObjects()
      Returns an array of the new objects that are part of the commit operation represented by this CommitContext.
    • getDirtyObjects

      InternalCDORevision[] getDirtyObjects()
      Returns an array of the dirty objects that are part of the commit operation represented by this CommitContext.
    • getDirtyObjectDeltas

      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
    • getDetachedObjectVersions

      CDOBranchVersion[] getDetachedObjectVersions()
      Since:
      4.2
    • getOldRevisions

      Map<CDOID,InternalCDORevision> getOldRevisions()
      Since:
      4.6
    • getNewRevisions

      Map<CDOID,InternalCDORevision> getNewRevisions()
      Since:
      4.6
    • getOriginalCommmitData

      CDOProtocol.CommitData getOriginalCommmitData()
      Since:
      4.8
    • getLobs

      org.eclipse.net4j.util.io.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 following 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
    • getLocksOnNewObjects

      CDOLockState[] getLocksOnNewObjects()
      Returns an array of the locks on the new objects that are part of the commit operation represented by this CommitContext.
      Since:
      4.1
    • getIDsToUnlock

      CDOID[] getIDsToUnlock()
      Since:
      4.6
    • getIDMappings

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

      CDOCommitInfo createCommitInfo()
      Since:
      4.0
    • getRollbackReason

      byte getRollbackReason()
      Since:
      4.2
      See Also:
    • getRollbackMessage

      String getRollbackMessage()
      Since:
      3.0
    • getXRefs

      List<CDOIDReference> getXRefs()
      Since:
      4.0
    • getLockDeltas

      List<CDOLockDelta> getLockDeltas()
      Since:
      4.15
    • getLockStates

      List<CDOLockState> getLockStates()
      Since:
      4.15
    • getData

      <T> T getData(Object key)
      Since:
      4.3
    • setData

      <T> T setData(Object key, T data)
      Since:
      4.3
    • modify

      Since:
      4.10
    • isAutoReleaseLocksEnabled

      @Deprecated boolean isAutoReleaseLocksEnabled()
      Deprecated.
      As of 4.5 no longer supported. See getIDsToUnlock().
      Since:
      3.0
    • getPostCommmitLockStates

      @Deprecated List<org.eclipse.net4j.util.concurrent.RWOLockManager.LockState<Object,IView>> getPostCommmitLockStates()
      Deprecated.
      As of 4.15 use getLockStates().
      Since:
      4.1