io.vertigo.commons.impl.cache

Interface CachePlugin

All Superinterfaces:

Component, Plugin

All Known Implementing Classes:

EhCachePlugin, MemoryCachePlugin, RedisCachePlugin

public interface CachePlugin
extends Plugin

Plugin de gestion de cache.

Author:

pchretien

Method Summary

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

Method Detail

put

void put(String cacheName,
         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é.

Parameters:

cacheName - Contexte de cache

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

value - Objet à insérer

get

Object get(String cacheName,
           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:

cacheName - Contexte de cache

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

Returns:

Objet demandé ou null si non trouvé

remove

boolean remove(String cacheName,
               Serializable key)

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

Parameters:

cacheName - Contexte de cache

key - Clé de l'objet à supprimer

Returns:

Si objet supprimé

clear

void clear(String cacheName)

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

Parameters:

cacheName - Contexte de cache

clearAll

void clearAll()

Effacement du contenu de TOUS les Contextes de cache.

checkIo

default HealthMeasure checkIo()

Returns:

HealthMeasure of this plugin