/*
* JBoss, Home of Professional Open Source.
* Copyright 2006, Red Hat Middleware LLC, and individual contributors
* as indicated by the @author tags. See the copyright.txt file in the
* distribution for a full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.hibernate.jbc.cacheprovider;
import java.util.Properties;
import javax.management.ObjectName;
import javax.transaction.TransactionManager;
import org.hibernate.cache.Cache;
import org.hibernate.cache.CacheException;
import org.hibernate.cache.CacheProvider;
import org.jboss.cache.TreeCache;
import org.jboss.cache.TreeCacheMBean;
import org.jboss.logging.Logger;
import org.jboss.mx.util.MBeanProxyExt;
import org.jboss.mx.util.MBeanServerLocator;
import org.jboss.tm.TransactionManagerLocator;
/**
* Support for integration as a 2nd level cache with an already existing
* JBoss Cache (TreeCache) instance. The ObjectName of the cache is
* provided via the <code>hibernate.treecache.mbean.object_name</code>
* configuration property.
* <p/>
* This class supports both optimistic and pessimistic locking, providing
* instances of <code>org.hibernate.cache.OptimisticCache</code> if the
* underlying JBoss Cache is configured for optimistic locking.
*
* @author Gavin King
* @author Brian Stansberry
* @author <a href="mailto:galder.zamarreno@jboss.com">Galder Zamarreno</a>
*/
public class TreeCacheProvider
extends org.hibernate.cache.TreeCacheProvider
implements CacheProvider
{
private static final Logger log = Logger.getLogger(TreeCacheProvider.class);
private org.jboss.cache.TreeCache cache;
private boolean optimistic;
/**
* Construct and configure the Cache representation of a named cache region.
*
* @param regionName the name of the cache region
* @param properties configuration settings
* @return The Cache representation of the named cache region. If the
* underlying JBoss Cache is configured for optimistic locking,
* the returned object will also implement org.hibernate.cache.OptimisticCache.
* @throws org.hibernate.cache.CacheException
* Indicates an error building the cache region.
*/
public Cache buildCache(String regionName, Properties properties) throws CacheException
{
CacheProperties cacheProperties = new CacheProperties(properties);
if (optimistic)
{
return new OptimisticJBCCache(cache, regionName, cacheProperties);
}
else
{
/* removed dependency on ejb3's TxUtil */
return new JBCCache(cache, regionName, cacheProperties, getTransactionManager(properties));
}
}
public boolean isMinimalPutsEnabledByDefault()
{
return true;
}
public long nextTimestamp()
{
return System.currentTimeMillis() / 100;
}
/**
* Find the underlying JBoss Cache TreeCache instance.
*
* @param properties All current config settings.
* If {@link #HIBERNATE_CACHE_OBJECT_NAME_PROPERTY} is provided,
* the value will be the expected name of the cache; otherwise
* {@link #DEFAULT_MBEAN_OBJECT_NAME} will be used.
* @throws org.hibernate.cache.CacheException
* Indicates a problem preparing cache for use.
*/
public void start(Properties properties)
{
CacheProperties cacheProperties = new CacheProperties(properties);
try
{
ObjectName mbeanObjectName = new ObjectName(cacheProperties.getCacheObjectName());
TreeCacheMBean mbean = (TreeCacheMBean) MBeanProxyExt.create(TreeCacheMBean.class, mbeanObjectName, MBeanServerLocator.locateJBoss());
cache = mbean.getInstance();
if ("OPTIMISTIC".equals(cache.getNodeLockingScheme()))
{
optimistic = true;
log.debug("JBoss Cache is configured for optimistic locking; " +
"provided Cache implementations will also implement OptimisticCache");
}
}
catch (Exception e)
{
throw new CacheException(e);
}
}
public void stop()
{
}
public boolean isOptimistic()
{
return optimistic;
}
public TreeCache getUnderlyingCache()
{
return cache;
}
protected TransactionManager getTransactionManager(Properties properties)
{
return TransactionManagerLocator.getInstance().locate();
}
}