|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectnet.sf.ehcache.CacheManager
public final class CacheManager
A container for Cache
s that maintain all aspects of their lifecycle.
Constructor Summary | |
---|---|
CacheManager()
Constructor. |
|
CacheManager(Configuration configuration)
An constructor for CacheManager, which takes a configuration object, rather than one created by parsing an ehcache.xml file. |
|
CacheManager(java.io.InputStream configurationInputStream)
An ordinary constructor for CacheManager. |
|
CacheManager(java.lang.String configurationFileName)
An ordinary constructor for CacheManager. |
|
CacheManager(java.net.URL configurationURL)
An ordinary constructor for CacheManager. |
Method Summary | |
---|---|
void |
addCache(Cache cache)
Adds a Cache to the CacheManager. |
void |
addCache(java.lang.String cacheName)
Adds a Cache based on the defaultCache with the given name. |
boolean |
cacheExists(java.lang.String cacheName)
Checks whether a cache exists. |
static CacheManager |
create()
A factory method to create a singleton CacheManager with default config, or return it if it exists. |
static CacheManager |
create(java.io.InputStream inputStream)
A factory method to create a singleton CacheManager from a java.io.InputStream. |
static CacheManager |
create(java.lang.String configurationFileName)
A factory method to create a singleton CacheManager with a specified configuration. |
static CacheManager |
create(java.net.URL configurationFileURL)
A factory method to create a singleton CacheManager from an URL. |
Cache |
getCache(java.lang.String name)
Gets a Cache |
CacheManagerEventListener |
getCacheManagerEventListener()
Gets the CacheManager event listener. |
java.lang.String[] |
getCacheNames()
Returns a list of the current cache names. |
CacheManagerPeerListener |
getCachePeerListener()
When CacheManage is configured as part of a cluster, a CacheManagerPeerListener will be registered in it. |
CacheManagerPeerProvider |
getCachePeerProvider()
Gets the CacheManagerPeerProvider
For distributed caches, the peer provider finds other cache managers and their caches in the same cluster |
static CacheManager |
getInstance()
A factory method to create a singleton CacheManager with default config, or return it if it exists. |
Status |
getStatus()
Gets the status attribute of the Cache |
void |
removalAll()
Removes all caches using removeCache(java.lang.String) for each cache. |
void |
removeCache(java.lang.String cacheName)
Remove a cache from the CacheManager. |
void |
setCacheManagerEventListener(CacheManagerEventListener cacheManagerEventListener)
Sets the CacheManager event listener. |
void |
shutdown()
Shuts down the CacheManager. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public CacheManager(Configuration configuration) throws CacheException
create()
methods are called, a new singleton instance will be created,
separate from any instances created in this method.
configuration
-
CacheException
public CacheManager(java.lang.String configurationFileName) throws CacheException
create()
methods are called, a new singleton will be created,
separate from any instances created in this method.
configurationFileName
- an xml configuration file available through a file name. The configuration
File
is created
using new File(configurationFileName)
CacheException
create(String)
public CacheManager(java.net.URL configurationURL) throws CacheException
create()
methods are called, a new singleton will be created,
separate from any instances created in this method.
This method can be used to specify a configuration resource in the classpath other
than the default of \"/ehcache.xml\":
URL url = this.getClass().getResource("/ehcache-2.xml");Note that
Class.getResource(java.lang.String)
will look for resources in the same package unless a leading "/"
is used, in which case it will look in the root of the classpath.
You can also load a resource using other class loaders. e.g. Thread.getContextClassLoader()
configurationURL
- an xml configuration available through a URL.
CacheException
create(java.net.URL)
public CacheManager(java.io.InputStream configurationInputStream) throws CacheException
create()
methods are called, a new singleton will be created,
separate from any instances created in this method.
configurationInputStream
- an xml configuration file available through an inputstream
CacheException
create(java.io.InputStream)
public CacheManager() throws CacheException
CacheException
Method Detail |
---|
public static CacheManager create() throws CacheException
Cache
s created and required stores initialized.
When the CacheManager
is no longer required, call shutdown to free resources.
CacheException
- if the CacheManager cannot be createdpublic static CacheManager getInstance() throws CacheException
create()
Same as create()
CacheException
- if the CacheManager cannot be createdpublic static CacheManager create(java.lang.String configurationFileName) throws CacheException
configurationFileName
- an xml file compliant with the ehcache.xsd schema
The configuration will be read, Cache
s created and required stores initialized.
When the CacheManager
is no longer required, call shutdown to free resources.
CacheException
public static CacheManager create(java.net.URL configurationFileURL) throws CacheException
URL url = this.getClass().getResource("/ehcache-2.xml");Note that
Class.getResource(java.lang.String)
will look for resources in the same package unless a leading "/"
is used, in which case it will look in the root of the classpath.
You can also load a resource using other class loaders. e.g. Thread.getContextClassLoader()
configurationFileURL
- an URL to an xml file compliant with the ehcache.xsd schema
The configuration will be read, Cache
s created and required stores initialized.
When the CacheManager
is no longer required, call shutdown to free resources.
CacheException
public static CacheManager create(java.io.InputStream inputStream) throws CacheException
inputStream
- InputStream of xml compliant with the ehcache.xsd schema
The configuration will be read, Cache
s created and required stores initialized.
When the CacheManager
is no longer required, call shutdown to free resources.
CacheException
public Cache getCache(java.lang.String name) throws java.lang.IllegalStateException
java.lang.IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public void addCache(java.lang.String cacheName) throws java.lang.IllegalStateException, ObjectExistsException, CacheException
Cache
based on the defaultCache with the given name.
Memory and Disk stores will be configured for it and it will be added
to the map of caches.
Also notifies the CacheManagerEventListener after the cache was initialised and added.
It will be created with the defaultCache attributes specified in ehcache.xml
cacheName
- the name for the cache
ObjectExistsException
- if the cache already exists
CacheException
- if there was an error creating the cache.
java.lang.IllegalStateException
public void addCache(Cache cache) throws java.lang.IllegalStateException, ObjectExistsException, CacheException
Cache
to the CacheManager.
Memory and Disk stores will be configured for it and it will be added to the map of caches.
Also notifies the CacheManagerEventListener after the cache was initialised and added.
cache
-
java.lang.IllegalStateException
- if the cache is not Status.STATUS_UNINITIALISED
before this method is called.
ObjectExistsException
- if the cache already exists in the CacheManager
CacheException
- if there was an error adding the cache to the CacheManagerpublic boolean cacheExists(java.lang.String cacheName) throws java.lang.IllegalStateException
cacheName
- the cache name to check for
java.lang.IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public void removalAll()
removeCache(java.lang.String)
for each cache.
public void removeCache(java.lang.String cacheName) throws java.lang.IllegalStateException
cacheName
- the cache name
java.lang.IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public void shutdown()
public java.lang.String[] getCacheNames() throws java.lang.IllegalStateException
String
s
java.lang.IllegalStateException
- if the cache is not Status.STATUS_ALIVE
public Status getStatus()
public CacheManagerPeerProvider getCachePeerProvider()
CacheManagerPeerProvider
For distributed caches, the peer provider finds other cache managers and their caches in the same cluster
public CacheManagerPeerListener getCachePeerListener()
public CacheManagerEventListener getCacheManagerEventListener()
public void setCacheManagerEventListener(CacheManagerEventListener cacheManagerEventListener)
cacheManagerEventListener
- the listener to set.
|
ehcache | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |