co.ecg.alpaca.toolkit.shell.task

Class Task

java.lang.Object

co.ecg.alpaca.toolkit.shell.task.Task

public class Task
extends Object

An Alpaca CLI Task. The task is a running Future that monitors it's work via log appenders specific for the BroadWorksServer sessions in the taskServers list. Tasks also receive TaskEvents that are sent on the BroadWorksServers within the taskServers list. There is also support for a final task result message that can easily tell the user if the task was successful.

Author:

Matthew Keathley on 9/30/16.

Constructor Summary

Constructors

Constructor and Description
Task(String name, co.ecg.alpaca.toolkit.model.BroadWorksServer... broadWorksServers) Creates a new Task with the provided name and backing BroadWorksServer list.

Method Summary

Modifier and Type	Method and Description
protected void	close() Closes the log appenders and unregisters this from the BroadWorksServer event buses.
void	finish(String resultMessage) Finishes the task with the provided result message.
String	getName()
TaskResult	getResult()
TaskStatus	getStatus()
List<String>	getTaskLog()
protected List<co.ecg.alpaca.toolkit.model.BroadWorksServer>	getTaskServers()
boolean	isComplete() Returns if the task thread has ran and completed.
void	logToConsole(Alpaca alpaca) Sends the Task events to the provided Alpaca console.
protected void	postLogMessage(String logMessage) Adds a log message for this task.
void	setTask(Callable<Object> task) Sets the Callable to be performed by this task.
protected Future	start(ThreadPoolExecutor executorService) Begins the task with the provided ExecutorService
void	taskEvent(TaskEvent event)

Methods inherited from class java.lang.Object

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

Constructor Detail

Task

public Task(String name,
            co.ecg.alpaca.toolkit.model.BroadWorksServer... broadWorksServers)

Creates a new Task with the provided name and backing BroadWorksServer list.

Parameters:

name - The name of the task. This identifies the process to the user and should be unique.

broadWorksServers - The varargs of backing BroadWorksServers for the task.

Method Detail

start

protected Future start(ThreadPoolExecutor executorService)

Begins the task with the provided ExecutorService

Parameters:

executorService - The thread pool to run the Task upon.

Returns:

Returns the future for the task.

close

protected void close()

Closes the log appenders and unregisters this from the BroadWorksServer event buses. It also closes the underlying BroadWorksServer objects to clean up the socket and TimesTen connections.

logToConsole

public void logToConsole(Alpaca alpaca)

Sends the Task events to the provided Alpaca console.

Parameters:

alpaca - The alpaca console to log to.

isComplete

public boolean isComplete()

Returns if the task thread has ran and completed.

Returns:

Returns true IFF the future is not null and is done.

getStatus

public TaskStatus getStatus()

setTask

public void setTask(Callable<Object> task)

Sets the Callable to be performed by this task.

Parameters:

task - The Callable

getName

public String getName()

finish

public void finish(String resultMessage)

Finishes the task with the provided result message.

Parameters:

resultMessage - The result message.

getResult

public TaskResult getResult()

getTaskServers

protected List<co.ecg.alpaca.toolkit.model.BroadWorksServer> getTaskServers()

getTaskLog

public List<String> getTaskLog()

postLogMessage

protected void postLogMessage(String logMessage)

Adds a log message for this task. This is intended to be used by the TaskAppender.

Parameters:

logMessage - The log message to add.

taskEvent

public void taskEvent(TaskEvent event)