mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-24 17:32:48 +00:00
Moving to root below branch label
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2005 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
220
source/java/org/alfresco/repo/cache/CacheTest.java
vendored
Normal file
220
source/java/org/alfresco/repo/cache/CacheTest.java
vendored
Normal file
@@ -0,0 +1,220 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.repo.cache;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
import javax.transaction.Status;
|
||||
import javax.transaction.UserTransaction;
|
||||
|
||||
import net.sf.ehcache.CacheManager;
|
||||
|
||||
import org.alfresco.service.ServiceRegistry;
|
||||
import org.alfresco.service.transaction.TransactionService;
|
||||
import org.alfresco.util.ApplicationContextHelper;
|
||||
import org.springframework.context.ApplicationContext;
|
||||
import org.springframework.context.support.ClassPathXmlApplicationContext;
|
||||
|
||||
import junit.framework.TestCase;
|
||||
|
||||
/**
|
||||
* @see org.alfresco.repo.cache.EhCacheAdapter
|
||||
*
|
||||
* @author Derek Hulley
|
||||
*/
|
||||
public class CacheTest extends TestCase
|
||||
{
|
||||
private static ApplicationContext ctx =new ClassPathXmlApplicationContext(
|
||||
new String[] {"classpath:cache-test-context.xml", ApplicationContextHelper.CONFIG_LOCATIONS[0]}
|
||||
);
|
||||
|
||||
private ServiceRegistry serviceRegistry;
|
||||
private SimpleCache<String, Serializable> standaloneCache;
|
||||
private SimpleCache<String, Serializable> backingCache;
|
||||
private SimpleCache<String, Serializable> transactionalCache;
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
@Override
|
||||
public void setUp() throws Exception
|
||||
{
|
||||
serviceRegistry = (ServiceRegistry) ctx.getBean(ServiceRegistry.SERVICE_REGISTRY);
|
||||
standaloneCache = (SimpleCache<String, Serializable>) ctx.getBean("ehCache1");
|
||||
backingCache = (SimpleCache<String, Serializable>) ctx.getBean("backingCache");
|
||||
transactionalCache = (SimpleCache<String, Serializable>) ctx.getBean("transactionalCache");
|
||||
}
|
||||
|
||||
public void testSetUp() throws Exception
|
||||
{
|
||||
CacheManager cacheManager = (CacheManager) ctx.getBean("ehCacheManager");
|
||||
assertNotNull(cacheManager);
|
||||
CacheManager cacheManagerCheck = (CacheManager) ctx.getBean("ehCacheManager");
|
||||
assertTrue(cacheManager == cacheManagerCheck);
|
||||
|
||||
assertNotNull(serviceRegistry);
|
||||
assertNotNull(backingCache);
|
||||
assertNotNull(standaloneCache);
|
||||
assertNotNull(transactionalCache);
|
||||
}
|
||||
|
||||
public void testEhcacheAdaptors() throws Exception
|
||||
{
|
||||
backingCache.put("A", "AAA");
|
||||
assertNull("Second cache should not have first's present", standaloneCache.get("A"));
|
||||
|
||||
assertEquals("AAA", backingCache.get("A"));
|
||||
|
||||
backingCache.remove("A");
|
||||
assertNull(backingCache.get("A"));
|
||||
}
|
||||
|
||||
public void testTransactionalCacheNoTxn() throws Exception
|
||||
{
|
||||
String key = "B";
|
||||
String value = "BBB";
|
||||
// no transaction - do a put
|
||||
transactionalCache.put(key, value);
|
||||
// check that the value appears in the backing cache, backingCache
|
||||
assertEquals("Backing cache not used for put when no transaction present", value, backingCache.get(key));
|
||||
|
||||
// remove the value from the backing cache and check that it is removed from the transaction cache
|
||||
backingCache.remove(key);
|
||||
assertNull("Backing cache not used for removed when no transaction present", transactionalCache.get(key));
|
||||
|
||||
// add value into backing cache
|
||||
backingCache.put(key, value);
|
||||
// remove it from the transactional cache
|
||||
transactionalCache.remove(key);
|
||||
// check that it is gone from the backing cache
|
||||
assertNull("Non-transactional remove didn't go to backing cache", backingCache.get(key));
|
||||
}
|
||||
|
||||
public void testTransactionalCacheWithTxn() throws Throwable
|
||||
{
|
||||
String newGlobalOne = "new_global_one";
|
||||
String newGlobalTwo = "new_global_two";
|
||||
String newGlobalThree = "new_global_three";
|
||||
String updatedTxnThree = "updated_txn_three";
|
||||
|
||||
// add item to global cache
|
||||
backingCache.put(newGlobalOne, newGlobalOne);
|
||||
backingCache.put(newGlobalTwo, newGlobalTwo);
|
||||
backingCache.put(newGlobalThree, newGlobalThree);
|
||||
|
||||
TransactionService transactionService = serviceRegistry.getTransactionService();
|
||||
UserTransaction txn = transactionService.getUserTransaction();
|
||||
// begin a transaction
|
||||
txn.begin();
|
||||
|
||||
try
|
||||
{
|
||||
// remove 1 from the cache
|
||||
transactionalCache.remove(newGlobalOne);
|
||||
assertFalse("Item was not removed from txn cache", transactionalCache.contains(newGlobalOne));
|
||||
assertNull("Get didn't return null", transactionalCache.get(newGlobalOne));
|
||||
assertTrue("Item was removed from backing cache", backingCache.contains(newGlobalOne));
|
||||
|
||||
// update 3 in the cache
|
||||
transactionalCache.put(updatedTxnThree, "XXX");
|
||||
assertEquals("Item not updated in txn cache", "XXX", transactionalCache.get(updatedTxnThree));
|
||||
assertFalse("Item was put into backing cache", backingCache.contains(updatedTxnThree));
|
||||
|
||||
// commit the transaction
|
||||
txn.commit();
|
||||
|
||||
// check that backing cache was updated with the in-transaction changes
|
||||
assertFalse("Item was not removed from backing cache", backingCache.contains(newGlobalOne));
|
||||
assertNull("Item could still be fetched from backing cache", backingCache.get(newGlobalOne));
|
||||
assertEquals("Item not updated in backing cache", "XXX", backingCache.get(updatedTxnThree));
|
||||
}
|
||||
catch (Throwable e)
|
||||
{
|
||||
if (txn.getStatus() == Status.STATUS_ACTIVE)
|
||||
{
|
||||
txn.rollback();
|
||||
}
|
||||
throw e;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Preloads the cache, then performs a simultaneous addition of N new values and
|
||||
* removal of the N preloaded values.
|
||||
*
|
||||
* @param cache
|
||||
* @param objectCount
|
||||
* @return Returns the time it took in <b>nanoseconds</b>.
|
||||
*/
|
||||
public long runPerformanceTestOnCache(SimpleCache<String, Serializable> cache, int objectCount)
|
||||
{
|
||||
// preload
|
||||
for (int i = 0; i < objectCount; i++)
|
||||
{
|
||||
String key = Integer.toString(i);
|
||||
Integer value = new Integer(i);
|
||||
cache.put(key, value);
|
||||
}
|
||||
|
||||
// start timer
|
||||
long start = System.nanoTime();
|
||||
for (int i = 0; i < objectCount; i++)
|
||||
{
|
||||
String key = Integer.toString(i);
|
||||
cache.remove(key);
|
||||
// add a new value
|
||||
key = Integer.toString(i + objectCount);
|
||||
Integer value = new Integer(i + objectCount);
|
||||
cache.put(key, value);
|
||||
}
|
||||
// stop
|
||||
long stop = System.nanoTime();
|
||||
|
||||
return (stop - start);
|
||||
}
|
||||
|
||||
/**
|
||||
* Tests a straight Ehcache adapter against a transactional cache both in and out
|
||||
* of a transaction. This is done repeatedly, pushing the count up.
|
||||
*/
|
||||
public void testPerformance() throws Exception
|
||||
{
|
||||
for (int i = 0; i < 5; i++)
|
||||
{
|
||||
int count = (int) Math.pow(10D, (double)i);
|
||||
|
||||
// test standalone
|
||||
long timePlain = runPerformanceTestOnCache(standaloneCache, count);
|
||||
|
||||
// do transactional cache in a transaction
|
||||
TransactionService transactionService = serviceRegistry.getTransactionService();
|
||||
UserTransaction txn = transactionService.getUserTransaction();
|
||||
txn.begin();
|
||||
long timeTxn = runPerformanceTestOnCache(transactionalCache, count);
|
||||
long commitStart = System.nanoTime();
|
||||
txn.commit();
|
||||
long commitEnd = System.nanoTime();
|
||||
long commitTime = (commitEnd - commitStart);
|
||||
// add this to the cache's performance overhead
|
||||
timeTxn += commitTime;
|
||||
|
||||
// report
|
||||
System.out.println("Cache performance test: \n" +
|
||||
" count: " + count + "\n" +
|
||||
" direct: " + timePlain/((long)count) + " ns\\count \n" +
|
||||
" transaction: " + timeTxn/((long)count) + " ns\\count");
|
||||
}
|
||||
}
|
||||
}
|
||||
112
source/java/org/alfresco/repo/cache/EhCacheAdapter.java
vendored
Normal file
112
source/java/org/alfresco/repo/cache/EhCacheAdapter.java
vendored
Normal file
@@ -0,0 +1,112 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.repo.cache;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.Serializable;
|
||||
|
||||
import net.sf.ehcache.Cache;
|
||||
import net.sf.ehcache.CacheException;
|
||||
import net.sf.ehcache.Element;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
|
||||
/**
|
||||
* A thin adapter for <b>Ehcache</b> support.
|
||||
* <p>
|
||||
* Thread-safety is taken care of by the underlying <b>Ehcache</b>
|
||||
* instance.
|
||||
*
|
||||
* @see org.springframework.cache.ehcache.EhCacheFactoryBean
|
||||
* @see org.springframework.cache.ehcache.EhCacheManagerFactoryBean
|
||||
*
|
||||
* @author Derek Hulley
|
||||
*/
|
||||
public class EhCacheAdapter<K extends Serializable, V extends Serializable>
|
||||
implements SimpleCache<K, V>
|
||||
{
|
||||
private net.sf.ehcache.Cache cache;
|
||||
|
||||
public EhCacheAdapter()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* @param cache the backing Ehcache instance
|
||||
*/
|
||||
public void setCache(Cache cache)
|
||||
{
|
||||
this.cache = cache;
|
||||
}
|
||||
|
||||
public boolean contains(K key)
|
||||
{
|
||||
try
|
||||
{
|
||||
return (cache.get(key) != null);
|
||||
}
|
||||
catch (CacheException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("contains failed", e);
|
||||
}
|
||||
}
|
||||
|
||||
@SuppressWarnings("unchecked")
|
||||
public V get(K key)
|
||||
{
|
||||
try
|
||||
{
|
||||
Element element = cache.get(key);
|
||||
if (element != null)
|
||||
{
|
||||
return (V) element.getValue();
|
||||
}
|
||||
else
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
catch (CacheException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Failed to get from EhCache: \n" +
|
||||
" key: " + key);
|
||||
}
|
||||
}
|
||||
|
||||
public void put(K key, V value)
|
||||
{
|
||||
Element element = new Element(key, value);
|
||||
cache.put(element);
|
||||
}
|
||||
|
||||
public void remove(K key)
|
||||
{
|
||||
cache.remove(key);
|
||||
}
|
||||
|
||||
public void clear()
|
||||
{
|
||||
try
|
||||
{
|
||||
cache.removeAll();
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Failed to clear cache", e);
|
||||
}
|
||||
}
|
||||
}
|
||||
42
source/java/org/alfresco/repo/cache/SimpleCache.java
vendored
Normal file
42
source/java/org/alfresco/repo/cache/SimpleCache.java
vendored
Normal file
@@ -0,0 +1,42 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.repo.cache;
|
||||
|
||||
import java.io.Serializable;
|
||||
|
||||
/**
|
||||
* Basic caching interface.
|
||||
* <p>
|
||||
* All implementations <b>must</b> be thread-safe. Additionally, the use of the
|
||||
* <tt>Serializable</tt> for both keys and values ensures that the underlying
|
||||
* cache implementations can support both clustered caches as well as persistent
|
||||
* caches.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
*/
|
||||
public interface SimpleCache<K extends Serializable, V extends Serializable>
|
||||
{
|
||||
public boolean contains(K key);
|
||||
|
||||
public V get(K key);
|
||||
|
||||
public void put(K key, V value);
|
||||
|
||||
public void remove(K key);
|
||||
|
||||
public void clear();
|
||||
}
|
||||
570
source/java/org/alfresco/repo/cache/TransactionalCache.java
vendored
Normal file
570
source/java/org/alfresco/repo/cache/TransactionalCache.java
vendored
Normal file
@@ -0,0 +1,570 @@
|
||||
/*
|
||||
* Copyright (C) 2005 Alfresco, Inc.
|
||||
*
|
||||
* Licensed under the Mozilla Public License version 1.1
|
||||
* with a permitted attribution clause. You may obtain a
|
||||
* copy of the License at
|
||||
*
|
||||
* http://www.alfresco.org/legal/license.txt
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing,
|
||||
* software distributed under the License is distributed on an
|
||||
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
|
||||
* either express or implied. See the License for the specific
|
||||
* language governing permissions and limitations under the
|
||||
* License.
|
||||
*/
|
||||
package org.alfresco.repo.cache;
|
||||
|
||||
import java.io.IOException;
|
||||
import java.io.Serializable;
|
||||
import java.util.List;
|
||||
|
||||
import net.sf.ehcache.Cache;
|
||||
import net.sf.ehcache.CacheException;
|
||||
import net.sf.ehcache.CacheManager;
|
||||
import net.sf.ehcache.Element;
|
||||
|
||||
import org.alfresco.error.AlfrescoRuntimeException;
|
||||
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
|
||||
import org.alfresco.repo.transaction.TransactionListener;
|
||||
import org.alfresco.util.EqualsHelper;
|
||||
import org.apache.commons.logging.Log;
|
||||
import org.apache.commons.logging.LogFactory;
|
||||
import org.springframework.beans.factory.InitializingBean;
|
||||
import org.springframework.util.Assert;
|
||||
|
||||
/**
|
||||
* A 2-level cache that mainains both a transaction-local cache and
|
||||
* wraps a non-transactional (shared) cache.
|
||||
* <p>
|
||||
* It uses the <b>Ehcache</b> <tt>Cache</tt> for it's per-transaction
|
||||
* caches as these provide automatic size limitations, etc.
|
||||
* <p>
|
||||
* Instances of this class <b>do not require a transaction</b>. They will work
|
||||
* directly with the shared cache when no transaction is present. There is
|
||||
* virtually no overhead when running out-of-transaction.
|
||||
* <p>
|
||||
* 3 caches are maintained.
|
||||
* <ul>
|
||||
* <li>Shared backing cache that should only be accessed by instances of this class</li>
|
||||
* <li>Lazily created cache of updates made during the transaction</li>
|
||||
* <li>Lazily created cache of deletions made during the transaction</li>
|
||||
* </ul>
|
||||
* <p>
|
||||
* When the cache is {@link #clear() cleared}, a flag is set on the transaction.
|
||||
* The shared cache, instead of being cleared itself, is just ignored for the remainder
|
||||
* of the tranasaction. At the end of the transaction, if the flag is set, the
|
||||
* shared transaction is cleared <i>before</i> updates are added back to it.
|
||||
* <p>
|
||||
* Because there is a limited amount of space available to the in-transaction caches,
|
||||
* when either of these becomes full, the cleared flag is set. This ensures that
|
||||
* the shared cache will not have stale data in the event of the transaction-local
|
||||
* caches dropping items.
|
||||
*
|
||||
* @author Derek Hulley
|
||||
*/
|
||||
public class TransactionalCache<K extends Serializable, V extends Serializable>
|
||||
implements SimpleCache<K, V>, TransactionListener, InitializingBean
|
||||
{
|
||||
private static final String RESOURCE_KEY_TXN_DATA = "TransactionalCache.TxnData";
|
||||
private static final String VALUE_DELETE = "TransactionalCache.DeleteMarker";
|
||||
|
||||
private static Log logger = LogFactory.getLog(TransactionalCache.class);
|
||||
|
||||
/** a name used to uniquely identify the transactional caches */
|
||||
private String name;
|
||||
|
||||
/** the shared cache that will get updated after commits */
|
||||
private SimpleCache<Serializable, Serializable> sharedCache;
|
||||
|
||||
/** the manager to control Ehcache caches */
|
||||
private CacheManager cacheManager;
|
||||
|
||||
/** the maximum number of elements to be contained in the cache */
|
||||
private int maxCacheSize = 500;
|
||||
|
||||
/** a unique string identifying this instance when binding resources */
|
||||
private String resourceKeyTxnData;
|
||||
|
||||
/**
|
||||
* @see #setName(String)
|
||||
*/
|
||||
public String toString()
|
||||
{
|
||||
return name;
|
||||
}
|
||||
|
||||
public boolean equals(Object obj)
|
||||
{
|
||||
if (obj == this)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
if (obj == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
if (!(obj instanceof TransactionalCache))
|
||||
{
|
||||
return false;
|
||||
}
|
||||
TransactionalCache that = (TransactionalCache) obj;
|
||||
return EqualsHelper.nullSafeEquals(this.name, that.name);
|
||||
}
|
||||
|
||||
public int hashCode()
|
||||
{
|
||||
return name.hashCode();
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the shared cache to use during transaction synchronization or when no transaction
|
||||
* is present.
|
||||
*
|
||||
* @param sharedCache
|
||||
*/
|
||||
public void setSharedCache(SimpleCache<Serializable, Serializable> sharedCache)
|
||||
{
|
||||
this.sharedCache = sharedCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the manager to activate and control the cache instances
|
||||
*
|
||||
* @param cacheManager
|
||||
*/
|
||||
public void setCacheManager(CacheManager cacheManager)
|
||||
{
|
||||
this.cacheManager = cacheManager;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the maximum number of elements to store in the update and remove caches.
|
||||
* The maximum number of elements stored in the transaction will be twice the
|
||||
* value given.
|
||||
* <p>
|
||||
* The removed list will overflow to disk in order to ensure that deletions are
|
||||
* not lost.
|
||||
*
|
||||
* @param maxCacheSize
|
||||
*/
|
||||
public void setMaxCacheSize(int maxCacheSize)
|
||||
{
|
||||
this.maxCacheSize = maxCacheSize;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the name that identifies this cache from other instances. This is optional.
|
||||
*
|
||||
* @param name
|
||||
*/
|
||||
public void setName(String name)
|
||||
{
|
||||
this.name = name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Ensures that all properties have been set
|
||||
*/
|
||||
public void afterPropertiesSet() throws Exception
|
||||
{
|
||||
Assert.notNull(name, "name property not set");
|
||||
Assert.notNull(cacheManager, "cacheManager property not set");
|
||||
// generate the resource binding key
|
||||
resourceKeyTxnData = RESOURCE_KEY_TXN_DATA + "." + name;
|
||||
}
|
||||
|
||||
/**
|
||||
* To be used in a transaction only.
|
||||
*/
|
||||
private TransactionData getTransactionData()
|
||||
{
|
||||
TransactionData data = (TransactionData) AlfrescoTransactionSupport.getResource(resourceKeyTxnData);
|
||||
if (data == null)
|
||||
{
|
||||
String txnId = AlfrescoTransactionSupport.getTransactionId();
|
||||
data = new TransactionData();
|
||||
// create and initialize caches
|
||||
data.updatedItemsCache = new Cache(
|
||||
name + "_"+ txnId + "_updates",
|
||||
maxCacheSize, false, true, 0, 0);
|
||||
data.removedItemsCache = new Cache(
|
||||
name + "_" + txnId + "_removes",
|
||||
maxCacheSize, false, true, 0, 0);
|
||||
try
|
||||
{
|
||||
cacheManager.addCache(data.updatedItemsCache);
|
||||
cacheManager.addCache(data.removedItemsCache);
|
||||
}
|
||||
catch (CacheException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Failed to add txn caches to manager", e);
|
||||
}
|
||||
AlfrescoTransactionSupport.bindResource(resourceKeyTxnData, data);
|
||||
}
|
||||
return data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the transactional removed and updated caches before checking the shared cache.
|
||||
*/
|
||||
public boolean contains(K key)
|
||||
{
|
||||
Object value = get(key);
|
||||
if (value == null)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
else
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks the per-transaction caches for the object before going to the shared cache.
|
||||
* If the thread is not in a transaction, then the shared cache is accessed directly.
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public V get(K key)
|
||||
{
|
||||
boolean ignoreSharedCache = false;
|
||||
// are we in a transaction?
|
||||
if (AlfrescoTransactionSupport.getTransactionId() != null)
|
||||
{
|
||||
TransactionData txnData = getTransactionData();
|
||||
try
|
||||
{
|
||||
if (!txnData.isClearOn) // deletions cache is still reliable
|
||||
{
|
||||
// check to see if the key is present in the transaction's removed items
|
||||
if (txnData.removedItemsCache.get(key) != null)
|
||||
{
|
||||
// it has been removed in this transaction
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("get returning null - item has been removed from transactional cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
// check for the item in the transaction's new/updated items
|
||||
Element element = txnData.updatedItemsCache.get(key);
|
||||
if (element != null)
|
||||
{
|
||||
// element was found in transaction-specific updates/additions
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("Found item in transactional cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key + "\n" +
|
||||
" value: " + element.getValue());
|
||||
}
|
||||
return (V) element.getValue();
|
||||
}
|
||||
}
|
||||
catch (CacheException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Cache failure", e);
|
||||
}
|
||||
// check if the cleared flag has been set - cleared flag means ignore shared as unreliable
|
||||
ignoreSharedCache = txnData.isClearOn;
|
||||
}
|
||||
// no value found - must we ignore the shared cache?
|
||||
if (!ignoreSharedCache)
|
||||
{
|
||||
// go to the shared cache
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("No value found in transaction - fetching instance from shared cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key + "\n" +
|
||||
" value: " + sharedCache.get(key));
|
||||
}
|
||||
return (V) sharedCache.get(key);
|
||||
}
|
||||
else // ignore shared cache
|
||||
{
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("No value found in transaction and ignoring shared cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key);
|
||||
}
|
||||
return null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Goes direct to the shared cache in the absence of a transaction.
|
||||
* <p>
|
||||
* Where a transaction is present, a cache of updated items is lazily added to the
|
||||
* thread and the <tt>Object</tt> put onto that.
|
||||
*/
|
||||
public void put(K key, V value)
|
||||
{
|
||||
// are we in a transaction?
|
||||
if (AlfrescoTransactionSupport.getTransactionId() == null) // not in transaction
|
||||
{
|
||||
// no transaction
|
||||
sharedCache.put(key, value);
|
||||
// done
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("No transaction - adding item direct to shared cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key + "\n" +
|
||||
" value: " + value);
|
||||
}
|
||||
}
|
||||
else // transaction present
|
||||
{
|
||||
TransactionData txnData = getTransactionData();
|
||||
// register for callbacks
|
||||
if (!txnData.listenerBound)
|
||||
{
|
||||
AlfrescoTransactionSupport.bindListener(this);
|
||||
txnData.listenerBound = true;
|
||||
}
|
||||
// we have a transaction - add the item into the updated cache for this transaction
|
||||
// are we in an overflow condition?
|
||||
if (txnData.updatedItemsCache.getMemoryStoreSize() >= maxCacheSize)
|
||||
{
|
||||
// overflow about to occur or has occured - we can only guarantee non-stale
|
||||
// data by clearing the shared cache after the transaction. Also, the
|
||||
// shared cache needs to be ignored for the rest of the transaction.
|
||||
txnData.isClearOn = true;
|
||||
}
|
||||
Element element = new Element(key, value);
|
||||
txnData.updatedItemsCache.put(element);
|
||||
// remove the item from the removed cache, if present
|
||||
txnData.removedItemsCache.remove(key);
|
||||
// done
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("In transaction - adding item direct to transactional update cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key + "\n" +
|
||||
" value: " + value);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Goes direct to the shared cache in the absence of a transaction.
|
||||
* <p>
|
||||
* Where a transaction is present, a cache of removed items is lazily added to the
|
||||
* thread and the <tt>Object</tt> put onto that.
|
||||
*/
|
||||
public void remove(K key)
|
||||
{
|
||||
// are we in a transaction?
|
||||
if (AlfrescoTransactionSupport.getTransactionId() == null) // not in transaction
|
||||
{
|
||||
// no transaction
|
||||
sharedCache.remove(key);
|
||||
// done
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("No transaction - removing item from shared cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key);
|
||||
}
|
||||
}
|
||||
else // transaction present
|
||||
{
|
||||
TransactionData txnData = getTransactionData();
|
||||
// register for callbacks
|
||||
if (!txnData.listenerBound)
|
||||
{
|
||||
AlfrescoTransactionSupport.bindListener(this);
|
||||
txnData.listenerBound = true;
|
||||
}
|
||||
// is the shared cache going to be cleared?
|
||||
if (txnData.isClearOn)
|
||||
{
|
||||
// don't store removals
|
||||
}
|
||||
else
|
||||
{
|
||||
// are we in an overflow condition?
|
||||
if (txnData.removedItemsCache.getMemoryStoreSize() >= maxCacheSize)
|
||||
{
|
||||
// overflow about to occur or has occured - we can only guarantee non-stale
|
||||
// data by clearing the shared cache after the transaction. Also, the
|
||||
// shared cache needs to be ignored for the rest of the transaction.
|
||||
txnData.isClearOn = true;
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("In transaction - removal cache reach capacity reached: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" txn: " + AlfrescoTransactionSupport.getTransactionId());
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// add it from the removed cache for this txn
|
||||
Element element = new Element(key, VALUE_DELETE);
|
||||
txnData.removedItemsCache.put(element);
|
||||
}
|
||||
}
|
||||
// remove the item from the udpated cache, if present
|
||||
txnData.updatedItemsCache.remove(key);
|
||||
// done
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("In transaction - adding item direct to transactional removed cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" key: " + key);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Clears out all the caches.
|
||||
*/
|
||||
public void clear()
|
||||
{
|
||||
// clear local caches
|
||||
if (AlfrescoTransactionSupport.getTransactionId() != null)
|
||||
{
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("In transaction clearing cache: \n" +
|
||||
" cache: " + this + "\n" +
|
||||
" txn: " + AlfrescoTransactionSupport.getTransactionId());
|
||||
}
|
||||
|
||||
TransactionData txnData = getTransactionData();
|
||||
// register for callbacks
|
||||
if (!txnData.listenerBound)
|
||||
{
|
||||
AlfrescoTransactionSupport.bindListener(this);
|
||||
txnData.listenerBound = true;
|
||||
}
|
||||
// the shared cache must be cleared at the end of the transaction
|
||||
// and also serves to ensure that the shared cache will be ignored
|
||||
// for the remainder of the transaction
|
||||
txnData.isClearOn = true;
|
||||
try
|
||||
{
|
||||
txnData.updatedItemsCache.removeAll();
|
||||
txnData.removedItemsCache.removeAll();
|
||||
}
|
||||
catch (IOException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Failed to clear caches", e);
|
||||
}
|
||||
}
|
||||
else // no transaction
|
||||
{
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("No transaction - clearing shared cache");
|
||||
}
|
||||
// clear shared cache
|
||||
sharedCache.clear();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* NO-OP
|
||||
*/
|
||||
public void flush()
|
||||
{
|
||||
}
|
||||
|
||||
public void beforeCommit(boolean readOnly)
|
||||
{
|
||||
}
|
||||
|
||||
public void beforeCompletion()
|
||||
{
|
||||
}
|
||||
|
||||
/**
|
||||
* Merge the transactional caches into the shared cache
|
||||
*/
|
||||
@SuppressWarnings("unchecked")
|
||||
public void afterCommit()
|
||||
{
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("Processing end of transaction commit");
|
||||
}
|
||||
|
||||
TransactionData txnData = getTransactionData();
|
||||
|
||||
if (txnData.isClearOn)
|
||||
{
|
||||
// clear shared cache
|
||||
sharedCache.clear();
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("Clear notification recieved at end of transaction - clearing shared cache");
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
// transfer any removed items
|
||||
// any removed items will have also been removed from the in-transaction updates
|
||||
// propogate the deletes to the shared cache
|
||||
List<Serializable> keys = txnData.removedItemsCache.getKeys();
|
||||
for (Serializable key : keys)
|
||||
{
|
||||
sharedCache.remove(key);
|
||||
}
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("Removed " + keys.size() + " values from shared cache");
|
||||
}
|
||||
}
|
||||
// transfer updates
|
||||
try
|
||||
{
|
||||
List<Serializable> keys = txnData.updatedItemsCache.getKeys();
|
||||
for (Serializable key : keys)
|
||||
{
|
||||
Element element = txnData.updatedItemsCache.get(key);
|
||||
sharedCache.put(key, element.getValue());
|
||||
}
|
||||
if (logger.isDebugEnabled())
|
||||
{
|
||||
logger.debug("Added " + keys.size() + " values to shared cache");
|
||||
}
|
||||
}
|
||||
catch (CacheException e)
|
||||
{
|
||||
throw new AlfrescoRuntimeException("Failed to transfer updates to shared cache", e);
|
||||
}
|
||||
|
||||
// drop caches from cachemanager
|
||||
cacheManager.removeCache(txnData.updatedItemsCache.getName());
|
||||
cacheManager.removeCache(txnData.removedItemsCache.getName());
|
||||
}
|
||||
|
||||
/**
|
||||
* Just allow the transactional caches to be thrown away
|
||||
*/
|
||||
public void afterRollback()
|
||||
{
|
||||
TransactionData txnData = getTransactionData();
|
||||
|
||||
// drop caches from cachemanager
|
||||
cacheManager.removeCache(txnData.updatedItemsCache.getName());
|
||||
cacheManager.removeCache(txnData.removedItemsCache.getName());
|
||||
}
|
||||
|
||||
/** Data holder to bind data to the transaction */
|
||||
private class TransactionData
|
||||
{
|
||||
public Cache updatedItemsCache;
|
||||
public Cache removedItemsCache;
|
||||
public boolean isClearOn;
|
||||
public boolean listenerBound;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user