io.vertigo.commons.plugins.cache.map

Class MapCachePlugin

java.lang.Object

io.vertigo.commons.plugins.cache.map.MapCachePlugin

All Implemented Interfaces:

CachePlugin, Describable, Plugin

public final class MapCachePlugin
extends Object
implements CachePlugin, Describable

Implémentation MapCache du plugins.

Author:

npiedeloup

Constructor Summary

Constructors

Constructor and Description
MapCachePlugin(CodecManager codecManager, Option<String> noSerializationOption) Constructeur.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCache(String cacheType, String context, int maxElementsInMemory, long timeToLiveSeconds, long timeToIdleSeconds) Configuration des caches.
void	clear(String context) Effacement du contenu d'un contexte.
void	clearAll() Effacement du contenu de TOUS les Contextes de cache.
Serializable	get(String context, Serializable key) Cette methode rend l'objet désigne par le contexte et le handle donnée en entrée.
List<ComponentInfo>	getInfos()
void	put(String context, Serializable key, Serializable value) Ajoute Objet dans le cache.
boolean	remove(String context, Serializable key) Suppression du cache de l'objet référencé par sa clé.

Methods inherited from class java.lang.Object

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

Constructor Detail

MapCachePlugin

@Inject
public MapCachePlugin(CodecManager codecManager,
                     @Named(value="noSerialization")
                     Option<String> noSerializationOption)

Constructeur.

Parameters:

codecManager - Manager des mécanismes de codage/décodage.

noSerializationOption - Liste optionnelles des noms de context à ne jamais sérialiser

Method Detail

addCache

public void addCache(String cacheType,
            String context,
            int maxElementsInMemory,
            long timeToLiveSeconds,
            long timeToIdleSeconds)

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:

cacheType - Type du cache

context - Contexte du cache

maxElementsInMemory - Nombre maximal d'éléments mis en cache mémoire

timeToLiveSeconds - Durée maximale de conservation des données en cache

timeToIdleSeconds - Durée d'inactivité au delé de laquelle le cache est vidé.

put

public void put(String context,
       Serializable key,
       Serializable 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 Serializable 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

getInfos

public List<ComponentInfo> getInfos()

Specified by:

getInfos in interface Describable