Open Source Repository

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


org/hibernate/cache/AbstractJndiBoundCacheProvider.java
// $Id: AbstractJndiBoundCacheProvider.java 6079 2005-03-16 06:01:18Z oneovthafew $
package org.hibernate.cache;

import java.util.Properties;

import javax.naming.Context;
import javax.naming.InitialContext;
import javax.naming.NamingException;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.hibernate.cfg.Environment;
import org.hibernate.util.NamingHelper;
import org.hibernate.util.StringHelper;

/**
 * Support for CacheProvider implementations which are backed by caches bound
 * into JNDI namespace.
 *
 @author Steve Ebersole
 */
public abstract class AbstractJndiBoundCacheProvider implements CacheProvider {

  private static final Log log = LogFactory.getLogAbstractJndiBoundCacheProvider.class );
  private Object cache;

  protected void prepare(Properties properties) {
    // Do nothing; subclasses may override.
  }

  protected void release() {
    // Do nothing; subclasses may override.
  }

  /**
   * Callback to perform any necessary initialization of the underlying cache implementation during SessionFactory
   * construction.
   *
   @param properties current configuration settings.
   */
  public final void start(Properties propertiesthrows CacheException {
    String jndiNamespace = properties.getPropertyEnvironment.CACHE_NAMESPACE );
    if StringHelper.isEmptyjndiNamespace ) ) {
      throw new CacheException"No JNDI namespace specified for cache" );
    }
    cache = locateCachejndiNamespace, NamingHelper.getJndiPropertiesproperties ) );
    prepareproperties );
  }

  /**
   * Callback to perform any necessary cleanup of the underlying cache
   * implementation during SessionFactory.close().
   */
  public final void stop() {
    release();
    cache = null;
  }

  private Object locateCache(String jndiNamespace, Properties jndiProperties) {

    Context ctx = null;
    try {
      ctx = new InitialContextjndiProperties );
      return ctx.lookupjndiNamespace );
    }
    catch (NamingException ne) {
      String msg = "Unable to retreive Cache from JNDI [" + jndiNamespace + "]";
      log.infomsg, ne );
      throw new CacheExceptionmsg );
    }
    finally {
      if ctx != null ) {
        try {
          ctx.close();
        }
        catchNamingException ne ) {
          log.info"Unable to release initial context", ne );
        }
      }
    }
  }
  
  public Object getCache() {
    return cache;
  }
}