org.hibernate.dialect.lock

Class OptimisticLockingStrategy

java.lang.Object

org.hibernate.dialect.lock.OptimisticLockingStrategy

All Implemented Interfaces:

LockingStrategy

public class OptimisticLockingStrategy
extends java.lang.Object
implements LockingStrategy

An optimistic locking strategy that verifies that the version hasn't changed (prior to transaction commit).

This strategy is valid for LockMode.OPTIMISTIC

Since:

3.5

Author:

Scott Marlow

Constructor Summary

Constructors

Constructor and Description
OptimisticLockingStrategy(Lockable lockable, LockMode lockMode) Construct locking strategy.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

OptimisticLockingStrategy

public OptimisticLockingStrategy(Lockable lockable,
                         LockMode lockMode)

Construct locking strategy.

Parameters:

lockable - The metadata for the entity to be locked.

lockMode - Indictates the type of lock to be acquired.

Method Detail

lock

public void lock(java.io.Serializable id,
        java.lang.Object version,
        java.lang.Object object,
        int timeout,
        SessionImplementor session)
          throws StaleObjectStateException,
                 JDBCException

Description copied from interface: LockingStrategy

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

Specified by:

lock in interface LockingStrategy

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 optimistic lock failure as part of acquiring the requested database lock.

JDBCException - Indicates errors from the JDBC driver.

See Also:

LockingStrategy.lock(java.io.Serializable, java.lang.Object, java.lang.Object, int, org.hibernate.engine.SessionImplementor)

getLockMode

protected LockMode getLockMode()