public interface OpenJ9DiagnosticsMXBean
extends java.lang.management.PlatformManagedObject
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
|
Modifier and Type | Method and Description |
---|---|
void |
resetDumpOptions()
Reset the JVM dump options to the settings specified when the JVM was started removing any additional
configuration done since then.
|
void |
setDumpOptions(java.lang.String dumpOptions)
This function sets options for the dump subsystem.
|
java.lang.String |
triggerClassicHeapDump()
This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.
|
void |
triggerDump(java.lang.String dumpAgent)
This function triggers the specified dump agent.
|
java.lang.String |
triggerDumpToFile(java.lang.String dumpAgent,
java.lang.String fileNamePattern)
This function triggers the specified dump agent.
|
void resetDumpOptions() throws ConfigurationUnavailableException
ConfigurationUnavailableException
- if the configuration cannot be changed because a dump is already in progressjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to change the dump settingsvoid setDumpOptions(java.lang.String dumpOptions) throws InvalidOptionException, ConfigurationUnavailableException
dumpOptions
- the options string to be setInvalidOptionException
- if the specified dumpOptions cannot be set or is incorrectConfigurationUnavailableException
- if the configuration cannot be changed because a dump is already in progressjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to change the dump settingsjava.lang.NullPointerException
- if dumpOptions is nullvoid triggerDump(java.lang.String dumpAgent) throws java.lang.IllegalArgumentException
dumpAgent
- the dump agent to be triggeredjava.lang.IllegalArgumentException
- if the specified dump agent is invalid or unsupported by this methodjava.lang.RuntimeException
- if the vm does not contain RAS dump supportjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpjava.lang.NullPointerException
- if dumpAgent is nulljava.lang.String triggerDumpToFile(java.lang.String dumpAgent, java.lang.String fileNamePattern) throws java.lang.IllegalArgumentException, InvalidOptionException
dumpAgent
- the dump agent to be triggeredfileNamePattern
- the filename to write to, which may be null, empty or include replacement tokensInvalidOptionException
- if the fileNamePattern was invalidjava.lang.IllegalArgumentException
- if the specified dump agent is invalid or unsupported by this methodjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpjava.lang.NullPointerException
- if dumpAgent is nulljava.lang.String triggerClassicHeapDump() throws InvalidOptionException
InvalidOptionException
- if the dump operation failsjava.lang.RuntimeException
- if the JVM does not contain RAS dump supportjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpCopyright © 2003, 2018 IBM Corp. and others