Open Source Repository

Home /hibernate/hibernate-3.2.6.ga | Repository Home


org/hibernate/dialect/lock/UpdateLockingStrategy.java
package org.hibernate.dialect.lock;

import org.hibernate.persister.entity.Lockable;
import org.hibernate.LockMode;
import org.hibernate.HibernateException;
import org.hibernate.StaleObjectStateException;
import org.hibernate.JDBCException;
import org.hibernate.pretty.MessageHelper;
import org.hibernate.exception.JDBCExceptionHelper;
import org.hibernate.sql.Update;
import org.hibernate.engine.SessionImplementor;
import org.hibernate.engine.SessionFactoryImplementor;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import java.io.Serializable;
import java.sql.PreparedStatement;
import java.sql.SQLException;

/**
 * A locking strategy where the locks are obtained through update statements.
 <p/>
 * This strategy is not valid for read style locks.
 *
 @since 3.2
 *
 @author Steve Ebersole
 */
public class UpdateLockingStrategy implements LockingStrategy {
  private static final Log log = LogFactory.getLogUpdateLockingStrategy.class );

  private final Lockable lockable;
  private final LockMode lockMode;
  private final String sql;

  /**
   * Construct a locking strategy based on SQL UPDATE statements.
   *
   @param lockable The metadata for the entity to be locked.
   @param lockMode Indictates the type of lock to be acquired.  Note that
   * read-locks are not valid for this strategy.
   */
  public UpdateLockingStrategy(Lockable lockable, LockMode lockMode) {
    this.lockable = lockable;
    this.lockMode = lockMode;
    if lockMode.lessThanLockMode.UPGRADE ) ) {
      throw new HibernateException"[" + lockMode + "] not valid for update statement" );
    }
    if !lockable.isVersioned() ) {
      log.warn"write locks via update not supported for non-versioned entities [" + lockable.getEntityName() "]" );
      this.sql = null;
    }
    else {
      this.sql = generateLockString();
    }
  }

  /**
   @see LockingStrategy#lock
   */
  public void lock(
      Serializable id,
          Object version,
          Object object,
          SessionImplementor sessionthrows StaleObjectStateException, JDBCException {
    if !lockable.isVersioned() ) {
      throw new HibernateException"write locks via update not supported for non-versioned entities [" + lockable.getEntityName() "]" );
    }
    // todo : should we additionally check the current isolation mode explicitly?
    SessionFactoryImplementor factory = session.getFactory();
    try {
      PreparedStatement st = session.getBatcher().prepareSelectStatementsql );
      try {
        lockable.getVersionType().nullSafeSetst, version, 1, session );
        int offset = 2;

        lockable.getIdentifierType().nullSafeSetst, id, offset, session );
        offset += lockable.getIdentifierType().getColumnSpanfactory );

        if lockable.isVersioned() ) {
          lockable.getVersionType().nullSafeSetst, version, offset, session );
        }

        int affected = st.executeUpdate();
        if affected < ) {
          factory.getStatisticsImplementor().optimisticFailurelockable.getEntityName() );
          throw new StaleObjectStateExceptionlockable.getEntityName(), id );
        }

      }
      finally {
        session.getBatcher().closeStatementst );
      }

    }
    catch SQLException sqle ) {
      throw JDBCExceptionHelper.convert(
          session.getFactory().getSQLExceptionConverter(),
              sqle,
              "could not lock: " + MessageHelper.infoStringlockable, id, session.getFactory() ),
              sql
      );
    }
  }

  protected String generateLockString() {
    SessionFactoryImplementor factory = lockable.getFactory();
    Update update = new Updatefactory.getDialect() );
    update.setTableNamelockable.getRootTableName() );
    update.setPrimaryKeyColumnNameslockable.getRootTableIdentifierColumnNames() );
    update.setVersionColumnNamelockable.getVersionColumnName() );
    update.addColumnlockable.getVersionColumnName() );
    if factory.getSettings().isCommentsEnabled() ) {
      update.setCommentlockMode + " lock " + lockable.getEntityName() );
    }
    return update.toStatementString();
  }

  protected LockMode getLockMode() {
    return lockMode;
  }
}