public final class ThreadMXBeanImpl extends DynamicMXBeanImpl implements java.lang.management.ThreadMXBean
ThreadMXBean
info
Modifier and Type | Method and Description |
---|---|
java.lang.management.ThreadInfo[] |
dumpAllThreads(boolean lockedMonitors,
boolean lockedSynchronizers)
Returns an array of
ThreadInfo objects holding information on all
threads that were alive when the call was invoked. |
long[] |
findDeadlockedThreads()
If supported by the virtual machine, this method can be used to retrieve
the
long id of all threads currently waiting on object
monitors or ownable synchronizers (synchronizers that make use of the
AbstractOwnableSynchronizer type and which are completely
owned by a single thread). |
long[] |
findMonitorDeadlockedThreads()
Returns the thread identifiers of every thread in this virtual machine
that is currently blocked in a deadlock situation over a monitor object.
|
long[] |
getAllThreadIds()
Returns an array of the identifiers of all of the threads that are alive
in the current virtual machine.
|
long |
getCurrentThreadCpuTime()
If supported by the virtual machine, returns the total CPU usage time for
the currently running thread.
|
long |
getCurrentThreadUserTime()
If supported by the virtual machine, returns the total CPU usage time for
the current thread running in user mode.
|
int |
getDaemonThreadCount()
Returns the number of daemon threads currently alive in the virtual
machine.
|
int |
getPeakThreadCount()
Returns the peak number of threads that have ever been alive in the
virtual machine at any one instant since either the virtual machine
start-up or the peak was reset.
|
int |
getThreadCount()
Returns the number of threads currently alive in the virtual machine.
|
long |
getThreadCpuTime(long id)
If supported by the virtual machine, returns the total CPU usage time for
the thread with the specified identifier.
|
java.lang.management.ThreadInfo |
getThreadInfo(long id)
Returns a
ThreadInfo object for the thread with the specified
identifier. |
java.lang.management.ThreadInfo[] |
getThreadInfo(long[] ids)
Returns an array of
ThreadInfo objects ; one for each of the
threads specified in the input array of identifiers. |
java.lang.management.ThreadInfo[] |
getThreadInfo(long[] ids,
boolean lockedMonitors,
boolean lockedSynchronizers)
Get together information for threads and create instances of the
ThreadInfo class.
|
java.lang.management.ThreadInfo[] |
getThreadInfo(long[] ids,
int maxDepth)
Returns an array of
ThreadInfo objects ; one for each of the
threads specified in the ids argument. |
java.lang.management.ThreadInfo |
getThreadInfo(long id,
int maxDepth)
Returns a
ThreadInfo object for the thread with the specified
identifier. |
long |
getThreadUserTime(long id)
If supported by the virtual machine, returns the total CPU usage time for
the thread with the specified identifier when running in user mode.
|
long |
getTotalStartedThreadCount()
Returns the number of threads that have been started in this virtual
machine since it came into being.
|
boolean |
isCurrentThreadCpuTimeSupported()
Returns a boolean indication of whether or not the virtual machine
supports the CPU timing of the current thread.
|
boolean |
isObjectMonitorUsageSupported()
Returns a boolean indication of whether or not the virtual machine
supports the monitoring of object monitor usage.
|
boolean |
isSynchronizerUsageSupported()
Returns a boolean indication of whether or not the virtual machine
supports the monitoring of ownable synchronizers (synchronizers that make
use of the
AbstractOwnableSynchronizer type and which are
completely owned by a single thread). |
boolean |
isThreadContentionMonitoringEnabled()
Returns a boolean indication of whether or not the monitoring of thread
contention situations is enabled on this virtual machine.
|
boolean |
isThreadContentionMonitoringSupported()
Returns a boolean indication of whether or not the monitoring of thread
contention situations is supported on this virtual machine.
|
boolean |
isThreadCpuTimeEnabled()
Returns a boolean indication of whether or not the CPU timing of threads
is enabled on this virtual machine.
|
boolean |
isThreadCpuTimeSupported()
Returns a boolean indication of whether or not the virtual machine
supports the CPU time measurement of any threads (current or otherwise).
|
void |
resetPeakThreadCount()
Resets the peak thread count to be the current number of threads alive in
the virtual machine when the call is made.
|
void |
setThreadContentionMonitoringEnabled(boolean enable)
Updates the virtual machine to either enable or disable the monitoring of
thread contention situations.
|
void |
setThreadCpuTimeEnabled(boolean enable)
If supported, updates the virtual machine to either enable or disable the
CPU timing of threads.
|
getAttribute, getAttributes, getMBeanInfo, getPresentAttribute, getPresentOperation, initMBeanInfo, invoke, setAttribute, setAttributes, setMBeanInfo
public long[] findMonitorDeadlockedThreads()
java.lang.management.ThreadMXBean
ThreadMXBean.findDeadlockedThreads()
method.
It is recommended that this method be used solely for problem determination analysis and not as a means of managing thread synchronization in a virtual machine. This is because the method may be very expensive to run.
findMonitorDeadlockedThreads
in interface java.lang.management.ThreadMXBean
null
if
there are currently no threads in that category.public long[] getAllThreadIds()
java.lang.management.ThreadMXBean
getAllThreadIds
in interface java.lang.management.ThreadMXBean
public long getCurrentThreadCpuTime()
java.lang.management.ThreadMXBean
Method ThreadMXBean.isCurrentThreadCpuTimeSupported()
may be used to
determine if current thread CPU timing is supported on the virtual
machine. On virtual machines where current thread CPU timing is
supported, the method ThreadMXBean.isThreadCpuTimeEnabled()
may be used to
determine if thread CPU timing is actually enabled.
The return value is identical to that which would be obtained by calling
ThreadMXBean.getThreadCpuTime(long)
with an argument
Thread.currentThread().getId())
.
getCurrentThreadCpuTime
in interface java.lang.management.ThreadMXBean
-1
.public long getCurrentThreadUserTime()
java.lang.management.ThreadMXBean
Method ThreadMXBean.isCurrentThreadCpuTimeSupported()
may be used to
determine if current thread CPU timing is supported on the virtual
machine. On virtual machines where current thread CPU timing is
supported, the method ThreadMXBean.isThreadCpuTimeEnabled()
may be used to
determine if thread CPU timing is actually enabled.
The return value is identical to that which would be obtained by calling
ThreadMXBean.getThreadUserTime(long)
with an argument
Thread.currentThread().getId())
.
getCurrentThreadUserTime
in interface java.lang.management.ThreadMXBean
-1
.public int getDaemonThreadCount()
java.lang.management.ThreadMXBean
getDaemonThreadCount
in interface java.lang.management.ThreadMXBean
public int getPeakThreadCount()
java.lang.management.ThreadMXBean
getPeakThreadCount
in interface java.lang.management.ThreadMXBean
ThreadMXBean.resetPeakThreadCount()
public int getThreadCount()
java.lang.management.ThreadMXBean
getThreadCount
in interface java.lang.management.ThreadMXBean
public long getThreadCpuTime(long id)
java.lang.management.ThreadMXBean
Method ThreadMXBean.isThreadCpuTimeSupported()
may be used to determine if
the CPU timing of threads is supported on the virtual machine. On virtual
machines where current thread CPU timing is supported, the method
ThreadMXBean.isThreadCpuTimeEnabled()
may be used to determine if thread CPU
timing is actually enabled.
getThreadCpuTime
in interface java.lang.management.ThreadMXBean
id
- the identifier for a thread. Must be a positive number greater
than zero.id
, the number of nanoseconds CPU time used by
the thread. On virtual machines where thread CPU timing is
supported but not enabled, or where there is no living thread
with identifier id
present in the virtual machine,
a value of -1
is returned.ThreadMXBean.isThreadCpuTimeSupported()
,
ThreadMXBean.isThreadCpuTimeEnabled()
public java.lang.management.ThreadInfo getThreadInfo(long id)
java.lang.management.ThreadMXBean
ThreadInfo
object for the thread with the specified
identifier. The returned object will not have a stack trace so that a
call to its getStackTrace()
method will result in an empty
StackTraceElement
array. Similarly, the returned object
will hold no details of locked synchronizers or locked object monitors
for the specified thread; calls to getLockedMonitors()
and
getLockedSynchronizers
will both return array values.getThreadInfo
in interface java.lang.management.ThreadMXBean
id
- the identifier for a thread. Must be a positive number greater
than zero.id
maps to a living thread in the
virtual machine (i.e. a started thread which has not yet died),
this method returns a ThreadInfo
object corresponding to
that thread. Otherwise, returns null
.public java.lang.management.ThreadInfo[] getThreadInfo(long[] ids)
java.lang.management.ThreadMXBean
ThreadInfo
objects ; one for each of the
threads specified in the input array of identifiers. None of the objects
in the return array will have a stack trace so that a call to its
getStackTrace()
method will result in an empty
StackTraceElement
array. Similarly, the returned object
will hold no details of locked synchronizers or locked object monitors
for the specified thread; calls to getLockedMonitors()
and
getLockedSynchronizers
will both return array values.getThreadInfo
in interface java.lang.management.ThreadMXBean
ids
- an array of thread identifiers. Each one must be a positive
number greater than zero.ThreadInfo
objects with each entry
corresponding to one of the threads specified in the input array
of identifiers. The return array will therefore have an identical
number of elements to the input ids
array. If an
entry in the ids
array is invalid (there is no
living thread with the supplied identifier in the virtual
machine) then the corresponding entry in the return array will be
a null
.public java.lang.management.ThreadInfo[] getThreadInfo(long[] ids, int maxDepth)
java.lang.management.ThreadMXBean
ThreadInfo
objects ; one for each of the
threads specified in the ids
argument. The stack trace
information in the returned objects will depend on the value of the
maxDepth
argument which specifies the maximum number of
StackTraceElement
instances to try and include. A subsequent call
to any of the returned objects' getStackTrace()
method
should result in a StackTraceElement
array of up to
maxDepth
elements. A maxDepth
value of
Integer.MAX_VALUE
will attempt to obtain all of the stack
trace information for each specified thread while a maxDepth
value of zero will yield none.
The returned object will hold no details of locked synchronizers or
locked object monitors for the specified thread; calls to
getLockedMonitors()
and
getLockedSynchronizers
will both return array values.
getThreadInfo
in interface java.lang.management.ThreadMXBean
ids
- an array of thread identifiers. Each must be a positive number
greater than zero.maxDepth
- the maximum number of stack trace entries to be
included in each of the returned ThreadInfo
objects. Supplying Integer.MAX_VALUE
attempts
to obtain all of the stack traces. Only a positive value is
expected.ThreadInfo
objects. The size of the
array will be identical to that of the ids
argument. Null elements will be placed in the array if the
corresponding thread identifier in ids
does not
resolve to a living thread in the virtual machine (i.e. a started
thread which has not yet died).public java.lang.management.ThreadInfo[] getThreadInfo(long[] ids, boolean lockedMonitors, boolean lockedSynchronizers)
Assumes that caller has already carried out error checking on the
id
and maxDepth
arguments.
getThreadInfo
in interface java.lang.management.ThreadMXBean
ids
- thread idslockedMonitors
- if true
attempt to set the returned
ThreadInfo
with details of object monitors
locked by the specified threadlockedSynchronizers
- if true
attempt to set the returned
ThreadInfo
with details of ownable
synchronizers locked by the specified threadpublic java.lang.management.ThreadInfo getThreadInfo(long id, int maxDepth)
java.lang.management.ThreadMXBean
ThreadInfo
object for the thread with the specified
identifier. The stack trace information in the returned object will
depend on the value of the maxDepth
argument which
specifies the maximum number of StackTraceElement
instances to
include. A subsequent call to the returned object's
getStackTrace()
method should then result in a
StackTraceElement
array of up to maxDepth
elements. A maxDepth
value of
Integer.MAX_VALUE
will obtain all of the stack trace
information for the thread while a maxDepth
value of zero
will yield none.
It is possible that the virtual machine may be unable to supply any stack
trace information for the specified thread. In that case the returned
ThreadInfo
object will have an empty array of
StackTraceElement
s.
The returned object will hold no details of locked synchronizers or
locked object monitors for the specified thread; calls to
getLockedMonitors()
and
getLockedSynchronizers
will both return array values.
getThreadInfo
in interface java.lang.management.ThreadMXBean
id
- the identifier for a thread. Must be a positive number greater
than zero.maxDepth
- the maximum number of stack trace entries to be
included in the returned ThreadInfo
object.
Supplying Integer.MAX_VALUE
obtains all of the
stack trace. Only a positive value is expected.id
maps to a living thread in the
virtual machine (i.e. a started thread which has not yet died),
this method returns a ThreadInfo
object corresponding to
that thread. Otherwise, returns null
.public long getThreadUserTime(long id)
java.lang.management.ThreadMXBean
Method ThreadMXBean.isThreadCpuTimeSupported()
may be used to determine if
the CPU timing of threads is supported on the virtual machine. On virtual
machines where current thread CPU timing is supported, the method
ThreadMXBean.isThreadCpuTimeEnabled()
may be used to determine if thread CPU
timing is actually enabled.
getThreadUserTime
in interface java.lang.management.ThreadMXBean
id
- the identifier for a thread. Must be a positive number greater
than zero.id
, the number of nanoseconds CPU time used by
the thread running in user mode. On virtual machines where thread
CPU timing is supported but not enabled, or where there is no
living thread with identifier id
present in the
virtual machine, a value of -1
is returned.
If thread CPU timing was disabled when the thread was started
then the virtual machine is free to choose any measurement start
time between when the virtual machine started up and when thread
CPU timing was enabled with a call to
ThreadMXBean.setThreadCpuTimeEnabled(boolean)
.
ThreadMXBean.isThreadCpuTimeSupported()
,
ThreadMXBean.isThreadCpuTimeEnabled()
public long getTotalStartedThreadCount()
java.lang.management.ThreadMXBean
getTotalStartedThreadCount
in interface java.lang.management.ThreadMXBean
public boolean isCurrentThreadCpuTimeSupported()
java.lang.management.ThreadMXBean
Note that this method must return true
if
ThreadMXBean.isThreadCpuTimeSupported()
returns true
.
isCurrentThreadCpuTimeSupported
in interface java.lang.management.ThreadMXBean
true
if CPU timing of the current thread is
supported, otherwise false
.public boolean isThreadContentionMonitoringEnabled()
java.lang.management.ThreadMXBean
isThreadContentionMonitoringEnabled
in interface java.lang.management.ThreadMXBean
true
if thread contention monitoring is enabled,
false
otherwise.public boolean isThreadContentionMonitoringSupported()
java.lang.management.ThreadMXBean
isThreadContentionMonitoringSupported
in interface java.lang.management.ThreadMXBean
true
if thread contention monitoring is supported,
false
otherwise.public boolean isThreadCpuTimeEnabled()
java.lang.management.ThreadMXBean
isThreadCpuTimeEnabled
in interface java.lang.management.ThreadMXBean
true
if thread CPU timing is enabled,
false
otherwise.ThreadMXBean.isThreadCpuTimeSupported()
public boolean isThreadCpuTimeSupported()
java.lang.management.ThreadMXBean
isThreadCpuTimeSupported
in interface java.lang.management.ThreadMXBean
true
if the virtual machine supports the CPU
timing of threads, false
otherwise.public void resetPeakThreadCount()
java.lang.management.ThreadMXBean
resetPeakThreadCount
in interface java.lang.management.ThreadMXBean
public void setThreadContentionMonitoringEnabled(boolean enable)
java.lang.management.ThreadMXBean
If it is supported, the virtual machine will initially not monitor thread contention situations.
setThreadContentionMonitoringEnabled
in interface java.lang.management.ThreadMXBean
enable
- enable thread contention monitoring if true
,
otherwise disable thread contention monitoring.ThreadMXBean.isThreadContentionMonitoringSupported()
public void setThreadCpuTimeEnabled(boolean enable)
java.lang.management.ThreadMXBean
The default value of this property depends on the underlying operating system on which the virtual machine is running.
setThreadCpuTimeEnabled
in interface java.lang.management.ThreadMXBean
enable
- enable thread CPU timing if true
, otherwise
disable thread CPU timingThreadMXBean.isThreadCpuTimeSupported()
public boolean isObjectMonitorUsageSupported()
java.lang.management.ThreadMXBean
isObjectMonitorUsageSupported
in interface java.lang.management.ThreadMXBean
true
if object monitor usage is permitted,
otherwise false
public boolean isSynchronizerUsageSupported()
java.lang.management.ThreadMXBean
AbstractOwnableSynchronizer
type and which are
completely owned by a single thread).isSynchronizerUsageSupported
in interface java.lang.management.ThreadMXBean
true
if synchronizer usage monitoring is
permitted, otherwise false
public long[] findDeadlockedThreads()
java.lang.management.ThreadMXBean
long
id of all threads currently waiting on object
monitors or ownable synchronizers (synchronizers that make use of the
AbstractOwnableSynchronizer
type and which are completely
owned by a single thread). To determine the threads currently deadlocked
by object monitors only use the ThreadMXBean.findMonitorDeadlockedThreads()
method.
It is recommended that this method be used solely for problem determination analysis and not as a means of managing thread synchronization in a virtual machine. This is because the method may be very expensive to run.
findDeadlockedThreads
in interface java.lang.management.ThreadMXBean
null
is returned.ThreadMXBean.isSynchronizerUsageSupported()
public java.lang.management.ThreadInfo[] dumpAllThreads(boolean lockedMonitors, boolean lockedSynchronizers)
java.lang.management.ThreadMXBean
ThreadInfo
objects holding information on all
threads that were alive when the call was invoked.dumpAllThreads
in interface java.lang.management.ThreadMXBean
lockedMonitors
- boolean indication of whether or not information on all
currently locked object monitors is to be included in the
returned arraylockedSynchronizers
- boolean indication of whether or not information on all
currently locked ownable synchronizers is to be included in
the returned arrayThreadInfo
objects