org.hibernate.dialect.lock

Interface LockingStrategy

All Known Implementing Classes:

AbstractSelectLockingStrategy, OptimisticForceIncrementLockingStrategy, OptimisticLockingStrategy, PessimisticForceIncrementLockingStrategy, PessimisticReadSelectLockingStrategy, PessimisticReadUpdateLockingStrategy, PessimisticWriteSelectLockingStrategy, PessimisticWriteUpdateLockingStrategy, SelectLockingStrategy, UpdateLockingStrategy

public interface LockingStrategy

A strategy abstraction for how locks are obtained in the underlying database.

All locking provided implementations assume the underlying database supports (and that the connection is in) at least read-committed transaction isolation. The most glaring exclusion to this is HSQLDB which only offers support for READ_UNCOMMITTED isolation.

Since:

3.2

Author:

Steve Ebersole

See Also:

Dialect.getLockingStrategy(org.hibernate.persister.entity.Lockable, org.hibernate.LockMode)

Method Summary

Modifier and Type	Method and Description
void	lock(Serializable id, Object version, Object object, int timeout, SharedSessionContractImplementor session) Acquire an appropriate type of lock on the underlying data that will endure until the end of the current transaction.

Method Detail

lock

void lock(Serializable id,
          Object version,
          Object object,
          int timeout,
          SharedSessionContractImplementor session)
   throws StaleObjectStateException,
          LockingStrategyException

Acquire an appropriate type of lock on the underlying data that will endure until the end of the current transaction.

Parameters:

id - The id of the row to be locked

version - The current version (or null if not versioned)

object - The object logically being locked (currently not used)

timeout - timeout in milliseconds, 0 = no wait, -1 = wait indefinitely

session - The session from which the lock request originated

Throws:

StaleObjectStateException - Indicates an inability to locate the database row as part of acquiring the requested lock.

LockingStrategyException - Indicates a failure in the lock attempt