org.adroitlogic.x.management.tbsr.task

Class TaskBase

java.lang.Object

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

Direct Known Subclasses:

ArchiveTask, HeapDumpTask, InfoTask, LibDirInfoTask, ThreadDumpTask

public abstract class TaskBase
extends Object

Project-X troubleshoot reporting framework task template

A new Task for the troubleshoot report module can be defined by extending this class (or one of its subclasses) and annotating it with the TaskMeta and TaskParamMeta annotations appropriately. Tasks defined as such, will be accessible by their annotated task names via TaskRegistry and the management service TroubleshootService.

A Task should write its output to a file or file hierarchy located at the path corresponding to the outputRoot provided via execute(String, java.util.Map), and return a Status code indicating success or failure.

Values (user-specified, or default values if otherwise) for parameters defined in the TaskParamMeta annotation of the task, would be passed to it as a <String, String> during task execution via the execute(String, Map) method.

Exceptions arising during task execution should be rethrown to the parent task template, after (optionally) dealing with them within the task logic.

Since:

17.01

Author:

Janaka

Field Summary

Fields

Modifier and Type	Field and Description
protected XServerConfig	serverConfig

Constructor Summary

Constructors

Constructor and Description
TaskBase()

Method Summary

Modifier and Type	Method and Description
abstract Status	execute(String outputRoot, Map<String,String> parameters) Executes the core logic of the task.
String	getDescription()
String	getId()
String	getName()
Map<String,TaskParameterView>	getParameterDetails()
boolean	isIntensive()
boolean	isMaskable()
void	setDescription(String description)
void	setId(String id)
void	setIntensive(boolean intensive)
void	setMaskable(boolean maskable)
void	setName(String name)
void	setParameterDetails(Map<String,TaskParameterView> parameterDetails)
void	setServerConfig(XServerConfig serverConfig)
TaskView	toView() Returns a TaskView representation of this task

Methods inherited from class java.lang.Object

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

Field Detail

serverConfig

protected XServerConfig serverConfig

Constructor Detail

TaskBase

public TaskBase()

Method Detail

isMaskable

public final boolean isMaskable()

setMaskable

public final void setMaskable(boolean maskable)

isIntensive

public final boolean isIntensive()

setIntensive

public final void setIntensive(boolean intensive)

getId

public final String getId()

setId

public final void setId(String id)

getName

public final String getName()

setName

public final void setName(String name)

getDescription

public final String getDescription()

setDescription

public final void setDescription(String description)

getParameterDetails

public final Map<String,TaskParameterView> getParameterDetails()

setParameterDetails

public final void setParameterDetails(Map<String,TaskParameterView> parameterDetails)

setServerConfig

public void setServerConfig(XServerConfig serverConfig)

execute

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

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.

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

toView

public final TaskView toView()

Returns a TaskView representation of this task

Returns:

TaskView representation of this task