org.hibernate.cache.ehcache.internal.regions.EhcacheDataRegion Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of hibernate-ehcache
Integration for using Ehcache 2.x as a Hibernate second-level-cache provider
There is a newer version: 6.0.0.Alpha7
/*
 * Hibernate, Relational Persistence for Idiomatic Java
 *
 * License: GNU Lesser General Public License (LGPL), version 2.1 or later.
 * See the lgpl.txt file in the root directory or .
 */

package org.hibernate.cache.ehcache.internal.regions;

import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

import net.sf.ehcache.Ehcache;
import net.sf.ehcache.constructs.nonstop.NonStopCacheException;
import net.sf.ehcache.util.Timestamper;

import org.hibernate.cache.CacheException;
import org.hibernate.cache.ehcache.EhCacheMessageLogger;
import org.hibernate.cache.ehcache.internal.nonstop.HibernateNonstopCacheExceptionHandler;
import org.hibernate.cache.ehcache.internal.strategy.EhcacheAccessStrategyFactory;
import org.hibernate.cache.spi.Region;

import org.jboss.logging.Logger;

/**
 * An Ehcache specific data region implementation.
 * 
 * This class is the ultimate superclass for all Ehcache Hibernate cache regions.
 *
 * @author Chris Dennis
 * @author Greg Luck
 * @author Emmanuel Bernard
 * @author Abhishek Sanoujam
 * @author Alex Snaps
 */
public abstract class EhcacheDataRegion implements Region {
	private static final EhCacheMessageLogger LOG = Logger.getMessageLogger(
			EhCacheMessageLogger.class,
			EhcacheDataRegion.class.getName()
	);
	private static final String CACHE_LOCK_TIMEOUT_PROPERTY = "net.sf.ehcache.hibernate.cache_lock_timeout";
	private static final int DEFAULT_CACHE_LOCK_TIMEOUT = 60000;

	private final Ehcache cache;
	private final EhcacheAccessStrategyFactory accessStrategyFactory;
	private final int cacheLockTimeout;


	/**
	 * Create a Hibernate data region backed by the given Ehcache instance.
	 */
	EhcacheDataRegion(EhcacheAccessStrategyFactory accessStrategyFactory, Ehcache cache, Properties properties) {
		this.accessStrategyFactory = accessStrategyFactory;
		this.cache = cache;
		final String timeout = properties.getProperty(
				CACHE_LOCK_TIMEOUT_PROPERTY,
				Integer.toString( DEFAULT_CACHE_LOCK_TIMEOUT )
		);
		this.cacheLockTimeout = Timestamper.ONE_MS * Integer.decode( timeout );
	}

	/**
	 * Ehcache instance backing this Hibernate data region.
	 */
	protected Ehcache getCache() {
		return cache;
	}

	/**
	 * The {@link org.hibernate.cache.ehcache.internal.strategy.EhcacheAccessStrategyFactory} used for creating
	 * various access strategies
	 */
	protected EhcacheAccessStrategyFactory getAccessStrategyFactory() {
		return accessStrategyFactory;
	}

	/**
	 * Return the Ehcache instance backing this Hibernate data region.
	 *
	 * @return The underlying ehcache cache
	 */
	public Ehcache getEhcache() {
		return getCache();
	}

	@Override
	public String getName() {
		return getCache().getName();
	}

	@Override
	public void destroy() throws CacheException {
		try {
			getCache().getCacheManager().removeCache( getCache().getName() );
		}
		catch (IllegalStateException e) {
			//When Spring and Hibernate are both involved this will happen in normal shutdown operation.
			//Do not throw an exception, simply log this one.
			LOG.debug( "This can happen if multiple frameworks both try to shutdown ehcache", e );
		}
		catch (net.sf.ehcache.CacheException e) {
			if ( e instanceof NonStopCacheException ) {
				HibernateNonstopCacheExceptionHandler.getInstance()
						.handleNonstopCacheException( (NonStopCacheException) e );
			}
			else {
				throw new CacheException( e );
			}
		}
	}

	@Override
	public long getSizeInMemory() {
		try {
			return getCache().calculateInMemorySize();
		}
		catch (Throwable t) {
			if ( t instanceof NonStopCacheException ) {
				HibernateNonstopCacheExceptionHandler.getInstance()
						.handleNonstopCacheException( (NonStopCacheException) t );
			}
			return -1;
		}
	}

	@Override
	public long getElementCountInMemory() {
		try {
			return getCache().getMemoryStoreSize();
		}
		catch (net.sf.ehcache.CacheException ce) {
			if ( ce instanceof NonStopCacheException ) {
				HibernateNonstopCacheExceptionHandler.getInstance()
						.handleNonstopCacheException( (NonStopCacheException) ce );
				return -1;
			}
			else {
				throw new CacheException( ce );
			}
		}
	}

	@Override
	public long getElementCountOnDisk() {
		try {
			return getCache().getDiskStoreSize();
		}
		catch (net.sf.ehcache.CacheException ce) {
			if ( ce instanceof NonStopCacheException ) {
				HibernateNonstopCacheExceptionHandler.getInstance()
						.handleNonstopCacheException( (NonStopCacheException) ce );
				return -1;
			}
			else {
				throw new CacheException( ce );
			}
		}
	}

	@Override
	public Map toMap() {
		try {
			final Map result = new HashMap();
			for ( Object key : getCache().getKeys() ) {
				result.put( key, getCache().get( key ).getObjectValue() );
			}
			return result;
		}
		catch (Exception e) {
			if ( e instanceof NonStopCacheException ) {
				HibernateNonstopCacheExceptionHandler.getInstance()
						.handleNonstopCacheException( (NonStopCacheException) e );
				return Collections.emptyMap();
			}
			else {
				throw new CacheException( e );
			}
		}
	}

	@Override
	public long nextTimestamp() {
		return Timestamper.next();
	}

	@Override
	public int getTimeout() {
		return cacheLockTimeout;
	}

	@Override
	public boolean contains(Object key) {
		return getCache().isKeyInCache( key );
	}

}