com.aspc.droid

Class DroidCommand

java.lang.Object

com.aspc.commander.Command

com.aspc.commander.sql.SQLCommand

com.aspc.droid.DroidCommand

All Implemented Interfaces:

CommandBuildResultsPlugin

public class DroidCommand
extends SQLCommand

Allows a remote application to bid for and process a JOB that the server is not capable of processing.

The Application server typically runs on a Unix/Linux machine, these machines can not generate Word/Excel documents or render Web pages.

A series of "Droid" client machines can ask the Unix/Linux application server if there are any requests to generate Word/Excel/Pages in the queue. if there is a request then the client machine is handed the task for completion. Once the document is generated it is transmitted back up to the web server and the user that requested the document down loads the newly generated document as if it was generated on the Unix/Linux server.
Syntax

  DROID [BID queues [TYPE command_name[, ...]] [BLOCK msecs]]    |
        [REGISTER register_name [ATTRIBUTE attributes]]          |
        [ERROR job_id, message_tx [STOP]]                        |
        [PROGRESS job_id, message_tx]                            |
        [COMPLETE job_id, result_xml [WARNING warning_tx]]       |
        [LOG log_level, message_tx]                              |
        [STATUS status_tx]
  

Usage

  /* BID for a JOB */
  DROID BID excel TYPE EXCEL_PDF
  
  /* Record progress on a JOB */
  DROID PROGRESS 140002031, '5% complete'
  
  /* finish processing the job with an error condition */
  DROID ERROR 14000922, 'Could not contact file server'
  
  /* complete a job and send back the results */
  DROID COMPLETE 14000283, '<DATA>3.142</DATA>'
  
  /* make a log entry for this DROID */
  DROID LOG 'WARN','Could not load PDF Distiller'; 
  
  /* Register a DROID */
  DROID REGISTER droid12
  
  /* 
   * Record the status of a DROID
   */
  DROID STATUS "could not kill excel";
  

THREAD MODE: SINGLE THREADED command

Since:

3 December 2003

Author:

Nigel Leck

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	TYPE_BID bid for a job
static java.lang.String	TYPE_COMPLETE complete a job
static java.lang.String	TYPE_ERROR mark a job in error.
static java.lang.String	TYPE_LOG Log a message
static java.lang.String	TYPE_PROGRESS update the progress
static java.lang.String	TYPE_REGISTER Register a DROID
static java.lang.String	TYPE_STATUS status of a DROID
static java.lang.String	VARIABLE_COMMAND_NAME the type code
static java.lang.String	VARIABLE_JOB_ID The ASCII version of the JOB id
static java.lang.String	VARIABLE_QUEUES the queue code

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

CURSOR_SIZE

Constructor Summary

Constructors

Constructor and Description
DroidCommand(Connection connection, Pattern pattern) constructor for the job command

Method Summary

Modifier and Type	Method and Description
protected void	execute(Parser p) Execute the DROID command.
java.lang.String	getColumnName(int col) The column name
java.lang.String	getColumnType(int col) The column type
java.lang.String	getRecordID(int row) The record ID for this row
java.lang.Object	getValue(int row, int col) The value for this row/col

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

Field Detail

TYPE_BID

public static final java.lang.String TYPE_BID

bid for a job

See Also:

Constant Field Values

TYPE_COMPLETE

public static final java.lang.String TYPE_COMPLETE

complete a job

See Also:

Constant Field Values

TYPE_ERROR

public static final java.lang.String TYPE_ERROR

mark a job in error.

See Also:

Constant Field Values

TYPE_PROGRESS

public static final java.lang.String TYPE_PROGRESS

update the progress

See Also:

Constant Field Values

TYPE_LOG

public static final java.lang.String TYPE_LOG

Log a message

See Also:

Constant Field Values

TYPE_REGISTER

public static final java.lang.String TYPE_REGISTER

Register a DROID

See Also:

Constant Field Values

TYPE_STATUS

public static final java.lang.String TYPE_STATUS

status of a DROID

See Also:

Constant Field Values

VARIABLE_JOB_ID

public static final java.lang.String VARIABLE_JOB_ID

The ASCII version of the JOB id

See Also:

Constant Field Values

VARIABLE_QUEUES

public static final java.lang.String VARIABLE_QUEUES

the queue code

See Also:

Constant Field Values

VARIABLE_COMMAND_NAME

public static final java.lang.String VARIABLE_COMMAND_NAME

the type code

See Also:

Constant Field Values

Constructor Detail

DroidCommand

public DroidCommand(Connection connection,
                    Pattern pattern)

constructor for the job command

Parameters:

connection - The current connection

pattern - the command pattern

Method Detail

execute

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

Execute the DROID command.

Specified by:

execute in class Command

Parameters:

p - the parameters

Throws:

java.lang.Exception - a serious problem

getColumnName

public java.lang.String getColumnName(int col)

The column name

Parameters:

col - offset from 1

Returns:

The name

getColumnType

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

The column type

Parameters:

col - offset from 1

Returns:

The column type

Throws:

java.lang.Exception - a serious problem

getRecordID

public java.lang.String getRecordID(int row)

The record ID for this row

Parameters:

row - offset from 1

Returns:

The record ID

getValue

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

The value for this row/col

Parameters:

row - offset from 1

col - offset from 1

Returns:

The value

Throws:

java.lang.Exception - a serious problem