| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc --> |
| <title>OpenJ9DiagnosticsMXBean (OpenJ9 JDK 11)</title> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="keywords" content="openj9.lang.management.OpenJ9DiagnosticsMXBean interface"> |
| <meta name="keywords" content="resetDumpOptions()"> |
| <meta name="keywords" content="queryDumpOptions()"> |
| <meta name="keywords" content="setDumpOptions()"> |
| <meta name="keywords" content="triggerDump()"> |
| <meta name="keywords" content="triggerDumpToFile()"> |
| <meta name="keywords" content="triggerClassicHeapDump()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery/jquery-ui.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip/dist/jszip.min.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script> |
| <!--[if IE]> |
| <script type="text/javascript" src="../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script> |
| <![endif]--> |
| <script type="text/javascript" src="../../../../jquery/jquery-3.5.1.js"></script> |
| <script type="text/javascript" src="../../../../jquery/jquery-ui.js"></script> |
| </head> |
| <body> |
| <script type="text/javascript"><!-- |
| try { |
| if (location.href.indexOf('is-external=true') == -1) { |
| parent.document.title="OpenJ9DiagnosticsMXBean (OpenJ9 JDK 11)"; |
| } |
| } |
| catch(err) { |
| } |
| //--> |
| var data = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6}; |
| var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]}; |
| var altColor = "altColor"; |
| var rowColor = "rowColor"; |
| var tableTab = "tableTab"; |
| var activeTableTab = "activeTableTab"; |
| var pathtoroot = "../../../../"; |
| var useModuleDirectories = true; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <header role="banner"> |
| <nav role="navigation"> |
| <div class="fixedNav"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="topNav"><a id="navbar.top"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.top.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OpenJ9DiagnosticsMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_top"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <ul class="navListSearch"> |
| <li><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_top"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.top"> |
| <!-- --> |
| </a></div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| </div> |
| <div class="navPadding"> </div> |
| <script type="text/javascript"><!-- |
| $('.navPadding').css('padding-top', $('.fixedNav').css("height")); |
| //--> |
| </script> |
| </nav> |
| </header> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <main role="main"> |
| <div class="header"> |
| <div class="subTitle"><span class="moduleLabelInType">Module</span> <a href="../../../module-summary.html">jdk.management</a></div> |
| <div class="subTitle"><span class="packageLabelInType">Package</span> <a href="package-summary.html">openj9.lang.management</a></div> |
| <h2 title="Interface OpenJ9DiagnosticsMXBean" class="title">Interface OpenJ9DiagnosticsMXBean</h2> |
| </div> |
| <div class="contentContainer"> |
| <div class="description"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <dl> |
| <dt>All Superinterfaces:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/PlatformManagedObject.html?is-external=true" title="class or interface in java.lang.management" class="externalLink" target="_blank">PlatformManagedObject</a></code></dd> |
| </dl> |
| <dl> |
| <dt>All Known Implementing Classes:</dt> |
| <dd><code><a href="internal/OpenJ9DiagnosticsMXBeanImpl.html" title="class in openj9.lang.management.internal">OpenJ9DiagnosticsMXBeanImpl</a></code></dd> |
| </dl> |
| <hr> |
| <pre>public interface <span class="typeNameLabel">OpenJ9DiagnosticsMXBean</span> |
| extends <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/PlatformManagedObject.html?is-external=true" title="class or interface in java.lang.management" class="externalLink" target="_blank">PlatformManagedObject</a></pre> |
| <div class="block"><p> |
| This interface provides APIs to dynamically trigger dump agents. APIs are also available to |
| configure dump options. |
| This MXBean reuses the methods in com.ibm.jvm.Dump API |
| <br> |
| <table border="1"> |
| <caption><b>Usage example for the <a href="OpenJ9DiagnosticsMXBean.html" title="interface in openj9.lang.management"><code>OpenJ9DiagnosticsMXBean</code></a></b></caption> |
| <tr> <td> |
| <pre> |
| <code> |
| ... |
| try { |
| mxbeanName = new ObjectName("openj9.lang.management:type=OpenJ9Diagnostics"); |
| } catch (MalformedObjectNameException e) { |
| // Exception Handling |
| } |
| try { |
| MBeanServer mbeanServer = ManagementFactory.getPlatformMBeanServer(); |
| if (false == mbeanServer.isRegistered(mxbeanName)) { |
| // OpenJ9DiagnosticsMXBean not registered |
| } |
| OpenJ9DiagnosticsMXBean diagBean = JMX.newMXBeanProxy(mbeanServer, mxbeanName, OpenJ9DiagnosticsMXBean.class); |
| } catch (Exception e) { |
| // Exception Handling |
| } |
| </code> |
| </pre></td></tr> |
| </table></div> |
| </li> |
| </ul> |
| </div> |
| <div class="summary"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.summary"> |
| <!-- --> |
| </a> |
| <h3>Method Summary</h3> |
| <table class="memberSummary"> |
| <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption> |
| <tr> |
| <th class="colFirst" scope="col">Modifier and Type</th> |
| <th class="colSecond" scope="col">Method</th> |
| <th class="colLast" scope="col">Description</th> |
| </tr> |
| <tr id="i0" class="altColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>[]</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#queryDumpOptions()">queryDumpOptions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Returns the current dump configuration as an array of Strings, or null if an internal error occurs.</div> |
| </td> |
| </tr> |
| <tr id="i1" class="rowColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#resetDumpOptions()">resetDumpOptions</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">Reset the JVM dump options to the settings specified when the JVM was started removing any additional |
| configuration done since then.</div> |
| </td> |
| </tr> |
| <tr id="i2" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#setDumpOptions(java.lang.String)">setDumpOptions</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpOptions)</code></th> |
| <td class="colLast"> |
| <div class="block">This function sets options for the dump subsystem.</div> |
| </td> |
| </tr> |
| <tr id="i3" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triggerClassicHeapDump()">triggerClassicHeapDump</a></span>()</code></th> |
| <td class="colLast"> |
| <div class="block">This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.</div> |
| </td> |
| </tr> |
| <tr id="i4" class="altColor"> |
| <td class="colFirst"><code>void</code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triggerDump(java.lang.String)">triggerDump</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpAgent)</code></th> |
| <td class="colLast"> |
| <div class="block">This function triggers the specified dump agent.</div> |
| </td> |
| </tr> |
| <tr id="i5" class="rowColor"> |
| <td class="colFirst"><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a></code></td> |
| <th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="#triggerDumpToFile(java.lang.String,java.lang.String)">triggerDumpToFile</a></span>​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpAgent, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> fileNamePattern)</code></th> |
| <td class="colLast"> |
| <div class="block">This function triggers the specified dump agent.</div> |
| </td> |
| </tr> |
| </table> |
| <ul class="blockList"> |
| <li class="blockList"><a id="methods.inherited.from.class.java.lang.management.PlatformManagedObject"> |
| <!-- --> |
| </a> |
| <h3>Methods declared in interface java.lang.management.<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/PlatformManagedObject.html?is-external=true" title="class or interface in java.lang.management" class="externalLink" target="_blank">PlatformManagedObject</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.management/java/lang/management/PlatformManagedObject.html?is-external=true#getObjectName()" title="class or interface in java.lang.management" class="externalLink" target="_blank">getObjectName</a></code></li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| <div class="details"> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <section role="region"> |
| <ul class="blockList"> |
| <li class="blockList"><a id="method.detail"> |
| <!-- --> |
| </a> |
| <h3>Method Detail</h3> |
| <a id="resetDumpOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>resetDumpOptions</h4> |
| <pre class="methodSignature">void resetDumpOptions() |
| throws <a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</a></pre> |
| <div class="block">Reset the JVM dump options to the settings specified when the JVM was started removing any additional |
| configuration done since then. This method may throw a ConfigurationUnavailableException if the dump |
| configuration cannot be altered. If this occurs it will usually be because a dump event is currently being |
| handled.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</a></code> - if the configuration cannot be changed because a dump is already in progress</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to change the dump settings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="queryDumpOptions()"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>queryDumpOptions</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a>[] queryDumpOptions()</pre> |
| <div class="block">Returns the current dump configuration as an array of Strings, or null if an internal error occurs. |
| The syntax of the option Strings is the same as the -Xdump command-line option, |
| with the initial -Xdump: omitted. See the -Xdump option section on dump agents in |
| the documentation for the OpenJ9 JVM.</div> |
| <dl> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to read the dump settings</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="setDumpOptions(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>setDumpOptions</h4> |
| <pre class="methodSignature">void setDumpOptions​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpOptions) |
| throws <a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a>, |
| <a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</a></pre> |
| <div class="block">This function sets options for the dump subsystem. |
| The dump option is passed in as a String. Use the same syntax as the -Xdump command-line option, with the |
| initial -Xdump: omitted. See the -Xdump option section on dump agents in the |
| documentation for the OpenJ9 JVM. This method may throw a ConfigurationUnavailableException if the dump |
| configuration cannot be altered.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dumpOptions</code> - the options string to be set</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></code> - if the specified dumpOptions cannot be set or is incorrect</dd> |
| <dd><code><a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</a></code> - if the configuration cannot be changed because a dump is already in progress</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to change the dump settings</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">NullPointerException</a></code> - if dumpOptions is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="triggerDump(java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>triggerDump</h4> |
| <pre class="methodSignature">void triggerDump​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpAgent) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">IllegalArgumentException</a></pre> |
| <div class="block">This function triggers the specified dump agent. Dump agents supported - java, snap, system and heap. |
| A java dump is in a human-readable format, and summarizes the state of the JVM. |
| The default heap dump format (a phd file) is not human-readable. |
| A system dump is a platform-specific file that contains information about the active processes, threads, and |
| system memory. System dumps are usually large. |
| The snap dump format is not human-readable and must be processed using the trace formatting tool supplied with the OpenJ9 JVM.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dumpAgent</code> - the dump agent to be triggered</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">IllegalArgumentException</a></code> - if the specified dump agent is invalid or unsupported by this method</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">RuntimeException</a></code> - if the vm does not contain RAS dump support</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to trigger this dump</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">NullPointerException</a></code> - if dumpAgent is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="triggerDumpToFile(java.lang.String,java.lang.String)"> |
| <!-- --> |
| </a> |
| <ul class="blockList"> |
| <li class="blockList"> |
| <h4>triggerDumpToFile</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> triggerDumpToFile​(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> dumpAgent, |
| <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> fileNamePattern) |
| throws <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">IllegalArgumentException</a>, |
| <a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></pre> |
| <div class="block">This function triggers the specified dump agent. Dump agents supported - java, snap, system and heap. |
| The JVM will attempt to write the file to the specified file name. This may |
| include replacement tokens as documented in the section on dump agents |
| in the documentation for the OpenJ9 JVM. |
| |
| A string containing the actual filename written to is returned. This may not |
| be the same as the requested filename for several reasons: |
| <ul> |
| <li>null or the empty string was specified, this will cause the JVM to write the |
| dump to the default location based on the current dump settings and return that |
| path.</li> |
| <li>Replacement (%) tokens were specified in the file name. These will have been |
| expanded.</li> |
| <li>The full path is returned, if only a filename with no directory was specified |
| the full path with the directory the dump was written to will be returned.</li> |
| <li>The JVM couldn't write to the specified location. In this case it will attempt |
| to write the dump to another location, unless -Xdump:nofailover was specified on |
| the command line.</li> |
| </ul> |
| |
| If a security manager exists a permission check for com.ibm.jvm.DumpPermission will be |
| made, if this fails a SecurityException will be thrown.</div> |
| <dl> |
| <dt><span class="paramLabel">Parameters:</span></dt> |
| <dd><code>dumpAgent</code> - the dump agent to be triggered</dd> |
| <dd><code>fileNamePattern</code> - the filename to write to, which may be null, empty or include replacement tokens</dd> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></code> - if the fileNamePattern was invalid</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">IllegalArgumentException</a></code> - if the specified dump agent is invalid or unsupported by this method</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to trigger this dump</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">NullPointerException</a></code> - if dumpAgent is null</dd> |
| </dl> |
| </li> |
| </ul> |
| <a id="triggerClassicHeapDump()"> |
| <!-- --> |
| </a> |
| <ul class="blockListLast"> |
| <li class="blockList"> |
| <h4>triggerClassicHeapDump</h4> |
| <pre class="methodSignature"><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/String.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">String</a> triggerClassicHeapDump() |
| throws <a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></pre> |
| <div class="block">This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.</div> |
| <dl> |
| <dt><span class="returnLabel">Returns:</span></dt> |
| <dd>The file name of the dump that was created</dd> |
| <dt><span class="throwsLabel">Throws:</span></dt> |
| <dd><code><a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></code> - if the dump operation fails</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/RuntimeException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">RuntimeException</a></code> - if the JVM does not contain RAS dump support</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/SecurityException.html?is-external=true" title="class or interface in java.lang" class="externalLink" target="_blank">SecurityException</a></code> - if there is a security manager and it doesn't allow the checks required to trigger this dump</dd> |
| </dl> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </main> |
| <!-- ========= END OF CLASS DATA ========= --> |
| <footer role="contentinfo"> |
| <nav role="navigation"> |
| <!-- ======= START OF BOTTOM NAVBAR ====== --> |
| <div class="bottomNav"><a id="navbar.bottom"> |
| <!-- --> |
| </a> |
| <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div> |
| <a id="navbar.bottom.firstrow"> |
| <!-- --> |
| </a> |
| <ul class="navList" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="../../../module-summary.html">Module</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="navBarCell1Rev">Class</li> |
| <li><a href="class-use/OpenJ9DiagnosticsMXBean.html">Use</a></li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-files/index-1.html">Index</a></li> |
| <li><a href="../../../../help-doc.html">Help</a></li> |
| </ul> |
| <div class="aboutLanguage"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 11</strong></div></div> |
| </div> |
| <div class="subNav"> |
| <ul class="navList" id="allclasses_navbar_bottom"> |
| <li><a href="../../../../allclasses.html">All Classes</a></li> |
| </ul> |
| <div> |
| <script type="text/javascript"><!-- |
| allClassesLink = document.getElementById("allclasses_navbar_bottom"); |
| if(window==top) { |
| allClassesLink.style.display = "block"; |
| } |
| else { |
| allClassesLink.style.display = "none"; |
| } |
| //--> |
| </script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| </div> |
| <div> |
| <ul class="subNavList"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="subNavList"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <a id="skip.navbar.bottom"> |
| <!-- --> |
| </a></div> |
| <!-- ======== END OF BOTTOM NAVBAR ======= --> |
| </nav> |
| <p class="legalCopy"><small><a href="https://www.eclipse.org/openj9/" target="_blank">Eclipse OpenJ9 website.</a><br> To raise a bug report or suggest an improvement create an <a href="https://github.com/eclipse/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </body> |
| </html> |