com.atlassian.crowd.manager.cache

Class CacheManagerEhcache

java.lang.Object

com.atlassian.crowd.manager.cache.CacheManagerEhcache

All Implemented Interfaces:

CacheManager

public class CacheManagerEhcache
extends Object
implements CacheManager

Constructor Summary

Constructors

Constructor and Description
CacheManagerEhcache(net.sf.ehcache.CacheManager cacheManager)

Method Summary

Modifier and Type	Method and Description
Object	get(String cacheName, Serializable key) Retrieves cached object.
List	getAllKeys(String cacheName) Retrieve all keys from the cache.
void	put(String cacheName, Serializable key, Serializable obj) Saves object to the cache.
boolean	remove(String cacheName, Serializable key) Removes cached object from the cache.
void	removeAll(String cacheName) Removes all the entries from the given cache.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CacheManagerEhcache

public CacheManagerEhcache(net.sf.ehcache.CacheManager cacheManager)

Method Detail

put

public void put(String cacheName,
                Serializable key,
                Serializable obj)
         throws CacheManagerException

Description copied from interface: CacheManager

Saves object to the cache.

Specified by:

put in interface CacheManager

Parameters:

cacheName - cache name

key - key of the object

obj - actual object to be cached

Throws:

CacheManagerException - if any problems arise during the operation

get

public Object get(String cacheName,
                  Serializable key)
           throws CacheManagerException,
                  NotInCacheException

Description copied from interface: CacheManager

Retrieves cached object.

Specified by:

get in interface CacheManager

Parameters:

cacheName - cache name

key - key of the object

Returns:

cached object

Throws:

CacheManagerException - if any problems arise during the operation

NotInCacheException - if the key does not exist

remove

public boolean remove(String cacheName,
                      Serializable key)
               throws CacheManagerException

Description copied from interface: CacheManager

Removes cached object from the cache.

Specified by:

remove in interface CacheManager

Parameters:

cacheName - cache name

key - key of the object

Returns:

if an element was removed as a result of this call

Throws:

CacheManagerException - if any problems arise during the operation

removeAll

public void removeAll(String cacheName)
               throws CacheManagerException

Description copied from interface: CacheManager

Removes all the entries from the given cache.

Specified by:

removeAll in interface CacheManager

Parameters:

cacheName - cache name.

Throws:

CacheManagerException - if any problems arise during the operation

getAllKeys

public List getAllKeys(String cacheName)
                throws CacheManagerException

Description copied from interface: CacheManager

Retrieve all keys from the cache.

Specified by:

getAllKeys in interface CacheManager

Parameters:

cacheName - cache name.

Returns:

list of keys.

Throws:

CacheManagerException