blob: 485ddac8888f82c0507e5fcc31334957e61f01ac [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>RuntimeMXBean (OpenJ9 Monitoring and Management Interface Classes)</title>
<meta name="keywords" content="com.ibm.lang.management.RuntimeMXBean interface">
<meta name="keywords" content="getCPULoad()">
<meta name="keywords" content="getProcessID()">
<meta name="keywords" content="getVMGeneratedCPULoad()">
<meta name="keywords" content="getVMIdleState()">
<meta name="keywords" content="isVMIdle()">
<meta name="keywords" content="isAttachApiInitialized()">
<meta name="keywords" content="isAttachApiTerminated()">
<meta name="keywords" content="getVmId()">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="RuntimeMXBean (OpenJ9 Monitoring and Management Interface Classes)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6,"i6":6,"i7":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";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RuntimeMXBean.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/lang/management/ProcessorUsageRetrievalException.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/RuntimeMXBean.VMIdleStates.html" title="enum in com.ibm.lang.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/lang/management/RuntimeMXBean.html" target="_top">Frames</a></li>
<li><a href="RuntimeMXBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.ibm.lang.management</div>
<h2 title="Interface RuntimeMXBean" class="title">Interface RuntimeMXBean</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">RuntimeMXBean</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">RuntimeMXBean</span>
extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">RuntimeMXBean</a></pre>
<div class="block">The OpenJ9 extension interface for the runtime system of the virtual machine.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Nested Class Summary table, listing nested classes, and an explanation">
<caption><span>Nested Classes</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Interface and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static class&nbsp;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.VMIdleStates.html" title="enum in com.ibm.lang.management">RuntimeMXBean.VMIdleStates</a></span></code>
<div class="block">Defines the different states of <a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getVMIdleState--"><code>getVMIdleState()</code></a>.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getCPULoad--">getCPULoad</a></span>()</code>
<div class="block">Returns a double value which holds the system load average calculated for
the minute preceding the call, where <i>system load average</i> is taken
to mean the following:</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>long</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getProcessID--">getProcessID</a></span>()</code>
<div class="block">Returns the native process identifier that identifies the current
Java process to the operating system.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>double</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getVMGeneratedCPULoad--">getVMGeneratedCPULoad</a></span>()</code>
<div class="block">Returns a system load average calculated over the minute preceding
the call averaged over the number of CPU available to Java virtual
machine process.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getVmId--">getVmId</a></span>()</code>
<div class="block">This is provided for the benefit of applications which use attach API to load JVMTI agents
into their own JVMs.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="../../../../com/ibm/lang/management/RuntimeMXBean.VMIdleStates.html" title="enum in com.ibm.lang.management">RuntimeMXBean.VMIdleStates</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#getVMIdleState--">getVMIdleState</a></span>()</code>
<div class="block">Returns current JVM Idle state.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#isAttachApiInitialized--">isAttachApiInitialized</a></span>()</code>
<div class="block">Query the state of the Attach API.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#isAttachApiTerminated--">isAttachApiTerminated</a></span>()</code>
<div class="block">Query the state of the Attach API.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/ibm/lang/management/RuntimeMXBean.html#isVMIdle--">isVMIdle</a></span>()</code>&nbsp;</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.management.RuntimeMXBean">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true" target="_blank" title="class or interface in java.lang.management">RuntimeMXBean</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getBootClassPath--" title="class or interface in java.lang.management">getBootClassPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getClassPath--" title="class or interface in java.lang.management">getClassPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getInputArguments--" title="class or interface in java.lang.management">getInputArguments</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getLibraryPath--" title="class or interface in java.lang.management">getLibraryPath</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getManagementSpecVersion--" title="class or interface in java.lang.management">getManagementSpecVersion</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getName--" title="class or interface in java.lang.management">getName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getSpecName--" title="class or interface in java.lang.management">getSpecName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getSpecVendor--" title="class or interface in java.lang.management">getSpecVendor</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getSpecVersion--" title="class or interface in java.lang.management">getSpecVersion</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getStartTime--" title="class or interface in java.lang.management">getStartTime</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getSystemProperties--" title="class or interface in java.lang.management">getSystemProperties</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getUptime--" title="class or interface in java.lang.management">getUptime</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getVmName--" title="class or interface in java.lang.management">getVmName</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getVmVendor--" title="class or interface in java.lang.management">getVmVendor</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#getVmVersion--" title="class or interface in java.lang.management">getVmVersion</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/RuntimeMXBean.html?is-external=true#isBootClassPathSupported--" title="class or interface in java.lang.management">isBootClassPathSupported</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.management.PlatformManagedObject">
<!-- -->
</a>
<h3>Methods inherited from interface&nbsp;java.lang.management.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true" target="_blank" title="class or interface in java.lang.management">PlatformManagedObject</a></h3>
<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/PlatformManagedObject.html?is-external=true#getObjectName--" title="class or interface in java.lang.management">getObjectName</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getCPULoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getCPULoad</h4>
<pre>double&nbsp;getCPULoad()</pre>
<div class="block">Returns a double value which holds the system load average calculated for
the minute preceding the call, where <i>system load average</i> is taken
to mean the following:
<p>
The time-averaged value of the sum of the number of runnable entities
running on the available processors and the number of runnable entities
ready and queued to run on the available processors. The averaging
technique adopted can vary depending on the underlying operating system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>normally, the system load average as a double. If the system load
average is not obtainable (e.g. because the calculation may
involve an unacceptable performance impact) then a negative value
is returned.</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.6</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/management/OperatingSystemMXBean.html?is-external=true#getSystemLoadAverage--" title="class or interface in java.lang.management"><code>OperatingSystemMXBean.getSystemLoadAverage()</code></a></dd>
</dl>
</li>
</ul>
<a name="getProcessID--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProcessID</h4>
<pre>long&nbsp;getProcessID()</pre>
<div class="block">Returns the native process identifier that identifies the current
Java process to the operating system. The value is prone to being
recycled over a period of time, as considered suitable by the
operating system.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A long representing the process ID (pid) on the underlying
operating system.</dd>
</dl>
</li>
</ul>
<a name="getVMGeneratedCPULoad--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVMGeneratedCPULoad</h4>
<pre>double&nbsp;getVMGeneratedCPULoad()</pre>
<div class="block">Returns a system load average calculated over the minute preceding
the call averaged over the number of CPU available to Java virtual
machine process.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>A double indicating the average system load per processor.
If the system load average is not available, it returns a negative
value to indicate this.</dd>
</dl>
</li>
</ul>
<a name="getVMIdleState--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVMIdleState</h4>
<pre><a href="../../../../com/ibm/lang/management/RuntimeMXBean.VMIdleStates.html" title="enum in com.ibm.lang.management">RuntimeMXBean.VMIdleStates</a>&nbsp;getVMIdleState()</pre>
<div class="block">Returns current JVM Idle state.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>JVM idle state value - i.e active / idle</dd>
</dl>
</li>
</ul>
<a name="isVMIdle--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isVMIdle</h4>
<pre>boolean&nbsp;isVMIdle()</pre>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if JVM state is idle. Otherwise returns false</dd>
</dl>
</li>
</ul>
<a name="isAttachApiInitialized--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttachApiInitialized</h4>
<pre>boolean&nbsp;isAttachApiInitialized()</pre>
<div class="block">Query the state of the Attach API. Return false if the Attach API is:
- still initializing
- disabled
- terminated by VM shutdown</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if Attach API is initialized</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
</dl>
</li>
</ul>
<a name="isAttachApiTerminated--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAttachApiTerminated</h4>
<pre>boolean&nbsp;isAttachApiTerminated()</pre>
<div class="block">Query the state of the Attach API. Return true if the Attach API is:
- disabled
- terminated by VM shutdown
and false if it is
- still initializing
- initialized and running</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if Attach API is terminated</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
</dl>
</li>
</ul>
<a name="getVmId--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getVmId</h4>
<pre><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html?is-external=true" target="_blank" title="class or interface in java.lang">String</a>&nbsp;getVmId()</pre>
<div class="block">This is provided for the benefit of applications which use attach API to load JVMTI agents
into their own JVMs.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>Attach API Virtual Machine ID of this VM</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>1.8</dd>
</dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/RuntimeMXBean.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-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><strong>OpenJ9 Monitoring and Management Interface Classes</strong></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/ibm/lang/management/ProcessorUsageRetrievalException.html" title="class in com.ibm.lang.management"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../com/ibm/lang/management/RuntimeMXBean.VMIdleStates.html" title="enum in com.ibm.lang.management"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/ibm/lang/management/RuntimeMXBean.html" target="_top">Frames</a></li>
<li><a href="RuntimeMXBean.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;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>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li><a href="#nested.class.summary">Nested</a>&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<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/openj9/issues" target="_blank">Eclipse OpenJ9 issue.</a><br> Copyright &copy; 2001, 2021, IBM Corp. and others.</small></p>
</body>
</html>