org.hibernate.cache.ehcache.internal.util.HibernateEhcacheUtils 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.util;

import java.net.URL;

import net.sf.ehcache.Ehcache;
import net.sf.ehcache.config.CacheConfiguration;
import net.sf.ehcache.config.Configuration;
import net.sf.ehcache.config.ConfigurationFactory;
import net.sf.ehcache.config.NonstopConfiguration;
import net.sf.ehcache.config.TerracottaConfiguration;
import net.sf.ehcache.config.TerracottaConfiguration.ValueMode;
import net.sf.ehcache.config.TimeoutBehaviorConfiguration.TimeoutBehaviorType;

import org.hibernate.cache.CacheException;
import org.hibernate.cache.ehcache.EhCacheMessageLogger;

import org.jboss.logging.Logger;


/**
 * Copy of Ehcache utils into Hibernate code base
 *
 * @author Chris Dennis
 * @author Abhishek Sanoujam
 * @author Alex Snaps
 */
public final class HibernateEhcacheUtils {
	private static final EhCacheMessageLogger LOG = Logger.getMessageLogger(
			EhCacheMessageLogger.class,
			HibernateEhcacheUtils.class.getName()
	);

	private HibernateEhcacheUtils() {
	}

	/**
	 * Create a cache manager configuration from the supplied url, correcting it for Hibernate compatibility.
	 * 
	 * Currently "correcting" for Hibernate compatibility means simply switching any identity based value modes
	 * to serialization.
	 *
	 * @param url The url to load the config from
	 *
	 * @return The Ehcache Configuration object
	 */
	public static Configuration loadAndCorrectConfiguration(URL url) {
		final Configuration config = ConfigurationFactory.parseConfiguration( url );
		
		// EHC-875 / HHH-6576
		if ( config == null ) {
			return null;
		}
		
		if ( config.getDefaultCacheConfiguration() != null
				&& config.getDefaultCacheConfiguration().isTerracottaClustered() ) {
			if ( ValueMode.IDENTITY
					.equals( config.getDefaultCacheConfiguration().getTerracottaConfiguration().getValueMode() ) ) {
				LOG.incompatibleCacheValueMode();
				config.getDefaultCacheConfiguration()
						.getTerracottaConfiguration()
						.setValueMode( ValueMode.SERIALIZATION.name() );
			}
			setupHibernateTimeoutBehavior(
					config.getDefaultCacheConfiguration()
							.getTerracottaConfiguration()
							.getNonstopConfiguration()
			);
		}

		for ( CacheConfiguration cacheConfig : config.getCacheConfigurations().values() ) {
			if ( cacheConfig.isTerracottaClustered() ) {
				if ( ValueMode.IDENTITY.equals( cacheConfig.getTerracottaConfiguration().getValueMode() ) ) {
					LOG.incompatibleCacheValueModePerCache( cacheConfig.getName() );
					cacheConfig.getTerracottaConfiguration().setValueMode( ValueMode.SERIALIZATION.name() );
				}
				setupHibernateTimeoutBehavior( cacheConfig.getTerracottaConfiguration().getNonstopConfiguration() );
			}
		}
		return config;
	}

	private static void setupHibernateTimeoutBehavior(NonstopConfiguration nonstopConfig) {
		nonstopConfig.getTimeoutBehavior().setType( TimeoutBehaviorType.EXCEPTION.getTypeName() );
	}

	/**
	 * Validates that the supplied Ehcache instance is valid for use as a Hibernate cache.
	 *
	 * @param cache The cache instance
	 *
	 * @throws CacheException If any explicit settings on the cache are not validate
	 */
	public static void validateEhcache(Ehcache cache) throws CacheException {
		final CacheConfiguration cacheConfig = cache.getCacheConfiguration();

		if ( cacheConfig.isTerracottaClustered() ) {
			final TerracottaConfiguration tcConfig = cacheConfig.getTerracottaConfiguration();
			switch ( tcConfig.getValueMode() ) {
				case IDENTITY: {
					throw new CacheException(
							"The clustered Hibernate cache " + cache.getName() + " is using IDENTITY value mode.\n"
									+ "Identity value mode cannot be used with Hibernate cache regions."
					);
				}
				case SERIALIZATION:
				default: {
					// this is the recommended valueMode
					break;
				}
			}
		}
	}
}