org.jahia.services.cache

Class CacheFactory

java.lang.Object

org.jahia.services.JahiaService

org.jahia.services.cache.CacheService

org.jahia.services.cache.CacheFactory

public class CacheFactory
extends CacheService

Here are the methods that should be called to create new instances of caches.

Since:

Jahia 4.0

Version:

1.0

Author:

Fulco Houkes, Copyright (c) 2003 by Jahia Ltd.

See Also:

Cache

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_CACHE

Fields inherited from class org.jahia.services.JahiaService

settingsBean

Method Summary

Modifier and Type	Method and Description
protected <K,V> Cache<K,V>	createCacheInstance(String name, String cacheProvider)
void	flushAllCaches() Flush all the cache entries of all the registered caches.
Cache	getCache(String name) Retrieves the specified region cache.
<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.
Map<String,String>	getCacheProviderForCache()
Map<String,CacheProvider>	getCacheProviders()
static CacheFactory	getInstance() Return the unique instance of this class.
Set<String>	getNames() Returns an iterator of all the cache names.
void	setCacheProviderForCache(Map<String,String> cacheProviderForCache)
void	setCacheProviders(Map<String,CacheProvider> cacheProviders)
void	start()
void	stop()

Methods inherited from class org.jahia.services.JahiaService

getSettingsBean, setSettingsBean

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CACHE

public static final String DEFAULT_CACHE

See Also:

Constant Field Values

Method Detail

start

public void start()
           throws JahiaInitializationException

Specified by:

start in class JahiaService

Throws:

JahiaInitializationException

stop

public void stop()
          throws JahiaException

Specified by:

stop in class JahiaService

Throws:

JahiaException

getInstance

public static CacheFactory getInstance()

Return the unique instance of this class.

Returns:

the class' unique instance.

getCache

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

Description copied from class: CacheService

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.

Specified by:

getCache in class CacheService

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

createCacheInstance

protected <K,V> Cache<K,V> createCacheInstance(String name,
                                               String cacheProvider)
                                        throws JahiaInitializationException

Throws:

JahiaInitializationException

getCache

public Cache getCache(String name)

Retrieves the specified region cache.

Specified by:

getCache in class CacheService

Parameters:

name - the cache region name, null is not allowed

Returns:

the cache instance

getNames

public Set<String> getNames()

Description copied from class: CacheService

Returns an iterator of all the cache names.

Specified by:

getNames in class CacheService

Returns:

an iterator of all the cache names.

flushAllCaches

public void flushAllCaches()

Description copied from class: CacheService

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.

Specified by:

flushAllCaches in class CacheService

getCacheProviders

public Map<String,CacheProvider> getCacheProviders()

Specified by:

getCacheProviders in class CacheService

setCacheProviders

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

Specified by:

setCacheProviders in class CacheService

getCacheProviderForCache

public Map<String,String> getCacheProviderForCache()

setCacheProviderForCache

public void setCacheProviderForCache(Map<String,String> cacheProviderForCache)