/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2007, Red Hat Middleware LLC or third-party contributors as
* indicated by the @author tags or express copyright attribution
* statements applied by the authors. All third-party contributions are
* distributed under license by Red Hat Middleware LLC.
*
* This copyrighted material is made available to anyone wishing to use, modify,
* copy, or redistribute it subject to the terms and conditions of the GNU
* Lesser General Public License, as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
* for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this distribution; if not, write to:
* Free Software Foundation, Inc.
* 51 Franklin Street, Fifth Floor
* Boston, MA 02110-1301 USA
*/
package org.hibernate.cache.jbc;
import java.util.Properties;
import org.hibernate.cache.CacheDataDescription;
import org.hibernate.cache.CacheException;
import org.hibernate.cache.CollectionRegion;
import org.hibernate.cache.EntityRegion;
import org.hibernate.cache.QueryResultsRegion;
import org.hibernate.cache.RegionFactory;
import org.hibernate.cache.TimestampsRegion;
import org.hibernate.cache.access.AccessType;
import org.hibernate.cache.jbc.builder.JndiSharedCacheInstanceManager;
import org.hibernate.cache.jbc.builder.SharedCacheInstanceManager;
import org.hibernate.cache.jbc.collection.CollectionRegionImpl;
import org.hibernate.cache.jbc.entity.EntityRegionImpl;
import org.hibernate.cache.jbc.query.QueryResultsRegionImpl;
import org.hibernate.cache.jbc.timestamp.TimestampsRegionImpl;
import org.hibernate.cfg.Environment;
import org.hibernate.cfg.Settings;
import org.hibernate.util.PropertiesHelper;
import org.jboss.cache.DefaultCacheFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* {@link RegionFactory} that uses one or more JBoss Cache instances for
* caching entities, collections, queries and timestamps. How the factory
* obtains a reference to the needed JBoss Cache instance(s) is determined
* by the injected {@link CacheInstanceManager}.
* <p>
* By default uses {@link SharedCacheInstanceManager} as its
* {@link #getCacheInstanceManager() CacheInstanceManager}.
* Basically, this uses a single shared JBoss Cache for entities, collections,
* queries and timestamps. The JBoss Cache instance is created by the
* JBC {@link DefaultCacheFactory} using the resource identified by the
* {@link JndiSharedCacheInstanceManager#CACHE_RESOURCE_PROP}
* configuration property.
* </p>
* <p>
* Also exposes an overloaded constructor that allows injection of different
* <code>CacheInstanceManager</code> implementations.
* </p>
*
* @deprecated Favor Infinispan integration; see HHH-5489 for details.
*
* @author Steve Ebersole
* @author Brian Stansberry
*/
@Deprecated
public class JBossCacheRegionFactory implements RegionFactory {
private static final Logger log = LoggerFactory.getLogger( JBossCacheRegionFactory.class );
private CacheInstanceManager cacheInstanceManager;
/**
* FIXME Per the RegionFactory class Javadoc, this constructor version
* should not be necessary.
*
* @param props The configuration properties
*/
public JBossCacheRegionFactory(Properties props) {
this();
}
/**
* Create a new JBossCacheRegionFactory.
*/
public JBossCacheRegionFactory() {
log.warn( "Integration with JBossCache is deprecated in favor of Infinispan" );
}
/**
* Create a new JBossCacheRegionFactory that uses the provided
* {@link CacheInstanceManager}.
*
* @param cacheInstanceManager The contract for how we get JBC cache instances.
*/
public JBossCacheRegionFactory(CacheInstanceManager cacheInstanceManager) {
this.cacheInstanceManager = cacheInstanceManager;
log.warn( "Integration with JBossCache is deprecated in favor of Infinispan" );
}
public CacheInstanceManager getCacheInstanceManager() {
return cacheInstanceManager;
}
public void start(Settings settings, Properties properties) throws CacheException {
if (cacheInstanceManager == null) {
cacheInstanceManager = new SharedCacheInstanceManager();
}
cacheInstanceManager.start(settings, properties);
}
public void stop() {
if (cacheInstanceManager != null) {
cacheInstanceManager.stop();
}
}
public boolean isMinimalPutsEnabledByDefault() {
return true;
}
public AccessType getDefaultAccessType() {
return AccessType.TRANSACTIONAL;
}
public long nextTimestamp() {
return System.currentTimeMillis() / 100;
}
public EntityRegion buildEntityRegion(String regionName, Properties properties, CacheDataDescription metadata)
throws CacheException {
return new EntityRegionImpl(cacheInstanceManager.getEntityCacheInstance(), regionName,
getRegionPrefix(properties), metadata);
}
public CollectionRegion buildCollectionRegion(String regionName, Properties properties,
CacheDataDescription metadata) throws CacheException {
return new CollectionRegionImpl(cacheInstanceManager.getCollectionCacheInstance(), regionName,
getRegionPrefix(properties), metadata);
}
public QueryResultsRegion buildQueryResultsRegion(String regionName, Properties properties) throws CacheException {
return new QueryResultsRegionImpl(cacheInstanceManager.getQueryCacheInstance(), regionName,
getRegionPrefix(properties), properties);
}
public TimestampsRegion buildTimestampsRegion(String regionName, Properties properties) throws CacheException {
return new TimestampsRegionImpl(cacheInstanceManager.getTimestampsCacheInstance(), regionName,
getRegionPrefix(properties), properties);
}
public static String getRegionPrefix(Properties properties) {
return PropertiesHelper.getString(Environment.CACHE_REGION_PREFIX, properties, null);
}
}