Package wt.jmx.core.mbeans

Interface PeriodicMemoryDumperDelegateMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
PeriodicMemoryDumperDelegate
public interface PeriodicMemoryDumperDelegateMBean extends SelfEmailingMBean
NotificationHandlerDelegateFactory that enters and exists a periodic memory usage dumping mode usage information based on notifications received.

When multiple instances of this MBean are used, the full memory dumping mode remains in effect as long as there are more entries into this mode than exits.

Currently not denoted as supported as this MBean is still somewhat experimental and details are subject to change.

Supported API: true

Extendable: false

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enterMemoryDumpingMode()
    Forcibly enter memory dumping mode.
    void
    exitMemoryDumpingMode()
    Forcibly exit memory dumping mode.
    int
    getMemoryDumpIntervalSeconds()
    Interval at which a memory dump will be logged when in memory dump mode; non-positive values disable this mode; value shared by all instances

    Supported API: true
    String
    getName()
    Name of this MBean

    Supported API: true
    String
    getStartDumpingNotificationTypes()
    Types of notification upon which memory dump mode should be entered; a null or empty value matches no notifications

    Supported API: true
    String
    getStopDumpingNotificationTypes()
    Types of notification upon which memory dump mode should be exited; only checked where the notification type does not match StartDumpingNotificationTypes; a null or empty value matches no notifications

    Supported API: true
    boolean
    isInMemoryDumpMode()
    Whether currently in memory dump mode

    Supported API: true
    void
    setMemoryDumpIntervalSeconds(int stackTraceIntervalSeconds)
    Interval at which a memory dump will be logged when in memory dump mode; non-positive values disable this mode; value shared by all instances

    Supported API: true
    void
    setStartDumpingNotificationTypes(String startDumpingNotificationTypes)
    Types of notification upon which memory dump mode should be entered; a null or empty value matches no notifications

    Supported API: true
    void
    setStopDumpingNotificationTypes(String stopDumpingNotificationTypes)
    Types of notification upon which memory dumping mode should be exited; only checked where the notification type does not match StartDumpingNotificationTypes; a null or empty value matches no notifications

    Supported API: true

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

    emailThisMBean

  • Method Details

    • getName

      String getName()
      Name of this MBean

      Supported API: true

    • isInMemoryDumpMode

      boolean isInMemoryDumpMode()
      Whether currently in memory dump mode

      Supported API: true

    • getMemoryDumpIntervalSeconds

      int getMemoryDumpIntervalSeconds()
      Interval at which a memory dump will be logged when in memory dump mode; non-positive values disable this mode; value shared by all instances

      Supported API: true

    • setMemoryDumpIntervalSeconds

      void setMemoryDumpIntervalSeconds(int stackTraceIntervalSeconds)
      Interval at which a memory dump will be logged when in memory dump mode; non-positive values disable this mode; value shared by all instances

      Supported API: true

    • getStartDumpingNotificationTypes

      String getStartDumpingNotificationTypes()
      Types of notification upon which memory dump mode should be entered; a null or empty value matches no notifications

      Supported API: true

    • setStartDumpingNotificationTypes

      void setStartDumpingNotificationTypes(String startDumpingNotificationTypes)
      Types of notification upon which memory dump mode should be entered; a null or empty value matches no notifications

      Supported API: true

    • getStopDumpingNotificationTypes

      String getStopDumpingNotificationTypes()
      Types of notification upon which memory dump mode should be exited; only checked where the notification type does not match StartDumpingNotificationTypes; a null or empty value matches no notifications

      Supported API: true

    • setStopDumpingNotificationTypes

      void setStopDumpingNotificationTypes(String stopDumpingNotificationTypes)
      Types of notification upon which memory dumping mode should be exited; only checked where the notification type does not match StartDumpingNotificationTypes; a null or empty value matches no notifications

      Supported API: true

    • enterMemoryDumpingMode

      @MBeanOperationImpact(1) void enterMemoryDumpingMode()
      Forcibly enter memory dumping mode.

      Supported API: true

    • exitMemoryDumpingMode

      @MBeanOperationImpact(1) void exitMemoryDumpingMode()
      Forcibly exit memory dumping mode.

      Supported API: true