net.sf.ehcache.management
Interface CacheManagerMBean

All Known Implementing Classes:

CacheManager

public interface CacheManagerMBean

An MBean interface for those attributes and operations we wish to expose on net.sf.ehcache.CacheManager

Since:

1.3

Version:

$Id: CacheManagerMBean.java 519 2007-07-27 07:11:45Z gregluck $

Author:

Greg Luck

Method Summary

void	clearAll() Clears the contents of all caches in the CacheManager, but without removing any caches.
Cache	getCache(java.lang.String name) Returns a JMX Cache bean
java.lang.String[]	getCacheNames() Gets the cache names managed by the CacheManager
java.util.List	getCaches() Gets a list of caches in this CacheManager
java.lang.String	getStatus() Gets the status attribute of the Ehcache
void	shutdown() Shuts down the CacheManager.

Method Detail

getStatus

java.lang.String getStatus()

Gets the status attribute of the Ehcache

Returns:

The status value, as a String from the Status enum class

shutdown

void shutdown()

Shuts down the CacheManager.

If the shutdown occurs on the singleton, then the singleton is removed, so that if a singleton access method is called, a new singleton will be created.

clearAll

void clearAll()

Clears the contents of all caches in the CacheManager, but without removing any caches.

This method is not synchronized. It only guarantees to clear those elements in a cache at the time that the Ehcache.removeAll() mehod on each cache is called.

getCache

Cache getCache(java.lang.String name)

Returns a JMX Cache bean

getCacheNames

java.lang.String[] getCacheNames()
                                 throws java.lang.IllegalStateException

Gets the cache names managed by the CacheManager

Throws:

java.lang.IllegalStateException

getCaches

java.util.List getCaches()

Gets a list of caches in this CacheManager

Returns:

a list of JMX Cache objects