org.adroitlogic.x.management.tbsr.execution

Class ExecutionContext

java.lang.Object

org.adroitlogic.x.management.tbsr.execution.ExecutionContext

public class ExecutionContext
extends Object

Execution context representation for a troubleshoot reporting session. This class will be used for tracking the status of an ongoing troubleshoot reporting session.

Since:

17.01

Author:

Janaka

Constructor Summary

Constructors

Constructor and Description
ExecutionContext(ExecutionConfigView parameters, Map<String,TaskBase> availableTasks) Initializes the context, task list and execution status maintaining infrastructure

Method Summary

Modifier and Type	Method and Description
TaskResultView	getCurrentTaskProgress() Returns the TaskResultView for the latest run task
Status	getOverallStatus() Returns the overall status of the task execution session.
(package private) ExecutionConfigView	getParameters()
long	getStartTime() Gives the start time of this execution context
String	getTargetFilePath() Returns the actual pathname where the final output file of this session will be created, falling back to system temp dir if not specified by invoker
ExecutionSummaryView	getTaskExecutionSummary() Returns the status report of this execution session
(package private) Map<TaskBase,Map<String,String>>	getTasks()
(package private) void	markStartExecution() Marks execution starting point of overall session
(package private) void	setOverallStatus(Status status)
void	setTargetFilePath(String filePath) Updates the pathname where the final output file of this session will be created
(package private) void	updateStatus(String taskId, long timestamp, Status status) Sets the latest status of a task, and updates the status report
(package private) void	updateStatus(String taskId, long timestamp, Status status, String extraInfo) Sets the latest status of a task, and updates the status report

Methods inherited from class java.lang.Object

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

Constructor Detail

ExecutionContext

public ExecutionContext(ExecutionConfigView parameters,
                        Map<String,TaskBase> availableTasks)

Initializes the context, task list and execution status maintaining infrastructure

Parameters:

parameters - invocation parameters for this session

availableTasks - Map of all TaskBases available on the UltraESB instance

Method Detail

getParameters

ExecutionConfigView getParameters()

getTasks

Map<TaskBase,Map<String,String>> getTasks()

getTargetFilePath

public String getTargetFilePath()

Returns the actual pathname where the final output file of this session will be created, falling back to system temp dir if not specified by invoker

Returns:

pathname of the final output file

setTargetFilePath

public void setTargetFilePath(String filePath)

Updates the pathname where the final output file of this session will be created

Parameters:

filePath - new file pathname

getStartTime

public long getStartTime()

Gives the start time of this execution context

Returns:

the start time of this execution context

getCurrentTaskProgress

public TaskResultView getCurrentTaskProgress()

Returns the TaskResultView for the latest run task

Returns:

TaskResultView for the latest run task

getOverallStatus

public Status getOverallStatus()

Returns the overall status of the task execution session. The overall status effectively represents the status of the initialization and finalization tasks, regardless of the statuses of the actual tasks (i.e. whether a troubleshoot report was created successfully, with complete or partial content).

Returns:

Status indicating overall status of the session

setOverallStatus

void setOverallStatus(Status status)

getTaskExecutionSummary

public ExecutionSummaryView getTaskExecutionSummary()

Returns the status report of this execution session

Returns:

ExecutionSummaryView of this execution session

markStartExecution

void markStartExecution()

Marks execution starting point of overall session

updateStatus

void updateStatus(String taskId,
                  long timestamp,
                  Status status)

Sets the latest status of a task, and updates the status report

Parameters:

taskId - ID of the task whose status is to be set

timestamp - status update timestamp

status - current status of task

updateStatus

void updateStatus(String taskId,
                  long timestamp,
                  Status status,
                  String extraInfo)

Sets the latest status of a task, and updates the status report

Parameters:

taskId - ID of the task whose status is to be set

timestamp - status update timestamp

status - current status of the task

extraInfo - additional details regarding task (e.g. reason for failure)