org.apache.directory.server.core.api

Class CacheService

java.lang.Object

org.apache.directory.server.core.api.CacheService

public class CacheService
extends Object

A ehcache based cache service to be used for various caching requirement in the server. If a cache config file with the name DIRECTORY_CACHESERVICE_XML is present in the "workdirectory" of the DirectoryService then that file will be used for configuring the CacheManager, if not a default cache configuration file bundled along with this class is used

Author:

Apache Directory Project

Constructor Summary

Constructors

Constructor and Description
CacheService() Creates a new instance of CacheService.
CacheService(net.sf.ehcache.CacheManager cachemanager) Creates a new instance of CacheService with the given cache manager.

Method Summary

Modifier and Type	Method and Description
void	destroy() Clear the cache and shutdown it
net.sf.ehcache.Cache	getCache(String name) Get a specific cache from its name, or create a new one
void	initialize(InstanceLayout layout) Initialize the CacheService
void	initialize(InstanceLayout layout, String instanceId) Initialize the CacheService
void	remove(String name) Remove a cache if it exists.

Methods inherited from class java.lang.Object

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

Constructor Detail

CacheService

public CacheService()

Creates a new instance of CacheService.

CacheService

public CacheService(net.sf.ehcache.CacheManager cachemanager)

Creates a new instance of CacheService with the given cache manager.

Parameters:

cachemanager - The provided CaxcheManager instance

Method Detail

initialize

public void initialize(InstanceLayout layout)

Initialize the CacheService

Parameters:

layout - The place on disk where the cache configuration will be stored

initialize

public void initialize(InstanceLayout layout,
                       String instanceId)

Initialize the CacheService

Parameters:

layout - The place on disk where the cache configuration will be stored

instanceId - The Instance identifier

destroy

public void destroy()

Clear the cache and shutdown it

getCache

public net.sf.ehcache.Cache getCache(String name)

Get a specific cache from its name, or create a new one

Parameters:

name - The Cache name we want to retreive

Returns:

The found cache. If we don't find it, we create a new one.

remove

public void remove(String name)

Remove a cache if it exists.

Parameters:

name - The Cache's name we want to remove