org.adroitlogic.x.management.tbsr.task

Class InfoTask

java.lang.Object

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

org.adroitlogic.x.management.tbsr.task.InfoTask

Direct Known Subclasses:

ServerInfoTask, SystemInfoTask

abstract class InfoTask
extends TaskBase

Information retrieval task template for UltraESB troubleshoot reporting framework

Any task extending this task must provide TBSRConstants.OUTPUT_FILE as a parameter.

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
InfoTask()

Method Summary

Modifier and Type	Method and Description
Status	execute(String outputRoot, Map<String,String> parameters) Executes the core logic of the task.
(package private) abstract DetailsMap	getInfoMap() Retrieves and returns information relevant to the operation, as a DetailsMap; task-specific implementation should be provided by the actual task
(package private) abstract String	getInfoType() Returns a String representing the type of information provided by the operation (e.g.

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

InfoTask

InfoTask()

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

getInfoMap

abstract DetailsMap getInfoMap()
                        throws Exception

Retrieves and returns information relevant to the operation, as a DetailsMap; task-specific implementation should be provided by the actual task

Returns:

DetailsMap containing retrieved information as key-value pairs

Throws:

Exception - in case of a failure to get the info map

getInfoType

abstract String getInfoType()

Returns a String representing the type of information provided by the operation (e.g. JVM, server, etc.); task-specific implementation should be provided by the actual task

Returns:

String representing the type of information