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 5594 2012-05-07 16:04:31Z cdennis $

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
String	getName() Gets the cache name.
CacheStatistics	getStatistics() Gets the JMX cache statistics
String	getStatus() Gets the status attribute of the Cache.
boolean	hasAbortedSizeOf() Check if the cache may contain elements which the SizeOf engine could not fully size.
boolean	isTerracottaClustered() Uses a Terracotta clustered store.
void	removeAll() Removes all cached items.

Method Detail

removeAll

void removeAll()
               throws IllegalStateException,
                      CacheException

Removes all cached items.

Throws:

IllegalStateException - if the cache is not Status.STATUS_ALIVE

CacheException

flush

void flush()
           throws IllegalStateException,
                  CacheException

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

Throws:

IllegalStateException - if the cache is not Status.STATUS_ALIVE

CacheException

getStatus

String getStatus()

Gets the status attribute of the Cache.

Returns:

The status value from the Status enum class

getName

String getName()

Gets the cache name.

isTerracottaClustered

boolean isTerracottaClustered()

Uses a Terracotta clustered store.

hasAbortedSizeOf

boolean hasAbortedSizeOf()

Check if the cache may contain elements which the SizeOf engine could not fully size.

getCacheConfiguration

CacheConfiguration getCacheConfiguration()

Gets the JMX read-only CacheConfiguration

getStatistics

CacheStatistics getStatistics()

Gets the JMX cache statistics