Top Description Methods
net.sf.ehcache.management

public Interface CacheManagerMBean

Known Direct Implementers
net.sf.ehcache.management.CacheManager
Imports
java.util.List

An MBean interface for those attributes and operations we wish to expose on net.sf.ehcache.CacheManager
Author
Greg Luck
Since
1.3
Version
$Id: CacheManagerMBean.java 10789 2018-04-26 02:08:13Z adahanne $

Method Summary

Modifier and TypeMethod and Description
public void
clearAll()

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

public Cache
getCache(String name)

Returns a JMX Cache bean

public String[]
getCacheNames()

Gets the cache names managed by the CacheManager

public List<E>

Returns:

a list of JMX Cache objects
getCaches
()

Gets a list of caches in this CacheManager

public String

Returns:

The name of the CacheManager
getName
()

Gets the name of the cache manager

public String

Returns:

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

Gets the status attribute of the Ehcache

public long

Returns:

the committed transactions count
getTransactionCommittedCount
()

Get the committed transactions count

public long

Returns:

the rolled back transactions count
getTransactionRolledBackCount
()

Get the rolled back transactions count

public long

Returns:

the timed out transactions count
getTransactionTimedOutCount
()

Get the timed out transactions count.

public void
shutdown()

Shuts down the CacheManager.

Method Detail

clearAllback to summary
public 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 net.sf.ehcache.Ehcache#removeAll() mehod on each cache is called.

getCacheback to summary
public Cache getCache(String name)

Returns a JMX Cache bean

getCacheNamesback to summary
public String[] getCacheNames() throws IllegalStateException

Gets the cache names managed by the CacheManager

getCachesback to summary
public List<E> getCaches()

Gets a list of caches in this CacheManager

Returns:List<E>

a list of JMX Cache objects

getNameback to summary
public String getName()

Gets the name of the cache manager

Returns:String

The name of the CacheManager

getStatusback to summary
public String getStatus()

Gets the status attribute of the Ehcache

Returns:String

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

getTransactionCommittedCountback to summary
public long getTransactionCommittedCount()

Get the committed transactions count

Returns:long

the committed transactions count

getTransactionRolledBackCountback to summary
public long getTransactionRolledBackCount()

Get the rolled back transactions count

Returns:long

the rolled back transactions count

getTransactionTimedOutCountback to summary
public long getTransactionTimedOutCount()

Get the timed out transactions count. Note that only transactions which failed to commit due to a timeout are taken into account

Returns:long

the timed out transactions count

shutdownback to summary
public 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.