org.jahia.services.cache

Class CacheService

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.cache.CacheService

Direct Known Subclasses:

CacheFactory

public abstract class CacheService
extends JahiaService

User: Serge Huber Date: Jul 13, 2005 Time: 1:17:31 PM Copyright (C) Jahia Inc.

Field Summary

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Constructor Summary

Constructors

Constructor and Description
CacheService()

Method Summary

Modifier and Type	Method and Description
abstract void	flushAllCaches() Flush all the cache entries of all the registered caches.
abstract <K,V> Cache<K,V>	getCache(String name)
abstract <K,V> Cache<K,V>	getCache(String name, boolean forceCreation) Returns the requested cache or creates it if it does not exist yet and forceCreation is set to true.
abstract Map<String,CacheProvider>	getCacheProviders()
abstract Set<String>	getNames() Returns an iterator of all the cache names.
abstract void	setCacheProviders(Map<String,CacheProvider> cacheProviders)

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean, start, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheService

public CacheService()

Method Detail

getCache

public abstract <K,V> Cache<K,V> getCache(String name,
                                          boolean forceCreation)
                                   throws JahiaInitializationException

Returns the requested cache or creates it if it does not exist yet and forceCreation is set to true.

When the name is null the cache creation is canceled and a null instance will be returned.

Parameters:

name - the cache region

forceCreation - do we need to create a new cache if it does not exist yet?

Returns:

the new cache instance

Throws:

JahiaInitializationException - when the cache could not be initialized

getCache

public abstract <K,V> Cache<K,V> getCache(String name)

getNames

public abstract Set<String> getNames()

Returns an iterator of all the cache names.

Returns:

an iterator of all the cache names.

flushAllCaches

public abstract void flushAllCaches()

Flush all the cache entries of all the registered caches.

Use this method with caution as it may take a lot of CPU time, because the method is synchronized and each accessed cache has to be synchronized too.

getCacheProviders

public abstract Map<String,CacheProvider> getCacheProviders()

setCacheProviders

public abstract void setCacheProviders(Map<String,CacheProvider> cacheProviders)