org.eclipse.mat.snapshot.acquire
Interface IHeapDumpProvider

All Known Implementing Classes:

BaseProvider, IBMDumpProvider, IBMExecDumpProvider, IBMJavaDumpProvider, JMapHeapDumpProvider

public interface IHeapDumpProvider

Provides functionality to acquire a heap dump from a locally running Java process

Since:

1.0

Method Summary

java.io.File	acquireDump(VmInfo info, java.io.File preferredLocation, IProgressListener listener) Acquire a heap dump from a locally running Java process.
java.util.List<? extends VmInfo>	getAvailableVMs(IProgressListener listener) Returns a list of locally running Java processes from which the heap dump provider can attempt to acquire a heap dump

Method Detail

getAvailableVMs

java.util.List<? extends VmInfo> getAvailableVMs(IProgressListener listener)
                                                 throws SnapshotException

Returns a list of locally running Java processes from which the heap dump provider can attempt to acquire a heap dump

Parameters:

listener - a progress listener

Returns:

List the list of processes (VmInfo)

Throws:

SnapshotException

acquireDump

java.io.File acquireDump(VmInfo info,
                         java.io.File preferredLocation,
                         IProgressListener listener)
                         throws SnapshotException

Acquire a heap dump from a locally running Java process. The

Parameters:

info - a descriptor of the Java process which should be dumped

preferredLocation - a preferred filename under which the heap dump should be saved. The IHeapDumpProvider is not obliged to provide the heap dump at this location

listener - a progress listener

Returns:

the File under which the successfully generated heap dump is saved

Throws:

SnapshotException