io.vertigo.commons.plugins.cache.ehcache

Class EhCachePlugin

java.lang.Object

io.vertigo.commons.plugins.cache.ehcache.EhCachePlugin

All Implemented Interfaces:

CachePlugin, Activeable, Component, Plugin

public final class EhCachePlugin
extends Object
implements Activeable, CachePlugin

Implémentation EHCache du CacheManager.

Author:

pchretien, npiedeloup

Constructor Summary

Constructors

Constructor and Description
EhCachePlugin(CodecManager codecManager) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addCache(String context, CacheConfig cacheConfig) Configuration des caches.
void	clear(String context) Effacement du contenu d'un contexte.
void	clearAll() Effacement du contenu de TOUS les Contextes de cache.
Object	get(String context, Serializable key) Cette methode rend l'objet désigne par le contexte et le handle donnée en entrée.
void	put(String context, Serializable key, Object value) Ajoute Objet dans le cache.
boolean	remove(String context, Serializable key) Suppression du cache de l'objet référencé par sa clé.
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

EhCachePlugin

@Inject
public EhCachePlugin(CodecManager codecManager)

Constructor.

Parameters:

codecManager - CodecManager

Method Detail

addCache

public void addCache(String context,
                     CacheConfig cacheConfig)

Configuration des caches. Il est préférable d'appeler cette méthode une seule fois par type de cache et au démarrage. Il s'agit en effet d'une phase d'initialisation.

Specified by:

addCache in interface CachePlugin

Parameters:

context - Contexte du cache

cacheConfig - Config of cache

put

public void put(String context,
                Serializable key,
                Object value)

Ajoute Objet dans le cache. Si le context n'existe pas, il est crée. Si la clé existe déjà, l'objet précédent est remplacé.

Specified by:

put in interface CachePlugin

Parameters:

context - Contexte de cache

key - Clé de l'objet à insérer

value - Objet à insérer

get

public Object get(String context,
                  Serializable key)

Cette methode rend l'objet désigne par le contexte et le handle donnée en entrée. Si le contexte n'existe pas, une exception IllegalArgumentException. Si le handle n'existe pas, ou l'objet n'a pas ou plus de reference en cache, l'objet renvoyé et un null.

Specified by:

get in interface CachePlugin

Parameters:

context - Contexte de cache

key - Clé de l'objet à récupérer

Returns:

Objet demandé ou null si non trouvé

remove

public boolean remove(String context,
                      Serializable key)

Suppression du cache de l'objet référencé par sa clé.

Specified by:

remove in interface CachePlugin

Parameters:

context - Contexte de cache

key - Clé de l'objet à supprimer

Returns:

Si objet supprimé

clearAll

public void clearAll()

Effacement du contenu de TOUS les Contextes de cache.

Specified by:

clearAll in interface CachePlugin

clear

public void clear(String context)

Effacement du contenu d'un contexte. Supprime tous les items du cache.

Specified by:

clear in interface CachePlugin

Parameters:

context - Contexte de cache

start

public void start()

Specified by:

start in interface Activeable

stop

public void stop()

Specified by:

stop in interface Activeable