com.atlassian.crowd.manager.cache
Interface CacheManager

All Known Implementing Classes:

CacheManagerEhcache

public interface CacheManager

Method Summary

java.lang.Object	get(java.lang.String key) Retrieves cached object from the default cache.
java.lang.Object	get(java.lang.String cacheName, java.io.Serializable key) Retrieves cached object.
java.util.List	getAllKeys() Retrieves all keys from the default cache.
java.util.List	getAllKeys(java.lang.String cacheName) Retrieve all keys from the cache.
void	put(java.lang.String key, java.io.Serializable obj) Saves object to the default cache
void	put(java.lang.String cacheName, java.io.Serializable key, java.io.Serializable obj) Saves object to the cache.
boolean	remove(java.lang.String key) Removes cached object from the default cache
boolean	remove(java.lang.String cacheName, java.io.Serializable key) Removes cached object from the cache.
void	removeAll() Remove all the entries from the default cache.
void	removeAll(java.lang.String cacheName) Removes all the entries from the given cache.

Method Detail

put

void put(java.lang.String cacheName,
         java.io.Serializable key,
         java.io.Serializable obj)
         throws CacheManagerException

Saves object to the cache.

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

java.lang.Object get(java.lang.String cacheName,
                     java.io.Serializable key)
                     throws CacheManagerException,
                            NotInCacheException

Retrieves cached object.

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

boolean remove(java.lang.String cacheName,
               java.io.Serializable key)
               throws CacheManagerException

Removes cached object from the cache.

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

void removeAll(java.lang.String cacheName)
               throws CacheManagerException

Removes all the entries from the given cache.

Parameters:

cacheName - cache name.

Throws:

CacheManagerException - if any problems arise during the operation

getAllKeys

java.util.List getAllKeys(java.lang.String cacheName)
                          throws CacheManagerException

Retrieve all keys from the cache.

Parameters:

cacheName - cache name.

Returns:

list of keys.

Throws:

CacheManagerException

put

void put(java.lang.String key,
         java.io.Serializable obj)
         throws CacheManagerException

Saves object to the default cache

Parameters:

key - key of the object

obj - actual object to be cached

Throws:

CacheManagerException - if any problems arise during the operation

get

java.lang.Object get(java.lang.String key)
                     throws CacheManagerException,
                            NotInCacheException

Retrieves cached object from the default cache.

Parameters:

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

boolean remove(java.lang.String key)
               throws CacheManagerException

Removes cached object from the default cache

Parameters:

key - key of the object

Returns:

true if the key exists

Throws:

CacheManagerException - if any problems arise during the operation

removeAll

void removeAll()
               throws CacheManagerException

Remove all the entries from the default cache.

Throws:

CacheManagerException - if any problems arise during the operation

getAllKeys

java.util.List getAllKeys()
                          throws CacheManagerException

Retrieves all keys from the default cache.

Returns:

list of keys

Throws:

CacheManagerException - if any problems arise during the operation