com.aspc.task

Class TaskCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.task.TaskCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class TaskCommand
extends SQLCommand

Maintains and list the status of tasks
Syntax

  TASK [SESSION session_id ]
       [BEAT code [, trans_id][LOCK lock_id]] |
       [LIST [UPDATE_NOTIFY] [MONITOR_LEVEL monitor_level] [MONITORS monitors] [EXCLUDE exclude] ] |
       [NEXT code [LOCK lock_id]] |
       [START code [KEY start_key] [GROUP trans_group]] |
       [END code] |
       [ERROR code, error_tx[,trans_id]] |
       [UNLOCK code[,lock_id]] |
       [DETAIL code[,lock_id]]
  

Usage

  /* updates the last tick time */
  TASK BEAT alert_mgr
  
  /* List the status of the enabled Tasks */
  TASK LIST 
  
  /* Sets the task 'backup' to error. */
  TASK ERROR backup, "disk full"
  
  /* get the next transaction for this system code */
  TASK NEXT
  
  /* 
   * starts a task and creates a session id
   * this command is useful for HA applications
   */
  TASK START abc
  
  /* To close a session and allow another HA to start */
  TASK SESSION 123 END abc
  
  /* To start a task with a locked transaction group */
  TASK START export KEY renewals GROUP 123 
  
  /* 
   * for non-ha tasks, no session is used, task start and task end 
   * are not used either
   */
  TASK NEXT code
  TASK BEAT code, trans_id
  TASK LIST code
  TASK ERROR code, error_tx, trans_id
  
  /*
   * non-ha tasks can also lock a transaction, which is held until
   * UNLOCKed or BEAT regardless of heartbeat duration
   */
  TASK NEXT code LOCK lock_id
  TASK BEAT code, trans_id
  TASK DETAIL code, lock_id
  TASK UNLOCK code, lock_id
  
  List tasks with monitor level match.
  TASK LIST MONITOR_LEVEL monitor_level
 
  Provides details of requested monitors only.
  TASK LIST MONITORS monitors
 
  Monitors to exclude from the list.
  TASK LIST EXCLUDE exclude
  

THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields inherited from class com.aspc.commander.sql.SQLCommand

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
TaskCommand(Connection connection, Pattern pattern) constructor for TASK command

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) execute the command
java.lang.String	getColumnName(int col) Not mandatory to supply a key for the row as well.
java.lang.String	getColumnType(int col) get the column type
java.lang.String	getRecordID(int row) We are at the last row when we return null for the record ID.
java.lang.Object	getValue(int row, int col) The value for this column/row

Methods inherited from class com.aspc.commander.sql.SQLCommand

appendResult, appendResult, getCursorName, getRecordKey, isExecuteOnly

Methods inherited from class com.aspc.commander.Command

execute, extMakeThreadName, getConnection, getPattern, getRawTitle, getTitle, makeThreadName, recordCall, setTitle

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aspc.commander.sql.results.CommandBuildResultsPlugin

getRawTitle

Constructor Detail

TaskCommand

public TaskCommand(Connection connection,
                   Pattern pattern)

constructor for TASK command

Parameters:

connection - - connection object

pattern - - Pattern object

Method Detail

execute

protected void execute(Parser p)
                throws java.lang.Exception

execute the command

Specified by:

execute in class Command

Parameters:

p - PArser object

Throws:

java.lang.Exception - A serious problem.

getColumnName

public java.lang.String getColumnName(int col)

Description copied from interface: CommandBuildResultsPlugin

Not mandatory to supply a key for the row as well. If not the ID will be used.

Parameters:

col - column number you are asking

Returns:

name of the column

getColumnType

public java.lang.String getColumnType(int col)
                               throws java.lang.Exception

Description copied from interface: CommandBuildResultsPlugin

get the column type

Parameters:

col - column number

Returns:

type of the column

Throws:

java.lang.Exception - A serious problem.

getRecordID

public java.lang.String getRecordID(int row)

Description copied from interface: CommandBuildResultsPlugin

We are at the last row when we return null for the record ID. All rows must have a unique ID. Nothing else is assumed about a record ID other than it is unique and will return the same value at a later time.

Parameters:

row - number

Returns:

record id for the row

getValue

public java.lang.Object getValue(int row,
                                 int col)
                          throws java.lang.Exception

Description copied from interface: CommandBuildResultsPlugin

The value for this column/row

Parameters:

row - row id whose value is required

col - col id whose value is required

Returns:

value at row and col

Throws:

java.lang.Exception - A serious problem.