org.adroitlogic.x.management.tbsr.task

Class HeapDumpTask

java.lang.Object

org.adroitlogic.x.management.tbsr.task.TaskBase

org.adroitlogic.x.management.tbsr.task.HeapDumpTask

@TaskMeta(id="heap-dump",
          name="JVM Heap Dump",
          description="produces a heap dump of the JVM running the UltraESB instance",
          maskable=false,
          intensive=true,
          taskParameters=@TaskParamMeta(name="output",description="output filename of the temporary heap dump file",configurable=false,defaultValue="heap_[timestamp].hprof"))
public class HeapDumpTask
extends TaskBase

Heap dump task for UltraESB troubleshoot report generation

Since:

17.01

Author:

Janaka

Field Summary

Fields inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

serverConfig

Constructor Summary

Constructors

Constructor and Description
HeapDumpTask()

Method Summary

Modifier and Type	Method and Description
Status	execute(String outputRoot, Map<String,String> parameters) Executes the core logic of the task.

Methods inherited from class org.adroitlogic.x.management.tbsr.task.TaskBase

getDescription, getId, getName, getParameterDetails, isIntensive, isMaskable, setDescription, setId, setIntensive, setMaskable, setName, setParameterDetails, setServerConfig, toView

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeapDumpTask

public HeapDumpTask()

Method Detail

execute

public Status execute(String outputRoot,
                      Map<String,String> parameters)
               throws Exception

Description copied from class: TaskBase

Executes the core logic of the task. This method should dump the output of the task to a preconfigured file on the instance, located at the location pointed to by the File.separator-terminated path defined by the outputRoot parameter. Any exceptions should be thrown to the base method, for maintaining proper exception notification.

Specified by:

execute in class TaskBase

Parameters:

outputRoot - root directory for task output file(s)

parameters - runtime parameters for the task

Returns:

final execution status of task

Throws:

Exception - in case of a failure to execute the task