Package org.exoplatform.services.cache

Interface CacheService

All Known Implementing Classes:

CacheServiceImpl

public interface CacheService

Created by The eXo Platform SAS
The cache service.

Author:

: Tuan Nguyen.

eXo level API

Platform

Method Summary

Modifier and Type	Method	Description
void	addExoCacheConfig(ExoCacheConfigPlugin plugin)	Adds a cache configuration plugin.
Collection<ExoCache<? extends Serializable,?>>	getAllCacheInstances()	Returns a collection of all the cache instances.
<K extends Serializable,V> ExoCache<K,V>	getCacheInstance(String region)	Returns a specific cache instance.

Method Detail

addExoCacheConfig

void addExoCacheConfig(ExoCacheConfigPlugin plugin)

Adds a cache configuration plugin.

Parameters:

plugin - the plugin

getCacheInstance

<K extends Serializable,V> ExoCache<K,V> getCacheInstance(String region)
                                                               throws NullPointerException,
                                                                      IllegalArgumentException

Returns a specific cache instance.

Type Parameters:

K - the key type

V - the value type

Parameters:

region - the cache region

Returns:

the cache

Throws:

NullPointerException - if the region argument is null

IllegalArgumentException - if the region argument length is zero

getAllCacheInstances

Collection<ExoCache<? extends Serializable,?>> getAllCacheInstances()

Returns a collection of all the cache instances.

Returns:

all the caches