io.vertigo.commons.impl.cache

Interface CachePlugin

All Superinterfaces:

Plugin

All Known Implementing Classes:

MapCachePlugin

public interface CachePlugin
extends Plugin

Plugin de gestion de cache.

Author:

pchretien

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.
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é.

Method Detail

addCache

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.

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

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é.

Parameters:

context - Contexte de cache

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

value - Objet à insérer

get

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.

Parameters:

context - Contexte de cache

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

Returns:

Objet demandé ou null si non trouvé

remove

boolean remove(String context,
             Serializable key)

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

Parameters:

context - Contexte de cache

key - Clé de l'objet à supprimer

Returns:

Si objet supprimé

clear

void clear(String context)

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

Parameters:

context - Contexte de cache

clearAll

void clearAll()

Effacement du contenu de TOUS les Contextes de cache.