Package org.eclipse.emf.cdo.server

# Schnittstelle IStoreAccessor.CommitContext

Alle Superschnittstellen:
  `CDORevisionProvider`

Alle bekannten Unterschnittstellen:
  `InternalCommitContext`

Umschließende Schnittstelle:
  `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.

Seit:
  2.0
Autor:
  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.

## Verschachtelte Klassen - Übersicht

Verschachtelte Klassen
Modifizierer und Typ
Schnittstelle
Beschreibung
`static interface`
`IStoreAccessor.CommitContext.ModificationContext`
A data and result context for the modifications in `modify(Consumer)`.

## Methodenübersicht

Modifizierer und Typ
Methode
Beschreibung
`CDOCommitInfo`
`createCommitInfo()`
`CDOBranchPoint`
`getBranchPoint()`
Returns the branch ID and timestamp of this commit operation.
`String`
`getCommitComment()`
`CDOBranchPoint`
`getCommitMergeSource()`
`Map<String,String>`
`getCommitProperties()`
`<T> T`
`getData(Object key)`
`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.
`CDOBranchVersion[]`
`getDetachedObjectVersions()`
`InternalCDORevisionDelta[]`
`getDirtyObjectDeltas()`
Returns an array of the dirty object deltas that are part of the commit operation represented by this `CommitContext`.
`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.
`CDOID[]`
`getIDsToUnlock()`
`long`
`getLastUpdateTime()`
`org.eclipse.net4j.util.io.ExtendedDataInputStream`
`getLobs()`
Returns a stream that all `lobs` can be read from.
`List<CDOLockDelta>`
`getLockDeltas()`
`CDOLockState[]`
`getLocksOnNewObjects()`
Returns an array of the locks on the new objects that are part of the commit operation represented by this `CommitContext`.
`List<CDOLockState>`
`getLockStates()`
`InternalCDORevision[]`
`getNewObjects()`
Returns an array of the new objects that are part of the commit operation represented by this `CommitContext`.
`InternalCDOPackageUnit[]`
`getNewPackageUnits()`
Returns an array of the new package units that are part of the commit operation represented by this `CommitContext`.
`Map<CDOID,InternalCDORevision>`
`getNewRevisions()`
`Map<CDOID,InternalCDORevision>`
`getOldRevisions()`
`CDOProtocol.CommitData`
`getOriginalCommmitData()`
`InternalCDOPackageRegistry`
`getPackageRegistry()`
Returns the temporary, transactional package manager associated with the commit operation represented by this `CommitContext`.
`List<org.eclipse.net4j.util.concurrent.RWOLockManager.LockState<Object,IView>>`
`getPostCommmitLockStates()`
Veraltet.
As of 4.15 use `getLockStates()`.
`long`
`getPreviousTimeStamp()`
`String`
`getRollbackMessage()`
`byte`
`getRollbackReason()`
`byte`
`getSecurityImpact()`
`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()`
Veraltet.
As of 4.5 no longer supported.
`boolean`
`isClearResourcePathCache()`
`boolean`
`isUsingEcore()`
`boolean`
`isUsingEtypes()`
`void`
`modify(Consumer<IStoreAccessor.CommitContext.ModificationContext> modifier)`
`<T> T`
`setData(Object key, T data)`

### Von Schnittstelle geerbte Methoden org.eclipse.emf.cdo.common.revision.CDORevisionProvider

`getRevision`

## Methodendetails

### getTransaction

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

Seit:
  4.0

### getBranchPoint

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

Seit:
  3.0

### getPreviousTimeStamp

long getPreviousTimeStamp()

Seit:
  4.0

### getUserID

String getUserID()

Seit:
  3.0

### getCommitComment

String getCommitComment()

Seit:
  3.0

### getCommitProperties

Map<String,String> getCommitProperties()

Seit:
  4.21

### getCommitMergeSource

CDOBranchPoint getCommitMergeSource()

Seit:
  4.6

### getLastUpdateTime

long getLastUpdateTime()

Seit:
  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()

Seit:
  4.2

### getSecurityImpact

byte getSecurityImpact()

Seit:
  4.3

### isUsingEcore

boolean isUsingEcore()

Seit:
  4.2

### isUsingEtypes

boolean isUsingEtypes()

Seit:
  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`.

Seit:
  2.0

### getDetachedObjectTypes

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

Seit:
  4.0

### getDetachedObjectVersions

CDOBranchVersion[] getDetachedObjectVersions()

Seit:
  4.2

### getOldRevisions

Map<CDOID,InternalCDORevision> getOldRevisions()

Seit:
  4.6

### getNewRevisions

Map<CDOID,InternalCDORevision> getNewRevisions()

Seit:
  4.6

### getOriginalCommmitData

CDOProtocol.CommitData getOriginalCommmitData()

Seit:
  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`.

Seit:
  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`.

Seit:
  4.1

### getIDsToUnlock

CDOID[] getIDsToUnlock()

Seit:
  4.6

### getIDMappings

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

### createCommitInfo

CDOCommitInfo createCommitInfo()

Seit:
  4.0

### getRollbackReason

byte getRollbackReason()

Seit:
  4.2
Siehe auch:
  - `CDOProtocolConstants`

### getRollbackMessage

String getRollbackMessage()

Seit:
  3.0

### getXRefs

List<CDOIDReference> getXRefs()

Seit:
  4.0

### getLockDeltas

List<CDOLockDelta> getLockDeltas()

Seit:
  4.15

### getLockStates

List<CDOLockState> getLockStates()

Seit:
  4.15

### getData

<T> T getData(Object key)

Seit:
  4.3

### setData

<T> T setData(Object key, T data)

Seit:
  4.3

### modify

void modify(Consumer<IStoreAccessor.CommitContext.ModificationContext> modifier)

Seit:
  4.10

### isAutoReleaseLocksEnabled

@Deprecated boolean isAutoReleaseLocksEnabled()
Veraltet.
As of 4.5 no longer supported. See `getIDsToUnlock()`.

Seit:
  3.0

### getPostCommmitLockStates

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

Seit:
  4.1