Package org.craftercms.core.cache.impl.store

Class MapCacheStoreAdapter

java.lang.Object

org.craftercms.core.cache.impl.store.MapCacheStoreAdapter

All Implemented Interfaces:

CacheStoreAdapter

public class MapCacheStoreAdapter
extends Object
implements CacheStoreAdapter

Implementation of a CacheStoreAdapter using an underlying Map.

Author:

Sumer Jabri, Alfonso Vásquez

Constructor Summary

Constructors

Constructor	Description
MapCacheStoreAdapter()	Default constructor.
MapCacheStoreAdapter(List<String> scopes)	Constructor that receives a list of scopes that need to created.

Method Summary

Modifier and Type	Method	Description
void	addScope(String scope, int maxItemsInMemory)	Adds a new scope.
void	clearAll()	Clears the contents of the entire store.
void	clearScope(String scope)	Clears the contents of the specified scope in the underlying store.
CacheItem	get(String scope, Object key)	Retrieves an item from a scope.
Collection<Object>	getKeys(String scope)	Returns a list of the keys of the items present in the specified scope.
Collection<String>	getScopes()	Returns the scopes managed by the underlying store.
int	getSize(String scope)	Returns the quantity of items present in the specified scope.
CacheStatistics	getStatistics(String scope)	Returns the statistics of the specified scope from the underlying store.
boolean	hasKey(String scope, Object key)	Returns true if there's and item with the specified key in the specified scope.
boolean	hasScope(String scope)	Returns true if the specified scope exists in the cache.
void	put(CacheItem item)	Puts an item in a scope.
boolean	remove(String scope, Object key)	Removes an item from a scope.
void	removeScope(String scope)	Removes an existing scope and all the items that are in it.

Methods inherited from class java.lang.Object

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

Constructor Details

MapCacheStoreAdapter

public MapCacheStoreAdapter()

Default constructor. Creates scopeCaches as a ConcurrentHashMap

MapCacheStoreAdapter

public MapCacheStoreAdapter(List<String> scopes)

Constructor that receives a list of scopes that need to created. Each scope is an instance of ConcurrentHashMap.

Method Details

hasScope

public boolean hasScope(String scope)
                 throws Exception

Returns true if the specified scope exists in the cache.

Specified by:

hasScope in interface CacheStoreAdapter

Throws:

Exception

getScopes

public Collection<String> getScopes()
                             throws Exception

Returns the scopes managed by the underlying store.

Specified by:

getScopes in interface CacheStoreAdapter

Throws:

Exception

addScope

public void addScope(String scope,
 int maxItemsInMemory)
              throws Exception

Adds a new scope. The scope is an instance of ConcurrentHashMap.

Specified by:

addScope in interface CacheStoreAdapter

Parameters:

scope - the name of the scope

maxItemsInMemory - the maximum number of items in memory, before they are evicted

Throws:

Exception

removeScope

public void removeScope(String scope)
                 throws Exception

Removes an existing scope and all the items that are in it.

Specified by:

removeScope in interface CacheStoreAdapter

Parameters:

scope - scope to remove

Throws:

Exception

getSize

public int getSize(String scope)
            throws Exception

Returns the quantity of items present in the specified scope.

Specified by:

getSize in interface CacheStoreAdapter

Returns:

the size of the scope (quantity of items)

Throws:

Exception

getKeys

public Collection<Object> getKeys(String scope)
                           throws Exception

Returns a list of the keys of the items present in the specified scope.

Specified by:

getKeys in interface CacheStoreAdapter

Returns:

a list of the keys of the available items in the scope

Throws:

Exception

hasKey

public boolean hasKey(String scope,
 Object key)
               throws Exception

Returns true if there's and item with the specified key in the specified scope.

Specified by:

hasKey in interface CacheStoreAdapter

Returns:

true if the key exists in the scope, false otherwise

Throws:

Exception

get

public CacheItem get(String scope,
 Object key)
              throws Exception

Retrieves an item from a scope.

Specified by:

get in interface CacheStoreAdapter

Parameters:

scope - scope to get the item from

key - unique key for the item within this scope

Returns:

the requested item if found, null otherwise

Throws:

Exception

put

public void put(CacheItem item)
         throws Exception

Puts an item in a scope. The scope is obtained through CacheItem.getScope().

Specified by:

put in interface CacheStoreAdapter

Parameters:

item - the item to put

Throws:

Exception

remove

public boolean remove(String scope,
 Object key)
               throws Exception

Removes an item from a scope.

Specified by:

remove in interface CacheStoreAdapter

Parameters:

scope - scope to remove the item from

key - unique key for the item within this scope

Returns:

true if the removal was successful, false otherwise

Throws:

Exception

clearAll

public void clearAll()
              throws Exception

Clears the contents of the entire store.

Specified by:

clearAll in interface CacheStoreAdapter

Throws:

Exception

clearScope

public void clearScope(String scope)
                throws Exception

Clears the contents of the specified scope in the underlying store.

Specified by:

clearScope in interface CacheStoreAdapter

Parameters:

scope - scope to clear

Throws:

Exception

getStatistics

public CacheStatistics getStatistics(String scope)

Returns the statistics of the specified scope from the underlying store.

Specified by:

getStatistics in interface CacheStoreAdapter

Parameters:

scope - scope to inspect

Returns:

the statistics