org.hibernate.ogm.dialect.optimisticlock.spi

Interface OptimisticLockingAwareGridDialect

All Superinterfaces:

GridDialect, Serializable, Service

All Known Implementing Classes:

BatchOperationsDelegator, ForwardingGridDialect, GridDialectLogger, InvocationCollectingGridDialect, MongoDBDialect

public interface OptimisticLockingAwareGridDialect
extends GridDialect

A GridDialect facet to be implemented by those stores which support finding and altering versioned records in an atomic fashion.

Author:

Gunnar Morling

Method Summary

Modifier and Type	Method and Description
boolean	removeTupleWithOptimisticLock(EntityKey entityKey, Tuple oldLockState, TupleContext tupleContext) Removes the given tuple.
boolean	updateTupleWithOptimisticLock(EntityKey entityKey, Tuple oldLockState, Tuple tuple, TupleContext tupleContext) Updates the given tuple.

Methods inherited from interface org.hibernate.ogm.dialect.spi.GridDialect

createAssociation, createTuple, forEachTuple, getAssociation, getDuplicateInsertPreventionStrategy, getLockingStrategy, getTuple, insertOrUpdateAssociation, insertOrUpdateTuple, isStoredInEntityStructure, nextValue, overrideType, removeAssociation, removeTuple, supportsSequences, usesNavigationalInformationForInverseSideOfAssociations

Method Detail

updateTupleWithOptimisticLock

boolean updateTupleWithOptimisticLock(EntityKey entityKey,
                                      Tuple oldLockState,
                                      Tuple tuple,
                                      TupleContext tupleContext)

Updates the given tuple. Implementors are expected to perform the update only if the entity has the given old version in the datastore. Specifically, atomic "find and update" semantics should be applied.

Parameters:

entityKey - The key of the entity to save

oldLockState - A tuple with all those column values identifying the previous version of the record in the datastore. Implementations are expected to apply all the contained columns to select the record to be updated.

tuple - The entity column values to save

tupleContext - Provides additional meta-data useful for the tuple update

Returns:

true if the update succeeded, false otherwise (e.g. if the entity has been updated in the datastore in parallel, so it has a newer version then the given one).

removeTupleWithOptimisticLock

boolean removeTupleWithOptimisticLock(EntityKey entityKey,
                                      Tuple oldLockState,
                                      TupleContext tupleContext)

Removes the given tuple. Implementors are expected to perform the delete only if the entity has the given old version in the datastore. Specifically, atomic "find and delete" semantics should be applied.

Parameters:

entityKey - The key of the entity to save

oldLockState - A tuple with all those column values identifying the previous version of the record in the datastore. Implementations are expected to apply all the contained columns to select the record to be removed.

tupleContext - Provides additional meta-data useful for the tuple removal

Returns:

true if the deletion succeeded, false otherwise (e.g. if the entity has been removed or updated in the datastore in parallel, so it has a newer version then the given one).