net.sf.ehcache.management
Interface CacheMBean

All Known Implementing Classes:

Cache

public interface CacheMBean

A management bean for a cache

Since:

1.3

Version:

$Id: CacheMBean.java 1214 2009-09-25 00:14:13Z gbevin $

Author:

Greg Luck

Method Summary

void	flush() Flushes all cache items from memory to the disk store, and from the DiskStore to disk.
CacheConfiguration	getCacheConfiguration() Gets the JMX read-only CacheConfiguration
java.lang.String	getName() Gets the cache name.
CacheStatistics	getStatistics() Gets the JMX cache statistics
java.lang.String	getStatus() Gets the status attribute of the Cache.
boolean	isTerracottaClustered() Uses a Terracotta clustered store.
void	removeAll() Removes all cached items.

Method Detail

removeAll

void removeAll()
               throws java.lang.IllegalStateException,
                      CacheException

Removes all cached items.

Throws:

java.lang.IllegalStateException - if the cache is not Status.STATUS_ALIVE

CacheException

flush

void flush()
           throws java.lang.IllegalStateException,
                  CacheException

Flushes all cache items from memory to the disk store, and from the DiskStore to disk.

Throws:

java.lang.IllegalStateException - if the cache is not Status.STATUS_ALIVE

CacheException

getStatus

java.lang.String getStatus()

Gets the status attribute of the Cache.

Returns:

The status value from the Status enum class

getName

java.lang.String getName()

Gets the cache name.

isTerracottaClustered

boolean isTerracottaClustered()

Uses a Terracotta clustered store.

getCacheConfiguration

CacheConfiguration getCacheConfiguration()

Gets the JMX read-only CacheConfiguration

getStatistics

CacheStatistics getStatistics()

Gets the JMX cache statistics