public class Dump
extends java.lang.Object
Modifier and Type | Method and Description |
---|---|
static void |
HeapDump()
Cause a HeapDump to occur.
|
static java.lang.String |
heapDumpToFile()
Trigger a heap dump.
|
static java.lang.String |
heapDumpToFile(java.lang.String fileNamePattern)
Trigger a heap dump.
|
static void |
JavaDump()
Cause a JavaDump to occur.
|
static java.lang.String |
javaDumpToFile()
Trigger a java dump.
|
static java.lang.String |
javaDumpToFile(java.lang.String fileNamePattern)
Trigger a java dump.
|
static java.lang.String[] |
queryDumpOptions()
Returns the current dump configuration as an array of Strings.
|
static void |
resetDumpOptions()
Reset the JVM dump options to the settings specified when the JVM
was started removing any additional configuration done since then.
|
static void |
setDumpOptions(java.lang.String dumpOptions)
Sets options for the dump subsystem.
|
static void |
SnapDump()
Trigger a snap dump.
|
static java.lang.String |
snapDumpToFile()
Trigger a snap dump.
|
static java.lang.String |
snapDumpToFile(java.lang.String fileNamePattern)
Trigger a snap dump.
|
static void |
SystemDump()
Trigger a SystemDump to occur.
|
static java.lang.String |
systemDumpToFile()
Trigger a system dump.
|
static java.lang.String |
systemDumpToFile(java.lang.String fileNamePattern)
Trigger a system dump.
|
static java.lang.String |
triggerDump(java.lang.String dumpOptions)
Trigger a dump with the specified options.
|
public static void JavaDump()
java.lang.RuntimeException
- if the vm does not contain RAS dump supportpublic static void HeapDump()
java.lang.RuntimeException
- if the vm does not contain RAS dump supportpublic static void SystemDump()
java.lang.RuntimeException
- if the vm does not contain RAS dump supportpublic static void SnapDump()
java.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 take this dumppublic static java.lang.String javaDumpToFile(java.lang.String fileNamePattern) throws InvalidDumpOptionException
fileNamePattern
- the file name to write to, which may be null, empty or include replacement tokensInvalidDumpOptionException
- if the filename was invalidjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String javaDumpToFile()
java.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String heapDumpToFile(java.lang.String fileNamePattern) throws InvalidDumpOptionException
fileNamePattern
- the file name to write to, which may be null, empty or include replacement tokensInvalidDumpOptionException
- if the filename was invalidjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String heapDumpToFile()
java.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String systemDumpToFile(java.lang.String fileNamePattern) throws InvalidDumpOptionException
fileNamePattern
- the file name to write to, which may be null, empty or include replacement tokensInvalidDumpOptionException
- if the filename was invalidjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String systemDumpToFile()
java.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String snapDumpToFile(java.lang.String fileNamePattern) throws InvalidDumpOptionException
fileNamePattern
- the file name to write to, which may be null, empty or include replacement tokensInvalidDumpOptionException
- if the filename was invalidjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String snapDumpToFile()
java.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to trigger this dumppublic static java.lang.String triggerDump(java.lang.String dumpOptions) throws InvalidDumpOptionException
dumpOptions
- a dump settings stringjava.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 dumpInvalidDumpOptionException
- If the dump options are invalid or the dump operation failsjava.lang.NullPointerException
- if dumpSettings is nullpublic static void setDumpOptions(java.lang.String dumpOptions) throws InvalidDumpOptionException, DumpConfigurationUnavailableException
dumpOptions
- the options string to setInvalidDumpOptionException
- if the specified option cannot be set or is incorrectDumpConfigurationUnavailableException
- If the dump configuration cannot be changed because a dump is currently 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 options is nullpublic static java.lang.String[] queryDumpOptions()
java.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to read the dump settingspublic static void resetDumpOptions() throws DumpConfigurationUnavailableException
DumpConfigurationUnavailableException
- if the dump configuration cannot be changed because a dump is currently in progressjava.lang.SecurityException
- if there is a security manager and it doesn't allow the checks required to change the dump settings© Copyright 2003, 2015 IBM Corporation.