Package wt.jmx.core.mbeans

Interface DumperMBean

All Superinterfaces:
SelfEmailingMBean
All Known Implementing Classes:
Dumper
public interface DumperMBean extends SelfEmailingMBean
Provides a number of generic operations to dump threading and various bulk information to a JMX console or e-mail.

Supported API: true

Extendable: true

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    DEADLOCK_DETECTED_NOTIF_TYPE
    Type of notification fired when a deadlock is detected by the periodic deadlock checker

    Supported API: true

  • Method Summary

    Modifier and Type
    Method
    Description
    CompositeData[]
    checkResources(String resourceName)
    Returns various properties (to support comparison and sanity checking) for all the resources with the given name found by this MBean's classloader.
    String[]
    dumpAllMBeans()
    Get data (as XML) on all MBeans in this MBeanServer

    Supported API: true
    void
    dumpAllMBeansToFile(String outputFileRef, String xslt, boolean applyXslt)
    Dump the current state of all the MBeans to a file

    Supported API: true
    byte[]
    dumpAllMBeansToGzippedBytes(String xslt, boolean applyXslt)
    Get gzip compressed data (as XML) on all MBeans in this MBeanServer

    Supported API: true
    String[]
    dumpFullStackTrace()
    Get full stack trace of all threads; same as FullStackTrace attribute but easier to use as an operation in some consoles

    Supported API: true
    void
    dumpFullStackTraceToFile()
    Dump full stack trace of all threads to a file in directory defined by wt.logs.dir property or current working directory if that property is undefined.
    void
    dumpHeap(String fileToDumpTo, boolean liveRefsOnly)
    Generate heap dump to the specified file; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with a heapDump(String,boolean) operation.
    String[]
    dumpMBeans(ObjectName objectNamePattern)
    Get data (as XML) on all MBeans in this MBeanServer that match the ObjectName query pattern

    Supported API: true
    String[]
    dumpMBeans(ObjectName[] objectNames)
    Get data (as XML) on specified MBeans in this MBeanServer

    Supported API: true
    void
    dumpMBeansToFile(ObjectName[] objectNames, String outputFileRef, String xslt, boolean applyXslt)
    Dump the current state of all the MBeans to a file

    Supported API: true
    void
    dumpMBeansToFile(ObjectName objectNamePattern, String outputFileRef, String xslt, boolean applyXslt)
    Dump the current state of all the MBeans to a file

    Supported API: true
    byte[]
    dumpMBeansToGzippedBytes(ObjectName[] objectNames, String xslt, boolean applyXslt)
    Get gzip compressed data (as XML) on specified MBeans in this MBeanServer

    Supported API: true
    byte[]
    dumpMBeansToGzippedBytes(ObjectName objectNamePattern, String xslt, boolean applyXslt)
    Get gzip compressed data (as XML) on all MBeans in this MBeanServer that match the ObjectName query pattern

    Supported API: true
    void
    emailAllMBeans(String addressesOrEmailList, String subject, boolean compress)
    E-mail styled data on all MBeans in this MBeanServer using the default styling as specified by DefaultXsltStylesheet

    Supported API: true
    void
    emailAllMBeans(String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt)
    E-mail styled data on all MBeans in this MBeanServer, styling as specified by the 'xslt' parameter

    Supported API: true
    void
    emailFile(String fileRef, String addressesOrEmailList, String subject, boolean compress)
    E-mail entire file as an attachment optionally compressing it.
    void
    emailFullStackTrace(String addressesOrEmailList, String subject)
    E-mail full stack trace of all threads

    Supported API: true
    void
    emailMBeans(ObjectName[] objectNames, String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt)
    E-mail styled data for specified MBeans from this MBeanServer, styling as specified by the 'xslt' parameter

    Supported API: true
    void
    emailMBeans(ObjectName objectNamePattern, String addressesOrEmailList, String subject, boolean compress)
    E-mail styled data on all MBeans in this MBeanServer that match the ObjectName query pattern using the default styling as specified by DefaultXsltStylesheet

    Supported API: true
    void
    emailMBeans(ObjectName objectNamePattern, String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt)
    E-mail styled data on all MBeans in this MBeanServer that match the ObjectName query pattern, styling as specified by the 'xslt' parameter

    Supported API: true
    void
    emailTextFile(String fileRef, String addressesOrEmailList, String subject, long maxLines, long maxChars)
    E-mail last portion of text file.
    Object
    executeScript(String scriptEngineShortName, String script)
    Executes/evaluates the specified script via the specified script engine and returns the result.
    Object
    executeScript(String scriptEngineShortName, String script, Object[] scriptArgs)
    Executes/evaluates the specified script via the specified script engine and returns the result.
    Map<ObjectName,AttributeList>[]
    getAttributes(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[][] attributeNamesArrs)
    Fetches attribute values from multiple JMX MBeans in one request.
    int
    getDeadlockCheckIntervalSeconds()
    Number of seconds between checks for deadlocked threads; if one is found a notification is fired; non-positive values disable checking

    Supported API: true
    long[]
    getDeadlockedThreadIds()
    Ids of any threads currently detected to be deadlocked

    Supported API: true
    String
    getDefaultNewEntryRegexp()
    Default regular expression used to semi-heuristically determine a "new entry" in files.
    String
    getDefaultXsltStylesheet()
    Reference (URL, file, or resource) to default XSLT stylesheet

    Supported API: true
    String
    getDefaultXsltStylesheetURL()
    Default XSLT stylesheet URL used by operations which return styled MBean data when this parameter is not specified

    Supported API: true
    String[]
    getFullStackTrace()
    Full stack trace of all threads; provided as attribute in addition to dumpFullStackTrace() operation to expose to Summary and NotificationHandler MBean

    Supported API: true
    String
    getHeapDumpPath()
    Where heap dumps should be produced by this process by default; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.
    MBeanInfo
    getMBeanInfo(ObjectName objectName)
    Fetches MBeanInfo for specified MBean.
    Map<ObjectName,MBeanInfo>[]
    getMBeanInfos(ObjectName[] objectNamePatterns, QueryExp[] queryExps)
    Fetches MBeanInfos from multiple JMX MBeans in one request.
    String[]
    getResources(String resourceName)
    Returns a list of URLs (as strings) representing all the resources with the given name found by this MBean's classloader.
    Object
    invokeInfoOperation(ObjectName mbean, String operation, Object[] params, String[] signature)
    Invoke an operation with an INFO (read-only) impact on an MBean.
    Map<ObjectName,Object>[]
    invokeInfoOperations(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[] operations, Object[][] paramArrs, String[][] signatures)
    Invoke multiple operations with INFO (read-only) impact in one request.
    Map<ObjectName,Object>[]
    invokeOperations(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[] operations, Object[][] paramArrs, String[][] signatures)
    Invokes multiple JMX operations in one request.
    boolean
    isHeapDumpOnOutOfMemoryError()
    Whether a heap dump should be produced upon an out-of-memory error; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.
    void
    logComment(String comment)
    Log comment to wt.jmx.core.mbeans.Dumper.comments logger at INFO level (and this logger defaults to INFO level verbosity)

    Supported API: true
    void
    logFullStackTrace()
    Log full stack trace of all threads to wt.jmx.core.mbeans.Dumper.stacktraces logger at INFO level (and this logger defaults to INFO level verbosity)

    Supported API: true
    String[]
    searchTextFile(String fileRef, String searchRegexp, boolean numberLines)
    View all lines of a file that match a specified regular expression.
    String[]
    searchTextFile(String fileRef, String searchRegexp, String newEntryRegexp, boolean numberLines)
    View all "entries" from a file that match a specified regular expression.
    String[]
    searchTextFile(String fileRef, String searchRegexp, String newEntryRegexp, boolean numberLines, int maxLines)
    View all "entries" from a file that match a specified regular expression.
    void
    sendAllMBeansToSupport(long callNumber, String description)
    Send styled data for all MBeans from this MBeanServer to technical support

    Supported API: true
    void
    sendAllMBeansToSupport(long callNumber, String description, String baseFilenameNoSuffix)
    Send styled data for all MBeans from this MBeanServer to technical support

    Supported API: true
    void
    sendDirToSupport(String dir, long callNumber, String description)
    Send contents of a specified directory to technical support

    Supported API: true
    void
    sendDirToSupport(String dir, long callNumber, String description, boolean recursive, int maxAgeInDays, int minAgeInDays, String matchingExpression)
    Send contents of a specified directory to technical support

    Supported API: true
    void
    sendFileToSupport(String fileRef, long callNumber, String description)
    Send a specified file to technical support

    Supported API: true
    String[]
    sendFullStackTraceToSupport(long callNumber, String description)
    Performs the same operation as dumpFullStackTrace() except that the stack trace is also sent to technical support

    Supported API: true
    void
    sendHeapDumpToSupport(long callNumber, String description)
    Generates a heap dump as per dumpHeap() operation and sends it to technical support, removing the file upon completion

    Supported API: true
    void
    sendLogsDirsToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression)
    For each LogsDirViewer MBean, send log files from its target log directory to tech support filtering as specified

    Supported API: true
    void
    sendLogsDirsToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression, String[] logsDirViewersToSkip)
    For each LogsDirViewer MBean, send log files from its target log directory to tech support filtering as specified

    Supported API: true
    Map<ObjectName,AttributeList>[]
    setAttributes(ObjectName[] objectNamePatterns, QueryExp[] queryExps, AttributeList[] attributeLists)
    Sets attribute values on multiple JMX MBeans in one request.
    void
    setDeadlockCheckIntervalSeconds(int deadlockCheckIntervalSeconds)
    Number of seconds between checks for deadlocked threads; if one is found a notification is fired; non-positive values disable checking

    Supported API: true
    void
    setDefaultNewEntryRegexp(String defaultNewEntryRegexp)
    Default regular expression used to semi-heuristically determine a "new entry" in files.
    void
    setDefaultXsltStylesheet(String defaultXsltStylesheet)
    Reference (URL, file, or resource) to default XSLT stylesheet

    Supported API: true
    void
    setHeapDumpOnOutOfMemoryError(boolean heapDumpOnOutOfMemoryError)
    Whether a heap dump should be produced upon an out-of-memory error; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.
    void
    setHeapDumpPath(String heapDumpPath)
    Where heap dumps should be produced by this process by default; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.
    String[]
    viewTextFile(String fileRef, long maxLines, long maxChars)
    View last portion of text file.

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

    emailThisMBean

  • Field Details

    • DEADLOCK_DETECTED_NOTIF_TYPE

      static final String DEADLOCK_DETECTED_NOTIF_TYPE
      Type of notification fired when a deadlock is detected by the periodic deadlock checker

      Supported API: true

  • Method Details

    • getDeadlockCheckIntervalSeconds

      int getDeadlockCheckIntervalSeconds()
      Number of seconds between checks for deadlocked threads; if one is found a notification is fired; non-positive values disable checking

      Supported API: true

    • setDeadlockCheckIntervalSeconds

      void setDeadlockCheckIntervalSeconds(int deadlockCheckIntervalSeconds)
      Number of seconds between checks for deadlocked threads; if one is found a notification is fired; non-positive values disable checking

      Supported API: true

    • getDeadlockedThreadIds

      long[] getDeadlockedThreadIds()
      Ids of any threads currently detected to be deadlocked

      Supported API: true

    • getFullStackTrace

      String[] getFullStackTrace()
      Full stack trace of all threads; provided as attribute in addition to dumpFullStackTrace() operation to expose to Summary and NotificationHandler MBean

      Supported API: true

    • getDefaultXsltStylesheetURL

      String getDefaultXsltStylesheetURL()
      Default XSLT stylesheet URL used by operations which return styled MBean data when this parameter is not specified

      Supported API: true

    • getDefaultXsltStylesheet

      String getDefaultXsltStylesheet()
      Reference (URL, file, or resource) to default XSLT stylesheet

      Supported API: true

    • setDefaultXsltStylesheet

      void setDefaultXsltStylesheet(String defaultXsltStylesheet)
      Reference (URL, file, or resource) to default XSLT stylesheet

      Supported API: true

    • getDefaultNewEntryRegexp

      String getDefaultNewEntryRegexp()
      Default regular expression used to semi-heuristically determine a "new entry" in files. Used by the searchTextFile() operation.

      Supported API: true

    • setDefaultNewEntryRegexp

      void setDefaultNewEntryRegexp(String defaultNewEntryRegexp)
      Default regular expression used to semi-heuristically determine a "new entry" in files. Used by the searchTextFile() operation.

      Supported API: true

    • isHeapDumpOnOutOfMemoryError

      boolean isHeapDumpOnOutOfMemoryError() throws InstanceNotFoundException, MBeanException, ReflectionException
      Whether a heap dump should be produced upon an out-of-memory error; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.

      Supported API: true
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • setHeapDumpOnOutOfMemoryError

      void setHeapDumpOnOutOfMemoryError(boolean heapDumpOnOutOfMemoryError) throws InstanceNotFoundException, MBeanException, ReflectionException
      Whether a heap dump should be produced upon an out-of-memory error; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.

      Supported API: true
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • getHeapDumpPath

      String getHeapDumpPath() throws InstanceNotFoundException, MBeanException, ReflectionException
      Where heap dumps should be produced by this process by default; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.

      Supported API: true
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • setHeapDumpPath

      void setHeapDumpPath(String heapDumpPath) throws InstanceNotFoundException, MBeanException, ReflectionException
      Where heap dumps should be produced by this process by default; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with an appropriate DiagnosticOptions attribute and setVMOption(String,String) operation.

      Supported API: true
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • searchTextFile

      @MBeanOperationImpact(2) String[] searchTextFile(String fileRef, String searchRegexp, boolean numberLines) throws IOException
      View all lines of a file that match a specified regular expression.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to view any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) of file to search
      searchRegexp - Regular expression to search with
      numberLines - Whether resulting lines should include original line numbers
      Throws:
      IOException

    • searchTextFile

      @MBeanOperationImpact(2) String[] searchTextFile(String fileRef, String searchRegexp, String newEntryRegexp, boolean numberLines) throws IOException
      View all "entries" from a file that match a specified regular expression.

      Lines which match 'newEntryRegexp' are interpreted as the beginning of new entries in the file whereas all other lines are interpreted as belonging to the same entry as the last such line. This allows one to specify a semi-heuristic regular expression to keep a log4j log line and its stack trace together, for instance.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to view any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) of file to search
      searchRegexp - Regular expression to search with
      newEntryRegexp - Regular expression which indicate the first line of an "entry"; if null or empty, the value of the DefaultNewEntryRegexp is used
      numberLines - Whether resulting lines should include original line numbers
      Throws:
      IOException

    • searchTextFile

      @MBeanOperationImpact(2) String[] searchTextFile(String fileRef, String searchRegexp, String newEntryRegexp, boolean numberLines, int maxLines) throws IOException
      View all "entries" from a file that match a specified regular expression.

      Lines which match 'newEntryRegexp' are interpreted as the beginning of new entries in the file whereas all other lines are interpreted as belonging to the same entry as the last such line. This allows one to specify a semi-heuristic regular expression to keep a log4j log line and its stack trace together, for instance.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to view any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) of file to search
      searchRegexp - Regular expression to search with
      newEntryRegexp - Regular expression which indicate the first line of an "entry"; if null or empty, the value of the DefaultNewEntryRegexp is used
      numberLines - Whether resulting lines should include original line numbers
      maxLines - Maximum lines to return from any given file (not including elision line); negative values imply no limit
      Throws:
      IOException

    • viewTextFile

      @MBeanOperationImpact(2) String[] viewTextFile(String fileRef, long maxLines, long maxChars) throws IOException
      View last portion of text file.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to view any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) to file to view
      maxLines - Maximum number of lines to include; non-positive numbers imply no limit
      maxChars - Maximum number of characters to include; non-positive numbers imply no limit
      Throws:
      IOException

    • emailFile

      @MBeanOperationImpact(2) void emailFile(String fileRef, String addressesOrEmailList, String subject, boolean compress) throws IOException
      E-mail entire file as an attachment optionally compressing it.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to e-mail any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) to file to e-mail
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether to compress the file attachement
      Throws:
      IOException

    • emailTextFile

      @MBeanOperationImpact(2) void emailTextFile(String fileRef, String addressesOrEmailList, String subject, long maxLines, long maxChars) throws IOException
      E-mail last portion of text file.

      Note that this operation is considered to have an ACTION_INFO (i.e. "read and write") impact even though it does not change any server state. This is due to the fact that it can be used to e-mail any text file readable by the given process, including files which may contain sensitive information such as passwords. This operation is thus restricted to those users with the broadest possible access and privileges.

      Supported API: true

      Parameters:
      fileRef - Reference (URL, file, or resource) to file to e-mail
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      maxLines - Maximum number of lines to include; non-positive numbers imply no limit
      maxChars - Maximum number of characters to include; non-positive numbers imply no limit
      Throws:
      IOException

    • sendFileToSupport

      @MBeanOperationImpact(0) void sendFileToSupport(String fileRef, long callNumber, String description) throws Exception
      Send a specified file to technical support

      Supported API: true
      Parameters:
      fileRef - Reference (URL, file, or resource) to file to send
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      Throws:
      Exception

    • sendDirToSupport

      @MBeanOperationImpact(0) void sendDirToSupport(String dir, long callNumber, String description) throws Exception
      Send contents of a specified directory to technical support

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

    • sendDirToSupport

      void sendDirToSupport(String dir, long callNumber, String description, boolean recursive, int maxAgeInDays, int minAgeInDays, String matchingExpression) throws Exception
      Send contents of a specified directory to technical support

      Supported API: true
      Parameters:
      dir - Directory to send
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      maxAgeInDays - Maximum age in days (by modification date) of files to send
      minAgeInDays - Minimum age in days (by modification date) of files to send; ignored when less than or equal to zero
      matchingExpression - Regular expression file names must match to be sent; ignored if empty or null
      Throws:
      Exception

    • dumpFullStackTrace

      @MBeanOperationImpact(0) String[] dumpFullStackTrace()
      Get full stack trace of all threads; same as FullStackTrace attribute but easier to use as an operation in some consoles

      Supported API: true

    • dumpFullStackTraceToFile

      @MBeanOperationImpact(0) void dumpFullStackTraceToFile() throws IOException
      Dump full stack trace of all threads to a file in directory defined by wt.logs.dir property or current working directory if that property is undefined. File naming is automatic.

      Supported API: true
      Throws:
      IOException

    • sendFullStackTraceToSupport

      @MBeanOperationImpact(0) String[] sendFullStackTraceToSupport(long callNumber, String description) throws Exception
      Performs the same operation as dumpFullStackTrace() except that the stack trace is also sent to technical support

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

    • logFullStackTrace

      @MBeanOperationImpact(0) void logFullStackTrace()
      Log full stack trace of all threads to wt.jmx.core.mbeans.Dumper.stacktraces logger at INFO level (and this logger defaults to INFO level verbosity)

      Supported API: true

    • logComment

      @MBeanOperationImpact(1) void logComment(String comment)
      Log comment to wt.jmx.core.mbeans.Dumper.comments logger at INFO level (and this logger defaults to INFO level verbosity)

      Supported API: true
      Parameters:
      comment - Comment to log

    • emailFullStackTrace

      @MBeanOperationImpact(0) void emailFullStackTrace(String addressesOrEmailList, String subject) throws IOException
      E-mail full stack trace of all threads

      Supported API: true
      Parameters:
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      Throws:
      IOException

    • dumpHeap

      @MBeanOperationImpact(1) void dumpHeap(String fileToDumpTo, boolean liveRefsOnly) throws InstanceNotFoundException, MBeanException, ReflectionException
      Generate heap dump to the specified file; only works in Java 6 or higher JVMs that have a com.sun.management:type=HotSpotDiagnostic MBean with a heapDump(String,boolean) operation.

      Supported API: true
      Parameters:
      fileToDumpTo - Path of file to create and dump heap to
      liveRefsOnly - Whether only live references should be captured in heap dumps
      Throws:
      InstanceNotFoundException
      MBeanException
      ReflectionException

    • sendHeapDumpToSupport

      @MBeanOperationImpact(0) void sendHeapDumpToSupport(long callNumber, String description) throws Exception
      Generates a heap dump as per dumpHeap() operation and sends it to technical support, removing the file upon completion

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

    • dumpAllMBeans

      @MBeanOperationImpact(0) String[] dumpAllMBeans() throws SAXException
      Get data (as XML) on all MBeans in this MBeanServer

      Supported API: true
      Throws:
      SAXException

    • dumpAllMBeansToGzippedBytes

      @MBeanOperationImpact(0) byte[] dumpAllMBeansToGzippedBytes(String xslt, boolean applyXslt) throws IOException, SAXException
      Get gzip compressed data (as XML) on all MBeans in this MBeanServer

      Supported API: true
      Parameters:
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • emailAllMBeans

      @MBeanOperationImpact(0) void emailAllMBeans(String addressesOrEmailList, String subject, boolean compress) throws IOException, SAXException
      E-mail styled data on all MBeans in this MBeanServer using the default styling as specified by DefaultXsltStylesheet

      Supported API: true
      Parameters:
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      Throws:
      IOException
      SAXException

    • emailAllMBeans

      @MBeanOperationImpact(0) void emailAllMBeans(String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt) throws IOException, SAXException
      E-mail styled data on all MBeans in this MBeanServer, styling as specified by the 'xslt' parameter

      Supported API: true
      Parameters:
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • dumpMBeans

      @MBeanOperationImpact(0) String[] dumpMBeans(ObjectName objectNamePattern) throws SAXException
      Get data (as XML) on all MBeans in this MBeanServer that match the ObjectName query pattern

      Supported API: true
      Parameters:
      objectNamePattern - ObjectName query pattern; see JMX specification for more information
      Throws:
      SAXException

    • dumpMBeansToGzippedBytes

      @MBeanOperationImpact(0) byte[] dumpMBeansToGzippedBytes(ObjectName objectNamePattern, String xslt, boolean applyXslt) throws IOException, SAXException
      Get gzip compressed data (as XML) on all MBeans in this MBeanServer that match the ObjectName query pattern

      Supported API: true
      Parameters:
      objectNamePattern - ObjectName query pattern; see JMX specification for more information
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • dumpMBeans

      @MBeanOperationImpact(0) String[] dumpMBeans(ObjectName[] objectNames) throws SAXException
      Get data (as XML) on specified MBeans in this MBeanServer

      Supported API: true
      Parameters:
      objectNames - ObjectNames of MBeans to get data for
      Throws:
      SAXException

    • dumpMBeansToGzippedBytes

      @MBeanOperationImpact(0) byte[] dumpMBeansToGzippedBytes(ObjectName[] objectNames, String xslt, boolean applyXslt) throws IOException, SAXException
      Get gzip compressed data (as XML) on specified MBeans in this MBeanServer

      Supported API: true
      Parameters:
      objectNames - ObjectNames of MBeans to get data for
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • emailMBeans

      @MBeanOperationImpact(0) void emailMBeans(ObjectName objectNamePattern, String addressesOrEmailList, String subject, boolean compress) throws IOException, SAXException
      E-mail styled data on all MBeans in this MBeanServer that match the ObjectName query pattern using the default styling as specified by DefaultXsltStylesheet

      Supported API: true
      Parameters:
      objectNamePattern - ObjectName query pattern; see JMX specification for more information
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      Throws:
      IOException
      SAXException

    • emailMBeans

      @MBeanOperationImpact(0) void emailMBeans(ObjectName objectNamePattern, String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt) throws IOException, SAXException
      E-mail styled data on all MBeans in this MBeanServer that match the ObjectName query pattern, styling as specified by the 'xslt' parameter

      Supported API: true
      Parameters:
      objectNamePattern - ObjectName query pattern; see JMX specification for more information
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • emailMBeans

      @MBeanOperationImpact(0) void emailMBeans(ObjectName[] objectNames, String addressesOrEmailList, String subject, boolean compress, String xslt, boolean applyXslt) throws IOException, SAXException
      E-mail styled data for specified MBeans from this MBeanServer, styling as specified by the 'xslt' parameter

      Supported API: true
      Parameters:
      objectNames - ObjectNames of MBeans to e-mail data for
      addressesOrEmailList - Comma-delimited list of e-mail addresses or name of e-mail list to send e-mail to
      subject - Subject to give e-mail
      compress - Whether e-mail contents should be compressed
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      SAXException

    • dumpAllMBeansToFile

      @MBeanOperationImpact(1) void dumpAllMBeansToFile(String outputFileRef, String xslt, boolean applyXslt) throws IOException, URISyntaxException, SAXException
      Dump the current state of all the MBeans to a file

      Supported API: true
      Parameters:
      outputFileRef - Reference (URL, file path, or resource path) of file to which MBeans will be saved
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      URISyntaxException
      SAXException

    • dumpMBeansToFile

      @MBeanOperationImpact(1) void dumpMBeansToFile(ObjectName objectNamePattern, String outputFileRef, String xslt, boolean applyXslt) throws IOException, URISyntaxException, SAXException
      Dump the current state of all the MBeans to a file

      Supported API: true
      Parameters:
      objectNamePattern - ObjectName query pattern; see JMX specification for more information
      outputFileRef - Reference (URL, file path, or resource path) of file to which MBeans will be saved
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      URISyntaxException
      SAXException

    • dumpMBeansToFile

      @MBeanOperationImpact(1) void dumpMBeansToFile(ObjectName[] objectNames, String outputFileRef, String xslt, boolean applyXslt) throws IOException, URISyntaxException, SAXException
      Dump the current state of all the MBeans to a file

      Supported API: true
      Parameters:
      objectNames - ObjectNames of MBeans to e-mail data for
      outputFileRef - Reference (URL, file path, or resource path) of file to which MBeans will be saved
      xslt - Reference (URL, file, or resource) to XSLT stylesheet to apply; defaults to DefaultXsltStylesheetURL if not specified
      applyXslt - Whether to apply XSLT or just insert a processing instruction for it
      Throws:
      IOException
      URISyntaxException
      SAXException

    • sendAllMBeansToSupport

      @MBeanOperationImpact(0) void sendAllMBeansToSupport(long callNumber, String description) throws Exception
      Send styled data for all MBeans from this MBeanServer to technical support

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

    • sendAllMBeansToSupport

      @MBeanOperationImpact(0) void sendAllMBeansToSupport(long callNumber, String description, String baseFilenameNoSuffix) throws Exception
      Send styled data for all MBeans from this MBeanServer to technical support

      Supported API: true
      Parameters:
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      baseFilenameNoSuffix - Base name without any suffix to give resulting data file
      Throws:
      Exception

    • sendLogsDirsToSupport

      @MBeanOperationImpact(0) void sendLogsDirsToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression) throws Exception
      For each LogsDirViewer MBean, send log files from its target log directory to tech support filtering as specified

      Supported API: true
      Parameters:
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      maxAgeInDays - Maximum age in days (by modification date) of files to send
      minAgeInDays - Minimum age in days (by modification date) of files to send; ignored when less than or equal to zero
      matchingExpression - Regular expression file names must match to be be sent; ignored if empty or null
      Throws:
      Exception

    • sendLogsDirsToSupport

      @MBeanOperationImpact(0) void sendLogsDirsToSupport(long callNumber, String description, int maxAgeInDays, int minAgeInDays, String matchingExpression, String[] logsDirViewersToSkip) throws Exception
      For each LogsDirViewer MBean, send log files from its target log directory to tech support filtering as specified

      Supported API: true
      Parameters:
      callNumber - Existing technical support call number to associate this data with
      description - Description to give data
      maxAgeInDays - Maximum age in days (by modification date) of files to send
      minAgeInDays - Minimum age in days (by modification date) of files to send; ignored when less than or equal to zero
      matchingExpression - Regular expression file names must match to be sent; ignored if empty or null
      logsDirViewersToSkip - Names of LogsDirViewer MBeans to skip
      Throws:
      Exception

    • getResources

      @MBeanOperationImpact(0) String[] getResources(String resourceName) throws IOException
      Returns a list of URLs (as strings) representing all the resources with the given name found by this MBean's classloader.

      Supported API: true
      Parameters:
      resourceName - Name of resource to search for
      Throws:
      IOException

    • checkResources

      @MBeanOperationImpact(0) CompositeData[] checkResources(String resourceName) throws IOException, OpenDataException
      Returns various properties (to support comparison and sanity checking) for all the resources with the given name found by this MBean's classloader.

      Supported API: true
      Parameters:
      resourceName - Name of resource to search for
      Throws:
      IOException
      OpenDataException

    • invokeInfoOperation

      @MBeanOperationImpact(0) Object invokeInfoOperation(ObjectName mbean, String operation, Object[] params, String[] signature) throws InstanceNotFoundException, IntrospectionException, MBeanException, ReflectionException, IOException
      Invoke an operation with an INFO (read-only) impact on an MBean. This operation will raise a SecurityException exception if the target operation has a non-INFO impact. This operation exists to provide remote JMX clients with a known INFO impact operation that can locally (and thus more efficiently) enforce that an arbitrary target operation has an INFO impact.

      Supported API: true
      Parameters:
      mbean - ObjectName of target MBean
      operation - Name of target operation
      params - Arguments of target operation
      signature - Signature of target operation
      Throws:
      InstanceNotFoundException
      IntrospectionException
      MBeanException
      ReflectionException
      IOException

    • getMBeanInfo

      @MBeanOperationImpact(0) MBeanInfo getMBeanInfo(ObjectName objectName) throws InstanceNotFoundException, IntrospectionException, ReflectionException
      Fetches MBeanInfo for specified MBean.

      Supported API: true
      Parameters:
      objectName - ObjectName of target MBean
      Throws:
      InstanceNotFoundException
      IntrospectionException
      ReflectionException

    • getMBeanInfos

      @MBeanOperationImpact(0) Map<ObjectName,MBeanInfo>[] getMBeanInfos(ObjectName[] objectNamePatterns, QueryExp[] queryExps)
      Fetches MBeanInfos from multiple JMX MBeans in one request. All arguments and the return result are treated as "parallel" arrays with corresponding elements from each being processed together. Each element of the returned array is a map from the ObjectNames which match the corresponding 'objectNamePatterns' and 'queryExps' elements to their MBeanInfos.

      Supported API: true
      Parameters:
      objectNamePatterns - Array of ObjectNames, each of which can be an ObjectName pattern
      queryExps - Array of query expressions; when non-null each non-null element is used as an additional filter on the lookup for the corresponding 'objectNamePatterns' element

    • getAttributes

      @MBeanOperationImpact(0) Map<ObjectName,AttributeList>[] getAttributes(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[][] attributeNamesArrs)
      Fetches attribute values from multiple JMX MBeans in one request. All arguments and the return result are treated as "parallel" arrays with corresponding elements from each being processed together. Each element of the returned array is a map from the ObjectNames which match the corresponding 'objectNamePatterns' and 'queryExps' elements to their values attributes requested by the corresponding 'attributeNamesArrs' element.

      Supported API: true
      Parameters:
      objectNamePatterns - Array of ObjectNames, each of which can be an ObjectName pattern
      queryExps - Array of query expressions; when non-null each non-null element is used as an additional filter on the lookup for the corresponding 'objectNamePatterns' element
      attributeNamesArrs - Array of attribute name arrays; when non-null, each non-null element specifies the list of attributes to fetch for the corresponding 'objectNamePatterns' element and null elements are intepretted as requests for all attributes; when null, a null value will be returned in the map for each matching ObjectName key

    • setAttributes

      @MBeanOperationImpact(1) Map<ObjectName,AttributeList>[] setAttributes(ObjectName[] objectNamePatterns, QueryExp[] queryExps, AttributeList[] attributeLists)
      Sets attribute values on multiple JMX MBeans in one request. All arguments and the return result are treated as "parallel" arrays with corresponding elements from each being processed together. Each element of the returned array is a map from the ObjectNames which match the corresponding 'objectNamePatterns' and 'queryExps' elements to the AttributeList resulting from invoking MBeanServer.setAttributes() on that the ObjectName with the corresponding 'attributeLists' element.

      Supported API: true
      Parameters:
      objectNamePatterns - Array of ObjectNames, each of which can be an ObjectName pattern
      queryExps - Array of query expressions; when non-null each non-null element is used as an additional filter on the lookup for the corresponding 'objectNamePatterns' element
      attributeLists - Array of AttributeLists to set on MBeans specified by corresponding objectNamePatterns and queryExps elements

    • invokeOperations

      @MBeanOperationImpact(1) Map<ObjectName,Object>[] invokeOperations(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[] operations, Object[][] paramArrs, String[][] signatures)
      Invokes multiple JMX operations in one request. All arguments and the return result are treated as "parallel" arrays with corresponding elements from each being processed together. Each element of the returned array is a map from the ObjectNames which match the corresponding 'objectNamePatterns' and 'queryExps' elements to the results of the operation invocation specified by the corresponding 'operations', 'paramArrs', and 'signatures' elements. If the operation throws an exception, then that exception will be returned as the result in the map.

      Supported API: true
      Parameters:
      objectNamePatterns - Array of ObjectNames, each of which can be an ObjectName pattern
      queryExps - Array of query expressions; when non-null each non-null element is used as an additional filter on the lookup for the corresponding 'objectNamePatterns' element
      operations - Names of target operations
      paramArrs - Arguments of target operations
      signatures - Signatures of target operations

    • invokeInfoOperations

      @MBeanOperationImpact(0) Map<ObjectName,Object>[] invokeInfoOperations(ObjectName[] objectNamePatterns, QueryExp[] queryExps, String[] operations, Object[][] paramArrs, String[][] signatures)
      Invoke multiple operations with INFO (read-only) impact in one request. All arguments and the return result are treated as "parallel" arrays with corresponding elements from each being processed together. Each element of the returned array is a map from the ObjectNames which match the corresponding 'objectNamePatterns' and 'queryExps' elements to the results of the operation invocation specified by the corresponding 'operations', 'paramArrs', and 'signatures' elements. If the operation throws an exception, then that exception will be returned as the result in the map.

      Supported API: true
      Parameters:
      objectNamePatterns - Array of ObjectNames, each of which can be an ObjectName pattern
      queryExps - Array of query expressions; when non-null each non-null element is used as an additional filter on the lookup for the corresponding 'objectNamePatterns' element
      operations - Names of target operations
      paramArrs - Arguments of target operations
      signatures - Signatures of target operations

    • executeScript

      @MBeanOperationImpact(2) Object executeScript(String scriptEngineShortName, String script) throws Exception
      Executes/evaluates the specified script via the specified script engine and returns the result. The script engine must be an installed javax.script-compliant engine. Note that a JavaScript engine is built in.

      Supported API: true
      Parameters:
      scriptEngineShortName - Short name of script engine; defaults to "JavaScript" if empty/null
      script - Script string to execute/evaluate
      Throws:
      Exception

    • executeScript

      @MBeanOperationImpact(2) Object executeScript(String scriptEngineShortName, String script, Object[] scriptArgs) throws Exception
      Executes/evaluates the specified script via the specified script engine and returns the result. The script engine must be an installed javax.script-compliant engine. Note that a JavaScript engine is built in.

      Supported API: true
      Parameters:
      scriptEngineShortName - Short name of script engine; defaults to "JavaScript" if empty/null
      script - Script string to execute/evaluate
      scriptArgs - Arguments to the script
      Throws:
      Exception