Package org.craftercms.core.service.impl

Class CacheServiceImpl

java.lang.Object

org.craftercms.core.service.impl.CacheServiceImpl

All Implemented Interfaces:

CacheService

public class CacheServiceImpl
extends Object
implements CacheService

Default implementation of CacheService. Adapts a Cache.

Author:

Sumer Jabri, Alfonso Vásquez

Field Summary

Fields

Modifier and Type	Field	Description
protected Cache	cache

Constructor Summary

Constructors

Constructor	Description
CacheServiceImpl()

Method Summary

Modifier and Type	Method	Description
void	addScope(Context context)	Adds a new scope to the cache for the given context.
void	clearAll()	Clears the contents of the entire cache.
void	clearScope(Context context)	Clears the contents of the scope of the given context.
Object	get(Context context, Object key)	Retrieves an item's value from the scope of the given context, or null if not found.
CacheItem	getItem(Context context, Object key)	Retrieves an item from the scope of the given context, or null if not found.
Collection<?>	getKeys(Context context)	Returns a list of the keys of the items present in the scope of the given context.
Collection<String>	getScopes()	Returns the list of scopes this cache manages.
int	getSize(Context context)	Returns the quantity of items present in scope of the given context.
CacheStatistics	getStatistics(Context context)	Returns the statistics for the scope of the given context.
boolean	hasKey(Context context, Object key)	Returns true if there's and item with the specified key in the scope of the given context.
boolean	hasScope(Context context)	Returns true if the scope of the given context exists.
void	put(Context context, Object key, Object value)	Puts an item in the scope of the given context.
void	put(Context context, Object key, Object value, CachingOptions cachingOptions, CacheLoader loader, Object... loaderParams)	Puts and item in the scope of the given context.
boolean	remove(Context context, Object key)	Removes an item from the scope of the given context.
void	removeScope(Context context)	Removes the scope associated to the given context
void	setCache(Cache cache)	Sets the cache engine.

Methods inherited from class java.lang.Object

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

Field Detail

cache

protected Cache cache

Constructor Detail

CacheServiceImpl

public CacheServiceImpl()

Method Detail

setCache

public void setCache(Cache cache)

Sets the cache engine.

Parameters:

cache -

getScopes

public Collection<String> getScopes()
                             throws InternalCacheEngineException

Description copied from interface: CacheService

Returns the list of scopes this cache manages.

Specified by:

getScopes in interface CacheService

Throws:

InternalCacheEngineException

clearAll

public void clearAll()
              throws InternalCacheEngineException

Description copied from interface: CacheService

Clears the contents of the entire cache.

Specified by:

clearAll in interface CacheService

Throws:

InternalCacheEngineException

addScope

public void addScope(Context context)
              throws InternalCacheEngineException

Description copied from interface: CacheService

Adds a new scope to the cache for the given context.

Specified by:

addScope in interface CacheService

Throws:

InternalCacheEngineException

removeScope

public void removeScope(Context context)
                 throws InvalidContextException,
                        InternalCacheEngineException

Description copied from interface: CacheService

Removes the scope associated to the given context

Specified by:

removeScope in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

hasScope

public boolean hasScope(Context context)
                 throws InvalidContextException,
                        InternalCacheEngineException

Description copied from interface: CacheService

Returns true if the scope of the given context exists.

Specified by:

hasScope in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

getSize

public int getSize(Context context)
            throws InvalidContextException,
                   InternalCacheEngineException

Description copied from interface: CacheService

Returns the quantity of items present in scope of the given context.

Specified by:

getSize in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

getKeys

public Collection<?> getKeys(Context context)
                      throws InvalidContextException,
                             InternalCacheEngineException

Description copied from interface: CacheService

Returns a list of the keys of the items present in the scope of the given context.

Specified by:

getKeys in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

hasKey

public boolean hasKey(Context context,
                      Object key)
               throws InvalidContextException,
                      InternalCacheEngineException

Description copied from interface: CacheService

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

Specified by:

hasKey in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

getItem

public CacheItem getItem(Context context,
                         Object key)
                  throws InvalidContextException,
                         InternalCacheEngineException

Description copied from interface: CacheService

Retrieves an item from the scope of the given context, or null if not found.

Specified by:

getItem in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

get

public Object get(Context context,
                  Object key)
           throws InvalidContextException,
                  InternalCacheEngineException

Description copied from interface: CacheService

Retrieves an item's value from the scope of the given context, or null if not found.

Specified by:

get in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

put

public void put(Context context,
                Object key,
                Object value)
         throws InvalidContextException,
                InternalCacheEngineException

Description copied from interface: CacheService

Puts an item in the scope of the given context.

Specified by:

put in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

put

public void put(Context context,
                Object key,
                Object value,
                CachingOptions cachingOptions,
                CacheLoader loader,
                Object... loaderParams)
         throws InvalidContextException,
                InternalCacheEngineException

Description copied from interface: CacheService

Puts and item in the scope of the given context.

Specified by:

put in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

remove

public boolean remove(Context context,
                      Object key)
               throws InvalidContextException,
                      InternalCacheEngineException

Description copied from interface: CacheService

Removes an item from the scope of the given context.

Specified by:

remove in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

clearScope

public void clearScope(Context context)
                throws InvalidContextException,
                       InternalCacheEngineException

Description copied from interface: CacheService

Clears the contents of the scope of the given context.

Specified by:

clearScope in interface CacheService

Throws:

InvalidContextException

InternalCacheEngineException

getStatistics

public CacheStatistics getStatistics(Context context)

Description copied from interface: CacheService

Returns the statistics for the scope of the given context.

Specified by:

getStatistics in interface CacheService