Google Git
Sign in
eclipse / www.eclipse.org / openj9 / docs / bad2f0a456181a4a2e06615016bd4e1590b9f7a5 / . / api / jdk16 / jdk.management / openj9 / lang / management / OpenJ9DiagnosticsMXBean.html
blob: 451afa43f10cf17a0dd5d8657ac28c11ade8d4c2 [file] [log] [blame]
<!DOCTYPE HTML>
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (16) -->
<title>OpenJ9DiagnosticsMXBean (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: jdk.management, package: openj9.lang.management, interface: OpenJ9DiagnosticsMXBean">
<meta name="generator" content="javadoc/ClassWriterImpl">
<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="../../../../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/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>
<div class="sub-nav">
<div>
<ul class="sub-nav-list">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</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>&nbsp;<a href="../../../module-summary.html">jdk.management</a></div>
<div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">openj9.lang.management</a></div>
<h1 title="Interface OpenJ9DiagnosticsMXBean" class="title">Interface OpenJ9DiagnosticsMXBean</h1>
</div>
<section class="description">
<dl class="notes">
<dt>All Superinterfaces:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html" title="class or interface in java.lang.management" class="external-link" target="_blank">PlatformManagedObject</a></code></dd>
</dl>
<dl class="notes">
<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>
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">OpenJ9DiagnosticsMXBean</span><span class="extends-implements">
extends <a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html" title="class or interface in java.lang.management" class="external-link" target="_blank">PlatformManagedObject</a></span></div>
<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>
</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-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab2 method-summary-table method-summary-table-tab3"><code><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-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#queryDumpOptions()">queryDumpOptions</a></span>()</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">Returns the current dump configuration as an array of Strings, or null if an internal error occurs.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#resetDumpOptions()">resetDumpOptions</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<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-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#setDumpOptions(java.lang.String)">setDumpOptions</a></span>&#8203;(<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>&nbsp;dumpOptions)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">This function sets options for the dump subsystem.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><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-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#triggerClassicHeapDump()">triggerClassicHeapDump</a></span>()</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.</div>
</div>
<div class="col-first even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#triggerDump(java.lang.String)">triggerDump</a></span>&#8203;(<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>&nbsp;dumpAgent)</code></div>
<div class="col-last even-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">This function triggers the specified dump agent.</div>
</div>
<div class="col-first odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3"><code><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-tab2 method-summary-table method-summary-table-tab3"><code><span class="member-name-link"><a href="#triggerDumpToFile(java.lang.String,java.lang.String)">triggerDumpToFile</a></span>&#8203;(<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>&nbsp;dumpAgent,
<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>&nbsp;fileNamePattern)</code></div>
<div class="col-last odd-row-color method-summary-table-tab2 method-summary-table method-summary-table-tab3">
<div class="block">This function triggers the specified dump agent.</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods.inherited.from.class.java.lang.management.PlatformManagedObject">Methods declared in interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html" title="class or interface in java.lang.management" class="external-link" target="_blank">PlatformManagedObject</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.management/java/lang/management/PlatformManagedObject.html#getObjectName()" title="class or interface in java.lang.management" class="external-link" target="_blank">getObjectName</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="resetDumpOptions()">
<h3>resetDumpOptions</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">resetDumpOptions</span>()
throws <span class="exceptions"><a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</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 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 class="notes">
<dt>Throws:</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/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>
<li>
<section class="detail" id="queryDumpOptions()">
<h3>queryDumpOptions</h3>
<div class="member-signature"><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>&nbsp;<span class="element-name">queryDumpOptions</span>()</div>
<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 class="notes">
<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="setDumpOptions(java.lang.String)">
<h3>setDumpOptions</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setDumpOptions</span>&#8203;<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>&nbsp;dumpOptions)</span>
throws <span class="exceptions"><a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a>,
<a href="ConfigurationUnavailableException.html" title="class in openj9.lang.management">ConfigurationUnavailableException</a></span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>dumpOptions</code> - the options string to be set</dd>
<dt>Throws:</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/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 dumpOptions is null</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="triggerDump(java.lang.String)">
<h3>triggerDump</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">triggerDump</span>&#8203;<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>&nbsp;dumpAgent)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a></span></div>
<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 class="notes">
<dt>Parameters:</dt>
<dd><code>dumpAgent</code> - the dump agent to be triggered</dd>
<dt>Throws:</dt>
<dd><code><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" 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/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="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 dumpAgent is null</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="triggerDumpToFile(java.lang.String,java.lang.String)">
<h3>triggerDumpToFile</h3>
<div class="member-signature"><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>&nbsp;<span class="element-name">triggerDumpToFile</span>&#8203;<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>&nbsp;dumpAgent,
<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>&nbsp;fileNamePattern)</span>
throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" target="_blank">IllegalArgumentException</a>,
<a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></span></div>
<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 class="notes">
<dt>Parameters:</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>Returns:</dt>
<dd>the file name that the dump was actually written to</dd>
<dt>Throws:</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/16/docs/api/java.base/java/lang/IllegalArgumentException.html" title="class or interface in java.lang" class="external-link" 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/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="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 dumpAgent is null</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="triggerClassicHeapDump()">
<h3>triggerClassicHeapDump</h3>
<div class="member-signature"><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>&nbsp;<span class="element-name">triggerClassicHeapDump</span>()
throws <span class="exceptions"><a href="InvalidOptionException.html" title="class in openj9.lang.management">InvalidOptionException</a></span></div>
<div class="block">This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>The file name of the dump that was created</dd>
<dt>Throws:</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/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 JVM 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>
</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/issues" target="_blank">Eclipse Openj9 issue.</a><br> Copyright &copy; 1998, 2021, IBM Corp. and others.</small></p>
</footer>
</div>
</div>
</body>
</html>