| <!DOCTYPE HTML> |
| <!-- NewPage --> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (16) --> |
| <title>Dump (OpenJ9 JDK 16)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: module: openj9.jvm, package: com.ibm.jvm, class: Dump"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <meta name="keywords" content="com.ibm.jvm.Dump class"> |
| <meta name="keywords" content="JavaDump()"> |
| <meta name="keywords" content="HeapDump()"> |
| <meta name="keywords" content="SystemDump()"> |
| <meta name="keywords" content="SnapDump()"> |
| <meta name="keywords" content="javaDumpToFile()"> |
| <meta name="keywords" content="heapDumpToFile()"> |
| <meta name="keywords" content="systemDumpToFile()"> |
| <meta name="keywords" content="snapDumpToFile()"> |
| <meta name="keywords" content="triggerDump()"> |
| <meta name="keywords" content="setDumpOptions()"> |
| <meta name="keywords" content="queryDumpOptions()"> |
| <meta name="keywords" content="resetDumpOptions()"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar.top"> |
| <div class="skip-nav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><div style="margin-top: 9px;"><strong>OpenJ9 JDK 16</strong></div></div> |
| <ul id="navbar.top.firstrow" class="nav-list" 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="nav-bar-cell1-rev">Class</li> |
| <li><a href="class-use/Dump.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> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li>Nested | </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li>Field | </li> |
| <li>Constr | </li> |
| <li><a href="#method.detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search">SEARCH:</label> |
| <input type="text" id="search" value="search" disabled="disabled"> |
| <input type="reset" id="reset" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip.navbar.top"> |
| <!-- --> |
| </span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="module-label-in-type">Module</span> <a href="../../../module-summary.html">openj9.jvm</a></div> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">com.ibm.jvm</a></div> |
| <h1 title="Class Dump" class="title">Class Dump</h1> |
| </div> |
| <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">java.lang.Object</a> |
| <div class="inheritance">com.ibm.jvm.Dump</div> |
| </div> |
| <section class="description"> |
| <hr> |
| <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">Dump</span> |
| <span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></span></div> |
| <div class="block">This class is used to trigger and configure the options used to produce different |
| types of diagnostic dumps available from the OpenJ9 JVM. |
| <p> |
| -Xdump must be enabled on the command line or the functions that attempt to cause |
| dumps to be created or set options will fail with a java.lang.RuntimeException. |
| <p> |
| The methods on this class can be used to trigger dumps, configure dump options and |
| query those options. |
| <p> |
| The <a href="#JavaDump()"><code>JavaDump()</code></a>, <a href="#SystemDump()"><code>SystemDump()</code></a>, <a href="#HeapDump()"><code>HeapDump()</code></a> and <a href="#SnapDump()"><code>SnapDump()</code></a> |
| methods trigger dumps of the given type with no options and no return value. |
| Although they are not configurable they do provide an easy API to use via reflection |
| if your code is likely to run on both OpenJ9 and non-OpenJ9 JVMs and you only need the most |
| basic ability to create a dump. |
| <p> |
| The <a href="#javaDumpToFile()"><code>javaDumpToFile()</code></a>, <a href="#systemDumpToFile()"><code>systemDumpToFile()</code></a>, <a href="#heapDumpToFile()"><code>heapDumpToFile()</code></a> and |
| <a href="#snapDumpToFile()"><code>snapDumpToFile()</code></a> methods allow a destination file to be optionally specified and |
| will return the full path of the file that is created. |
| <br> |
| The recommended usage of the <a href="#javaDumpToFile()"><code>javaDumpToFile()</code></a>, <a href="#systemDumpToFile()"><code>systemDumpToFile()</code></a>, |
| <a href="#heapDumpToFile()"><code>heapDumpToFile()</code></a> and <a href="#snapDumpToFile()"><code>snapDumpToFile()</code></a> |
| methods is to call the no argument versions of these calls rather than specifying a file |
| name as this will trigger a dump to the default location. Your dump file will go to the |
| default location specified by any -Xdump options given to the JVM at startup time following |
| the user or administrators preferences. |
| The location the dump file was written to will be returned as a String so the generated |
| file can be located. |
| <p> |
| The <a href="#triggerDump(java.lang.String)"><code>triggerDump(String)</code></a> method offers similar functionality as the DumpToFile() methods |
| but with the ability to specify any dump options that are meaningful for a dump that occurs |
| immediately. The options are passed as a String that follows the same format as the option |
| strings passed to -Xdump on the command line.<br> |
| For example: |
| <ul> |
| <li>triggerDump("java") is equivalent to javaDumpToFile() or javaDumpToFile(null) all three |
| will cause a javadump to be generated to the default location.</li> |
| <li>triggerDump("heap:file=heapdump.phd") is equivalent to heapDumpToFile("heapdump.phd")</li> |
| <li>triggerDump("heap:file=heapdump.txt,opts=CLASSIC") allows you to specify the CLASSIC |
| option to triggerDump and produce a text format heap dump which is not possible through |
| the *DumpToFile(String filename) or *Dump() methods.</li> |
| <li>triggerDump("java:request=exclusive") will trigger a java dump with the request option set |
| to "exclusive" and any other options, including the file name, taken from the default options |
| for java dumps</li> |
| </ul> |
| <p> |
| The <a href="#setDumpOptions(java.lang.String)"><code>setDumpOptions(String)</code></a> method allows dump options that will cause or change how |
| a dump occurs for an event in the future to be specified. The options are specified in the |
| format expected by the -Xdump command line. Not all options can be configured at runtime and |
| this method will throw an InvalidDumpOption exception if it is passed an option that cannot be set.<p> |
| For example: |
| <ul> |
| <li>setDumpOptions("java") - enable java dumps with the default settings.</li> |
| <li>setDumpOptions("java:events=vmstop") - enable java dumps on the vmstop event (this will |
| occur once when the JVM exits).</li> |
| <li>setDumpOptions("none") - disable all dump agents on all events.</li> |
| <li>setDumpOptions("heap:none") - disable all heap dump agents on all events.</li> |
| <li>setDumpOptions("system:none:events=systhrow,filter=java/lang/OutOfMemoryError") - disable |
| system dumps on systhrow events for OutOfMemory errors only.</li> |
| </ul> |
| For full details of dump options see the section on dump agents in the documentation for the OpenJ9 JVM. |
| <p> |
| The <a href="#queryDumpOptions()"><code>queryDumpOptions()</code></a> method returns a String array containing a snapshot of the currently |
| configured dump options. Each String is in the format expected by the -Xdump command line |
| option and setDumpOptions. The Strings can be passed back to setDumpOptions to recreate |
| the current dump agent configuration at a later time. |
| <p> |
| The <a href="#resetDumpOptions()"><code>resetDumpOptions()</code></a> method resets the dump options to the settings specified when the |
| JVM was started removing any additional configuration done since then.<br> |
| If you wish to change the dump configuration at runtime and then reset it to an earlier |
| state that included additional runtime configuration done through this API or JVMTI you should |
| consider saving the result of queryDumpOptions and then later use <a href="#setDumpOptions(java.lang.String)"><code>setDumpOptions(String)</code></a> |
| to restore that configuration after a call to setDumpOptions("none") to clear all dump agent |
| configuration.</div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method.summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab1" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab1', 3)" class="table-tab">Static Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#HeapDump()">HeapDump</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a heap dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#heapDumpToFile()">heapDumpToFile</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a heap dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#heapDumpToFile(java.lang.String)">heapDumpToFile</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a heap dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#JavaDump()">JavaDump</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a java dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#javaDumpToFile()">javaDumpToFile</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a java dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#javaDumpToFile(java.lang.String)">javaDumpToFile</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a java dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#queryDumpOptions()">queryDumpOptions</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Returns the current dump configuration as an array of Strings.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#resetDumpOptions()">resetDumpOptions</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <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> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#setDumpOptions(java.lang.String)">setDumpOptions</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> dumpOptions)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Sets options for the dump subsystem.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#SnapDump()">SnapDump</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a snap dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#snapDumpToFile()">snapDumpToFile</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a snap dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#snapDumpToFile(java.lang.String)">snapDumpToFile</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a snap dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static void</code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#SystemDump()">SystemDump</a></span>()</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a system dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#systemDumpToFile()">systemDumpToFile</a></span>()</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a system dump.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#systemDumpToFile(java.lang.String)">systemDumpToFile</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</code></div> |
| <div class="col-last even-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a system dump.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code>static <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></code></div> |
| <div class="col-second odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"><code><span class="member-name-link"><a href="#triggerDump(java.lang.String)">triggerDump</a></span>​(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> dumpOptions)</code></div> |
| <div class="col-last odd-row-color method-summary-table-tab1 method-summary-table-tab4 method-summary-table"> |
| <div class="block">Trigger a dump with the specified options.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="inherited-list"> |
| <h3 id="methods.inherited.from.class.java.lang.Object">Methods declared in class java.lang.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link" target="_blank">Object</a></h3> |
| <code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link" target="_blank">clone</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link" target="_blank">equals</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link" target="_blank">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link" target="_blank">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link" target="_blank">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link" target="_blank">notify</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link" target="_blank">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link" target="_blank">toString</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a>, <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link" target="_blank">wait</a></code></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method.detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="JavaDump()"> |
| <h3>JavaDump</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">JavaDump</span>()</div> |
| <div class="block">Trigger a java dump. A java dump is in a human-readable format, and |
| summarizes the state of the JVM. |
| |
| A security manager check will be made only if the system property |
| com.ibm.jvm.enableLegacyDumpSecurity is set to "true" in which case |
| a check will be made for com.ibm.jvm.DumpPermission</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="HeapDump()"> |
| <h3>HeapDump</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">HeapDump</span>()</div> |
| <div class="block">Trigger a heap dump. The default heap dump format (a phd file) is not |
| human-readable. |
| |
| A security manager check will be made only if the system property |
| com.ibm.jvm.enableLegacyDumpSecurity is set to "true" in which case |
| a check will be made for com.ibm.jvm.DumpPermission</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SystemDump()"> |
| <h3>SystemDump</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">SystemDump</span>()</div> |
| <div class="block">Trigger a system dump. A system dump is a platform-specific |
| file that contains information about the active processes, threads, and |
| system memory. System dumps are usually large. |
| |
| A security manager check will be made only if the system property |
| com.ibm.jvm.enableLegacyDumpSecurity is set to "true" in which case |
| a check will be made for com.ibm.jvm.DumpPermission</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="SnapDump()"> |
| <h3>SnapDump</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">SnapDump</span>()</div> |
| <div class="block">Trigger a snap dump. The snap dump format is not human-readable |
| and must be processed using the trace formatting tool supplied |
| with the OpenJ9 JVM. |
| |
| A security manager check will be made only if the system property |
| com.ibm.jvm.enableLegacyDumpSecurity is set to "true" in which case |
| a check will be made for com.ibm.jvm.DumpPermission</div> |
| <dl class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="javaDumpToFile(java.lang.String)"> |
| <h3>javaDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">javaDumpToFile</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></span></div> |
| <div class="block">Trigger a java dump. A java dump is in a human-readable format, and |
| summarizes the state of the JVM. |
| |
| 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 file name written to is returned. This may not |
| be the same as the requested filename for several reasons: |
| <ul> |
| <li>null or the empty string were 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 file name 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fileNamePattern</code> - the file name to write to, which may be null, empty or include replacement tokens</dd> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - if the filename was invalid</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="javaDumpToFile()"> |
| <h3>javaDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">javaDumpToFile</span>()</div> |
| <div class="block">Trigger a java dump. A java dump is in a human-readable format, and |
| summarizes the state of the JVM. |
| |
| The JVM will attempt to write the file to the default location. |
| |
| A string containing the actual file name written to is returned. |
| |
| 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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="heapDumpToFile(java.lang.String)"> |
| <h3>heapDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">heapDumpToFile</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></span></div> |
| <div class="block">Trigger a heap dump. The default heap dump format (a phd file) is not |
| human-readable. |
| |
| 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 file name written to is returned. This may not |
| be the same as the requested filename for several reasons: |
| <ul> |
| <li>null or the empty string were 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 file name 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fileNamePattern</code> - the file name to write to, which may be null, empty or include replacement tokens</dd> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - if the filename was invalid</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="heapDumpToFile()"> |
| <h3>heapDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">heapDumpToFile</span>()</div> |
| <div class="block">Trigger a heap dump. The default heap dump format (a phd file) is not |
| human-readable. |
| |
| The JVM will attempt to write the file to the default location. |
| |
| A string containing the actual file name written to is returned. |
| |
| 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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="systemDumpToFile(java.lang.String)"> |
| <h3>systemDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">systemDumpToFile</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></span></div> |
| <div class="block">Trigger a system dump. 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 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 file name written to is returned. This may not |
| be the same as the requested filename for several reasons: |
| <ul> |
| <li>null or the empty string were 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 file name 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fileNamePattern</code> - the file name to write to, which may be null, empty or include replacement tokens</dd> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - if the filename was invalid</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="systemDumpToFile()"> |
| <h3>systemDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">systemDumpToFile</span>()</div> |
| <div class="block">Trigger a system dump. 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 JVM will attempt to write the file to the default location. |
| |
| A string containing the actual file name written to is returned. |
| |
| 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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="snapDumpToFile(java.lang.String)"> |
| <h3>snapDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">snapDumpToFile</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> fileNamePattern)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></span></div> |
| <div class="block">Trigger a snap dump. The snap dump format is not human-readable |
| and must be processed using the trace formatting tool supplied |
| with the OpenJ9 JVM. |
| |
| 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 file name written to is returned. This may not |
| be the same as the requested filename for several reasons: |
| <ul> |
| <li>null or the empty string were 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 file name 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 class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>fileNamePattern</code> - the file name to write to, which may be null, empty or include replacement tokens</dd> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - if the filename was invalid</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="snapDumpToFile()"> |
| <h3>snapDumpToFile</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">snapDumpToFile</span>()</div> |
| <div class="block">Trigger a snap dump. The snap dump format is not human-readable |
| and must be processed using the trace formatting tool supplied |
| with the OpenJ9 JVM. |
| |
| The JVM will attempt to write the file to the default location. |
| |
| A string containing the actual file name written to is returned. |
| |
| 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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the file name that the dump was actually written to</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="triggerDump(java.lang.String)"> |
| <h3>triggerDump</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a></span> <span class="element-name">triggerDump</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> dumpOptions)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></span></div> |
| <div class="block">Trigger a dump with the specified options. |
| This method will trigger a dump of the specified type, |
| with the specified options, immediately. The dump type and |
| options are specified using the same string parameters |
| as the -Xdump flag as described in the section on dump agents |
| in the documentation for the OpenJ9 JVM. |
| |
| Settings that do not apply to dumps that occur immediately |
| ("range=", "priority=", "filter=", "events=", "none" and "defaults") |
| will be ignored. |
| |
| The "opts=" setting is supported if an option is used that causes two |
| dumps to occur only the filename for the first will be returned. |
| |
| If a filename is specified for the dump it may contain replacement strings |
| as specified in the documentation. In addition if a dump cannot be created |
| with the specified filename the JVM may attempt to write it to another location. |
| For these reasons you should always use the file name that is returned from this function |
| when looking for the dump rather than the name you supplied. |
| |
| If a security manager exists a permission check for com.ibm.jvm.DumpPermission will be |
| made, if this fails a SecurityException will be thrown. If a "tool" dump is requested an |
| additional check for com.ibm.jvm.ToolDumpPermission will also be made.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dumpOptions</code> - a dump settings string</dd> |
| <dt>Returns:</dt> |
| <dd>The file name of the dump that was created. The String "-" means the dump was written to stderr.</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/RuntimeException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - If the dump options are invalid or the dump operation fails</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if dumpSettings is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="setDumpOptions(java.lang.String)"> |
| <h3>setDumpOptions</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">setDumpOptions</span>​<span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a> dumpOptions)</span> |
| throws <span class="exceptions"><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a>, |
| <a href="DumpConfigurationUnavailableException.html" title="class in com.ibm.jvm">DumpConfigurationUnavailableException</a></span></div> |
| <div class="block">Sets options for the dump subsystem. |
| The dump option is passed in as an 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 DumpConfigurationUnavailableException if the dump configuration |
| cannot be altered. If this occurs it will usually be because a dump event is currently |
| being handled. As this can take some time depending on the dumps being generated an |
| exception is thrown rather than this call blocking the calling thread potentially for |
| minutes. |
| |
| If a security manager exists a permission check for com.ibm.jvm.DumpPermission will be |
| made, if this fails a SecurityException will be thrown. If a "tool" dump is specified an |
| additional check for com.ibm.jvm.ToolDumpPermission will also be made.</div> |
| <dl class="notes"> |
| <dt>Parameters:</dt> |
| <dd><code>dumpOptions</code> - the options string to set</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="InvalidDumpOptionException.html" title="class in com.ibm.jvm">InvalidDumpOptionException</a></code> - if the specified option cannot be set or is incorrect</dd> |
| <dd><code><a href="DumpConfigurationUnavailableException.html" title="class in com.ibm.jvm">DumpConfigurationUnavailableException</a></code> - If the dump configuration cannot be changed because a dump is currently in progress</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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/16/docs/api/java.base/java/lang/NullPointerException.html" title="class or interface in java.lang" class="external-link" target="_blank">NullPointerException</a></code> - if options is null</dd> |
| </dl> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="queryDumpOptions()"> |
| <h3>queryDumpOptions</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/String.html" title="class or interface in java.lang" class="external-link" target="_blank">String</a>[]</span> <span class="element-name">queryDumpOptions</span>()</div> |
| <div class="block">Returns the current dump configuration as an array of Strings. |
| 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. |
| |
| 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 class="notes"> |
| <dt>Returns:</dt> |
| <dd>the options strings</dd> |
| <dt>Throws:</dt> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="resetDumpOptions()"> |
| <h3>resetDumpOptions</h3> |
| <div class="member-signature"><span class="modifiers">public static</span> <span class="return-type">void</span> <span class="element-name">resetDumpOptions</span>() |
| throws <span class="exceptions"><a href="DumpConfigurationUnavailableException.html" title="class in com.ibm.jvm">DumpConfigurationUnavailableException</a></span></div> |
| <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 DumpConfigurationUnavailableException if the dump configuration |
| cannot be altered. If this occurs it will usually be because a dump event is currently |
| being handled. As this can take some time depending on the dumps being generated an |
| exception is thrown rather than this call blocking the calling thread potentially for |
| minutes. |
| |
| 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 class="notes"> |
| <dt>Throws:</dt> |
| <dd><code><a href="DumpConfigurationUnavailableException.html" title="class in com.ibm.jvm">DumpConfigurationUnavailableException</a></code> - if the dump configuration cannot be changed because a dump is currently in progress</dd> |
| <dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/SecurityException.html" title="class or interface in java.lang" class="external-link" 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> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><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/openj9/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright © 1998, 2021, IBM Corp. and others.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |