[jboss-cvs] JBossAS SVN: r77605 - projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider.

jboss-cvs-commits at lists.jboss.org jboss-cvs-commits at lists.jboss.org
Thu Aug 28 12:09:37 EDT 2008


Author: bstansberry at jboss.com
Date: 2008-08-28 12:09:36 -0400 (Thu, 28 Aug 2008)
New Revision: 77605

Added:
   projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/JmxBoundTreeCacheProvider.java
   projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/OptimisticJmxBoundTreeCacheProvider.java
Log:
[JBCLUSTER-206] Rename JMX-based providers

Copied: projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/JmxBoundTreeCacheProvider.java (from rev 77603, projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/TreeCacheProvider.java)
===================================================================
--- projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/JmxBoundTreeCacheProvider.java	                        (rev 0)
+++ projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/JmxBoundTreeCacheProvider.java	2008-08-28 16:09:36 UTC (rev 77605)
@@ -0,0 +1,162 @@
+/*
+ * 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.hibernate.transaction.TransactionManagerLookup;
+import org.hibernate.transaction.TransactionManagerLookupFactory;
+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 at jboss.com">Galder Zamarreno</a>
+ */
+public class JmxBoundTreeCacheProvider 
+   extends org.hibernate.cache.TreeCacheProvider
+   implements CacheProvider
+{   
+   private static final Logger log = Logger.getLogger(JmxBoundTreeCacheProvider.class);
+   
+   private org.jboss.cache.TreeCache cache;
+   private boolean optimistic;
+   private TransactionManager transactionManager;
+   
+   /**
+    * 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)
+   {
+      if (transactionManager == null)
+      {
+         TransactionManagerLookup transactionManagerLookup = TransactionManagerLookupFactory.getTransactionManagerLookup(properties);
+         if (transactionManagerLookup!=null) {
+             transactionManager = transactionManagerLookup.getTransactionManager(properties);
+         }
+         else
+         {
+            transactionManager = TransactionManagerLocator.getInstance().locate();
+         }
+      }
+      return transactionManager;
+   }
+}

Copied: projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/OptimisticJmxBoundTreeCacheProvider.java (from rev 77602, projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/OptimisticTreeCacheProvider.java)
===================================================================
--- projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/OptimisticJmxBoundTreeCacheProvider.java	                        (rev 0)
+++ projects/cluster/hibernate-jbc-cacheprovider/trunk/src/main/java/org/jboss/hibernate/jbc/cacheprovider/OptimisticJmxBoundTreeCacheProvider.java	2008-08-28 16:09:36 UTC (rev 77605)
@@ -0,0 +1,43 @@
+/*
+ * JBoss, the OpenSource J2EE webOS
+ * 
+ * Distributable under LGPL license.
+ * See terms of license at gnu.org.
+ */
+package org.jboss.hibernate.jbc.cacheprovider;
+
+import java.util.Properties;
+
+import org.hibernate.cache.CacheException;
+import org.jboss.logging.Logger;
+
+/**
+ * Trivial {@link JmxBoundTreeCacheProvider} subclass that logs a warning in
+ * {@link #start(Properties) start} if the underlying JBoss Cache 
+ * is not configured for optimistic locking.  Like the superclass,
+ * will provide working Cache implementations whether JBoss Cache is
+ * configured for optimistic locking or not; the only added behavior
+ * is the logging of the warning if the JBoss Cache configuration doesn't 
+ * match the intent implied by the use of this class.
+ * 
+ * @author <a href="mailto:galder.zamarreno at jboss.com">Galder Zamarreno</a>
+ * @author Brian Stansberry
+ * @deprecated {@link JmxBoundTreeCacheProvider} supports both optimistic and pessimistic 
+ *             cache configurations.
+ */
+public class OptimisticJmxBoundTreeCacheProvider extends JmxBoundTreeCacheProvider 
+{
+   private static final Logger log = Logger.getLogger(OptimisticJmxBoundTreeCacheProvider.class);
+   
+   public void start(Properties properties) throws CacheException
+   {
+      super.start(properties);
+      
+      if (isOptimistic() == false)
+      {
+         log.warn("JBoss Cache is not configured for optimistic locking; " +
+         "provided Cache implementations therefore will not implement OptimisticCache");
+      }
+   }
+
+}




More information about the jboss-cvs-commits mailing list