javax.tools.diagnostics.vm
Interface DumpInitiatorDelegate

All Known Implementing Classes:
AbstractIBMSPIBasedDumpInitiatorDelegate, AbstractSignalBasedDumpInitiatorDelegate, HProfMBeanDumpDelegate, HProfSignalTriggeredDumpDelegate, IBMSPIBasedHeapDumpDelegate, IBMSPIBasedSystemDumpDelegate, JavaDumpDelegate

public interface DumpInitiatorDelegate

Interface that describes the required capabilities of specific dump initiator. Classes that implement this interface can be called by the Dump class to trigger a specific dump.


Method Summary
 boolean available()
          Called to check that the delegate has all available resources to proceed.
 DumpHandle createDumpHandle()
          Returns a Dump handle for a default configured dump
 DumpHandle createDumpHandle(DumpDescriptor descriptor)
          Returns a Dump handle for a dump that will match the provided descriptor on a "best can do" basis.
 DumpInitiatorCapabilities getCapabilities()
          Returns an object that describes the capabilities offered by this initiator
 java.lang.String getDumpType()
          Returns a literal that describes the dump being produced by this initiator.
 

Method Detail

getCapabilities

DumpInitiatorCapabilities getCapabilities()
Returns an object that describes the capabilities offered by this initiator

Returns:
a populated capabilities object

available

boolean available()
Called to check that the delegate has all available resources to proceed. This method should only be called by the Dump class This method will always be called before the first call to dump

Returns:
true if the delegate is available

createDumpHandle

DumpHandle createDumpHandle()
Returns a Dump handle for a default configured dump

Returns:
valid dump handle

createDumpHandle

DumpHandle createDumpHandle(DumpDescriptor descriptor)
Returns a Dump handle for a dump that will match the provided descriptor on a "best can do" basis.

Returns:
valid dump handle

getDumpType

java.lang.String getDumpType()
Returns a literal that describes the dump being produced by this initiator. The value can be used by callers to the DumpFactory API to retrieve a specific dump initiator.

Returns:
dump type literal


Copyright © 2010. All Rights Reserved.