Package wt.cache

Interface MainCacheManagerMBean

All Superinterfaces:
SelfEmailingMBean
All Known Subinterfaces:
MasterICacheManagerMBean
All Known Implementing Classes:
MainCacheManager, MasterICacheManager
public interface MainCacheManagerMBean extends SelfEmailingMBean
Provides centralized cache management instrumentation and monitoring.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    clearAllCaches()
    Clears all entries from all ICacheManagerClassic-managed caches.
    int
    getLogCacheMBeanIntervalSeconds()
    Interval at which to automatically invoke logCacheMBeans(); non-positive values disable this feature

    Supported API: true
    String
    getLoggerLevel()
    The logger level (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF).
    int
    getNumCaches()
    Number of cache MBeans, irrespective of sub-type

    Supported API: true
    int
    getOversizedCheckInterval()
    Interval between periodic oversized check in days; periodic check performed only if positive and CheckOversized is true

    Supported API: true
    long
    getUptime()
    Time since cache infrastructure [re]start (in milliseconds)

    Supported API: true
    boolean
    isCheckOversized()
    Whether to periodically run the oversized check; periodic check performed only if true and OversizedCheckInterval is positive
    void
    logCacheMBeans()
    Invoke log() operation on all cache MBeans

    Supported API: true
    void
    runOversizedCheck()
    Forces every ICacheManagerClassic-managed cache to run it's oversized check and logs/sends JMX notifications of oversized caches.
    void
    setCheckOversized(boolean checkOversized)
    Whether to periodically run the oversized check; periodic check performed only if true and OversizedCheckInterval is positive

    Supported API: true
    void
    setLogCacheMBeanIntervalSeconds(int logCacheMBeanIntervalSeconds)
    Interval at which to automatically invoke logCacheMBeans(); non-positive values disable this feature

    Supported API: true
    void
    setLoggerLevel(String level)
    The logger level (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF).
    void
    setOversizedCheckInterval(int interval)
    Interval between periodic oversized check in days; periodic check performed only if positive and CheckOversized is true

    Supported API: true

    Methods inherited from interface wt.jmx.core.mbeans.SelfEmailingMBean

    emailThisMBean

  • Method Details

    • runOversizedCheck

      @MBeanOperationImpact(1) void runOversizedCheck()
      Forces every ICacheManagerClassic-managed cache to run it's oversized check and logs/sends JMX notifications of oversized caches.

      Supported API: true

    • clearAllCaches

      @MBeanOperationImpact(1) void clearAllCaches()
      Clears all entries from all ICacheManagerClassic-managed caches.

      Warning: Running this operation on an in-use system can cause significant disruptions.

      Supported API: true

    • getOversizedCheckInterval

      int getOversizedCheckInterval()
      Interval between periodic oversized check in days; periodic check performed only if positive and CheckOversized is true

      Supported API: true
      Returns:
      The interval between oversized checks in days

    • setOversizedCheckInterval

      void setOversizedCheckInterval(int interval)
      Interval between periodic oversized check in days; periodic check performed only if positive and CheckOversized is true

      Supported API: true
      Parameters:
      interval - Desired interval between oversized checks in days

    • isCheckOversized

      boolean isCheckOversized()
      Whether to periodically run the oversized check; periodic check performed only if true and OversizedCheckInterval is positive
      Returns:
      Whether the oversized check is being run periodically

      Supported API: true

    • setCheckOversized

      void setCheckOversized(boolean checkOversized)
      Whether to periodically run the oversized check; periodic check performed only if true and OversizedCheckInterval is positive

      Supported API: true
      Parameters:
      checkOversized - Whether to run the oversized check periodically

    • getNumCaches

      int getNumCaches()
      Number of cache MBeans, irrespective of sub-type

      Supported API: true

    • setLoggerLevel

      void setLoggerLevel(String level)
      The logger level (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF).

      Supported API: true
      Parameters:
      level - The new logger level (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

    • getLoggerLevel

      String getLoggerLevel()
      The logger level (valid values are ALL, TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF).

      Supported API: true

    • getUptime

      long getUptime()
      Time since cache infrastructure [re]start (in milliseconds)

      Supported API: true

    • getLogCacheMBeanIntervalSeconds

      int getLogCacheMBeanIntervalSeconds()
      Interval at which to automatically invoke logCacheMBeans(); non-positive values disable this feature

      Supported API: true

    • setLogCacheMBeanIntervalSeconds

      void setLogCacheMBeanIntervalSeconds(int logCacheMBeanIntervalSeconds)
      Interval at which to automatically invoke logCacheMBeans(); non-positive values disable this feature

      Supported API: true

    • logCacheMBeans

      @MBeanOperationImpact(1) void logCacheMBeans()
      Invoke log() operation on all cache MBeans

      Supported API: true