public interface OpenJ9DiagnosticsMXBean extends 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.
OpenJ9DiagnosticsMXBean
...
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
}
Modifier and Type | Method and Description |
---|---|
String[] |
queryDumpOptions()
Returns the current dump configuration as an array of Strings, or null if an internal error occurs.
|
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(String dumpOptions)
This function sets options for the dump subsystem.
|
String |
triggerClassicHeapDump()
This function triggers the heap dump agent and requests for a heap dump in CLASSIC format.
|
void |
triggerDump(String dumpAgent)
This function triggers the specified dump agent.
|
String |
triggerDumpToFile(String dumpAgent,
String fileNamePattern)
This function triggers the specified dump agent.
|
getObjectName
void resetDumpOptions() throws ConfigurationUnavailableException
ConfigurationUnavailableException
- if the configuration cannot be changed because a dump is already in progressSecurityException
- if there is a security manager and it doesn't allow the checks required to change the dump settingsString[] queryDumpOptions()
SecurityException
- if there is a security manager and it doesn't allow the checks required to read the dump settingsvoid setDumpOptions(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 progressSecurityException
- if there is a security manager and it doesn't allow the checks required to change the dump settingsNullPointerException
- if dumpOptions is nullvoid triggerDump(String dumpAgent) throws IllegalArgumentException
dumpAgent
- the dump agent to be triggeredIllegalArgumentException
- if the specified dump agent is invalid or unsupported by this methodRuntimeException
- if the vm does not contain RAS dump supportSecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpNullPointerException
- if dumpAgent is nullString triggerDumpToFile(String dumpAgent, String fileNamePattern) throws 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 invalidIllegalArgumentException
- if the specified dump agent is invalid or unsupported by this methodSecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpNullPointerException
- if dumpAgent is nullString triggerClassicHeapDump() throws InvalidOptionException
InvalidOptionException
- if the dump operation failsRuntimeException
- if the JVM does not contain RAS dump supportSecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumpEclipse OpenJ9 website.
To raise a bug report or suggest an improvement create an Eclipse OpenJ9 issue.
Copyright © 2001, 2024 IBM Corp. and others.