org.adroitlogic.x.management.tbsr.task

Class LibDirInfoTask

java.lang.Object

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

org.adroitlogic.x.management.tbsr.task.LibDirInfoTask

@TaskMeta(id="lib-dir-info",
          name="Library Directory Information",
          description="Lists the files reside inside the library directory and its main sub directories",
          maskable=false,
          intensive=false,
          taskParameters=@TaskParamMeta(name="output",description="output filename of the library directory information collection",configurable=false,defaultValue="lib_dir_content_[timestamp].txt"))
public class LibDirInfoTask
extends TaskBase

Library directory content information collector task for UltraESB troubleshoot report generation

Since:

17.01

Author:

Udith Gunaratna

Field Summary

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

serverConfig

Constructor Summary

Constructors

Constructor and Description
LibDirInfoTask()

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

LibDirInfoTask

public LibDirInfoTask()

Method Detail

execute

public 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 UltraESB, 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