Package 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$
    Author:
    Greg Luck

    • 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

      • getName

        java.lang.String getName()
        Gets the name of the cache manager
        Returns:
        The name of the CacheManager

      • 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

      • getTransactionCommittedCount

        long getTransactionCommittedCount()
        Get the committed transactions count
        Returns:
        the committed transactions count

      • getTransactionRolledBackCount

        long getTransactionRolledBackCount()
        Get the rolled back transactions count
        Returns:
        the rolled back transactions count

      • getTransactionTimedOutCount

        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:
        the timed out transactions count