Package wt.jmx.core.mbeans

Interface HeapDumpDelegateMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
HeapDumpDelegate
public interface HeapDumpDelegateMBean extends SelfEmailingMBean
NotificationHandlerDelegateFactory that produces a heap dump whenever a notification is received.

Note this will only function in a Java 6 or higher JVM which provides a com.sun.management:type=HotSpotDiagnostic MBean with a heapDump(String,boolean) operation.

Supported API: true

Extendable: true

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    dumpHeap()
    Produce a heap dump to the specified directory with the specified base name and returns the name of the heap dump file

    Supported API: true
    String
    getBaseDir()
    Directory which relative DumpDir paths are interpreted as being relative to

    Supported API: true
    String
    getBaseFilename()
    Base filename (prefix) used for generated heap dumps

    Supported API: true
    String
    getDumpDir()
    Directory in which heap dumps are generated

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

    Supported API: true
    boolean
    isLiveRefsOnly()
    Whether only live references should be captured in heap dumps

    Supported API: true
    String
    sendHeapDumpToSupport(long callNumber, String description)
    Generates a heap dump as per dumpHeap() operation and sends it to technical support; returns the name of the heap dump file

    Supported API: true
    void
    setBaseFilename(String baseFilename)
    Base filename (prefix) used for generated heap dumps

    Supported API: true
    void
    setDumpDir(String dumpDirString)
    Directory in which heap dumps are generated

    Supported API: true
    void
    setLiveRefsOnly(boolean liveRefsOnly)
    Whether only live references should be captured in heap dumps

    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

    • getBaseDir

      String getBaseDir()
      Directory which relative DumpDir paths are interpreted as being relative to

      Supported API: true

    • getDumpDir

      String getDumpDir()
      Directory in which heap dumps are generated

      Supported API: true

    • setDumpDir

      void setDumpDir(String dumpDirString)
      Directory in which heap dumps are generated

      Supported API: true

    • getBaseFilename

      String getBaseFilename()
      Base filename (prefix) used for generated heap dumps

      Supported API: true

    • setBaseFilename

      void setBaseFilename(String baseFilename)
      Base filename (prefix) used for generated heap dumps

      Supported API: true

    • isLiveRefsOnly

      boolean isLiveRefsOnly()
      Whether only live references should be captured in heap dumps

      Supported API: true

    • setLiveRefsOnly

      void setLiveRefsOnly(boolean liveRefsOnly)
      Whether only live references should be captured in heap dumps

      Supported API: true

    • dumpHeap

      @MBeanOperationImpact(0) String dumpHeap() throws InstanceNotFoundException, MBeanException, ReflectionException
      Produce a heap dump to the specified directory with the specified base name and returns the name of the heap dump file

      Supported API: true
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • sendHeapDumpToSupport

      @MBeanOperationImpact(0) String sendHeapDumpToSupport(long callNumber, String description) throws Exception
      Generates a heap dump as per dumpHeap() operation and sends it to technical support; returns the name of the heap dump file

      Supported API: true
      Parameters:
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      Throws:
      Exception