org.adroitlogic.x.management.tbsr.task

Class ArchiveTask

java.lang.Object

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

org.adroitlogic.x.management.tbsr.task.ArchiveTask

Direct Known Subclasses:

ConfDirArchiveTask, LibArchiveTask, LogDirArchiveTask, ProjectsDirArchiveTask

abstract class ArchiveTask
extends TaskBase

Archive creation 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
ArchiveTask()

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 Collection<String>	getMaskableFileTypes() Returns a list of file types (extensions) that should be checked for credential masking, during archiving; task-specific implementation should be provided by the actual task
(package private) abstract String	loadSourceFiles(Collection<File> files) Returns a Collection of source files (as a directory hierarchy) to be archived; task-specific implementation should be provided by the actual 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

ArchiveTask

ArchiveTask()

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

loadSourceFiles

abstract String loadSourceFiles(Collection<File> files)
                         throws Exception

Returns a Collection of source files (as a directory hierarchy) to be archived; task-specific implementation should be provided by the actual task

Parameters:

files - Collection of source file references

Returns:

common root directory path for the added files

Throws:

Exception - in case of a failure to load the source file

getMaskableFileTypes

abstract Collection<String> getMaskableFileTypes()

Returns a list of file types (extensions) that should be checked for credential masking, during archiving; task-specific implementation should be provided by the actual task

Returns:

Collection of Strings containing file types for masking