com.aspc.remote.task

Class TaskManager

java.lang.Object

com.aspc.remote.task.TaskManager

Direct Known Subclasses:

SyncManager

public class TaskManager
extends java.lang.Object

TaskManager will manage a session for a Task, by using the TASK commands START, NEXT and BEAT.
THREAD MODE: MULTI-THREADED

Since:

28 September 2005

Author:

luke

Field Summary

Fields

Modifier and Type	Field and Description
protected ExecutorPool	pool Executor object pool for this task
protected java.lang.String	task The Task Code for this task
protected java.lang.Long	trans_ms
protected java.lang.String	transid The current Transaction ID for this task

Constructor Summary

Constructors

Constructor and Description
TaskManager(java.lang.String taskCode, PoolableObjectFactory factory) Creates a new TaskManager for the given task code, using the factory to create an ExecutorPool

Method Summary

Modifier and Type	Method and Description
boolean	alive() Returns true if this task manager is currently live
java.lang.String	getParameters() get the parameters
static boolean	incrementalBeat() do a incremental beat on the current task manager.
boolean	taskBeat() Calls TASK BEAT using the session id and the transaction id from TASK NEXT
void	taskEnd() Calls TASK END for this session, end the session and allow another session to start
boolean	taskError(java.lang.String msg) Calls TASK ERROR using the session id and the transaction id from TASK NEXT
boolean	taskNext() Calls TASK NEXT using the session from taskStart for this task.
java.lang.String	taskSession() Calls TASK SESSION using the session id and the transaction id from TASK NEXT
boolean	taskStart() Calls TASK START for the task given in the constructor, stores the resulting session and mode for use in TASK NEXT and TASK BEAT

Methods inherited from class java.lang.Object

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

Field Detail

task

protected java.lang.String task

The Task Code for this task

pool

protected ExecutorPool pool

Executor object pool for this task

transid

protected java.lang.String transid

The current Transaction ID for this task

trans_ms

protected java.lang.Long trans_ms

Constructor Detail

TaskManager

public TaskManager(java.lang.String taskCode,
                   PoolableObjectFactory factory)

Creates a new TaskManager for the given task code, using the factory to create an ExecutorPool

Parameters:

taskCode - the task code for the app

factory - an Executor object factory for the pool

Method Detail

taskStart

public boolean taskStart()
                  throws java.lang.Exception

Calls TASK START for the task given in the constructor, stores the resulting session and mode for use in TASK NEXT and TASK BEAT

Returns:

boolean true if we got a session number and mode is live

Throws:

java.lang.Exception - a serious problem

taskNext

public boolean taskNext()
                 throws java.lang.Exception

Calls TASK NEXT using the session from taskStart for this task.

Returns:

boolean true if we get a transaction id and mode is live

Throws:

java.lang.Exception - a serious problem

incrementalBeat

public static boolean incrementalBeat()

do a incremental beat on the current task manager.

Returns:

true if we are still alive.

taskBeat

public boolean taskBeat()

Calls TASK BEAT using the session id and the transaction id from TASK NEXT

Returns:

boolean true if mode is live

taskSession

public java.lang.String taskSession()

Calls TASK SESSION using the session id and the transaction id from TASK NEXT

Returns:

String session if mode is live

taskEnd

public void taskEnd()
             throws java.lang.Exception

Calls TASK END for this session, end the session and allow another session to start

Throws:

java.lang.Exception - a serious problem

alive

public boolean alive()

Returns true if this task manager is currently live

Returns:

boolean true if the task manager is alive

taskError

public boolean taskError(java.lang.String msg)
                  throws java.lang.Exception

Calls TASK ERROR using the session id and the transaction id from TASK NEXT

Parameters:

msg - the message

Returns:

boolean true if mode is live

Throws:

java.lang.Exception - a serious problem

getParameters

@CheckReturnValue
 @Nonnull
public java.lang.String getParameters()

get the parameters

Returns:

the parameters