ProcessRequest (SAFS API DOCUMENT)

java.lang.Object
- org.safs.ProcessRequest

```
public class ProcessRequest
extends java.lang.Object
```
Purpose: ProcessRequest does a request when intantiated with a TestRecordData; it acts like a factory which first grabs the request (recordType), then routes it by instantiating the appropriate processor
Lifetime: instantiated by a hook script or some kind of controller. Does not stay around for long as it only processes one request

Since:

JUN 03, 2003
JUN 03, 2003 (DBauman) Original Release
SEP 16, 2003 (Carl Nagle) Implemented use of new SAFSLOGS logging.
NOV 10, 2003 (Carl Nagle) Allowing for alternate processors.
JUL 10, 2007 (Carl Nagle) Added engine command processor support.

Author:

Doug Bauman

Field Summary

Fields
Modifier and Type	Field and Description
`protected static int`	`DEBUG_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected static int`	`FAILED_MESSAGE` Log MessageType for local referencing.
`protected static int`	`FAILED_OK_MESSAGE` Log MessageType for local referencing.
`protected static int`	`GENERIC_MESSAGE` Convenience for local referencing instead of referencing AbstractLogFacility.
`protected boolean`	`initialized` true if initializeProcessor has been called at least once.
`protected LogUtilities`	`log` LogUtilities to be used by this processor.
`protected static int`	`PASSED_MESSAGE` Log MessageType for local referencing.
`protected boolean`	`requesterReady` true if we have non-null objects where required
`protected TestRecordHelper`	`testRecordData` TestRecordData Helper subclass to be used by this processor.
`protected static int`	`WARNING_MESSAGE` Log MessageType for local referencing.
`protected static int`	`WARNING_OK_MESSAGE` Log MessageType for local referencing.

Constructor Summary

Constructors
Constructor and Description
`ProcessRequest()` Noop constructor.
`ProcessRequest(TestRecordHelper testRecordData, LogUtilities log)` Standard constructor allowing for default Driver Command and Test Step Processors.
`ProcessRequest(TestRecordHelper testRecordData, LogUtilities log, Processor altDriverCommandsProcessor, Processor altTestStepProcessor, Processor altCustomDriverCommandsProcessor, Processor altCustomTestStepProcessor)` Advanced constructor allowing for Driver Command and Test Step Processors different from the those provided by default.
`ProcessRequest(TestRecordHelper testRecordData, LogUtilities log, Processor altEngineCommandsProcessor, Processor altDriverCommandsProcessor, Processor altTestStepProcessor, Processor altCustomEngineCommandsProcessor, Processor altCustomDriverCommandsProcessor, Processor altCustomTestStepProcessor)` Advanced constructor allowing for Engine, Driver, and Test Processors different from the those provided by default.
`ProcessRequest(TestRecordHelper testRecordData, LogUtilities log, java.util.Vector processorList)` Advanced constructor allowing for an alternate list of processors.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addProcessor(Processor aprocessor)` Add a processor that is used instead of, or in addition to, the normal core and custom processors.
`void`	`doRequest()` Process a dispatch event for handling an input record from a hook/driver.
`Processor`	`getCustomDriverCommandProcessor()`
`Processor`	`getCustomEngineCommandProcessor()`
`Processor`	`getCustomTestStepProcessor()`
`Processor`	`getDriverCommandProcessor()`
`Processor`	`getEngineCommandProcessor()`
`LogUtilities`	`getLogUtilities()`
`TestRecordHelper`	`getTestRecordData()`
`Processor`	`getTestStepProcessor()`
`protected void`	`initializeProcessor(Processor aprocessor)` Make sure the processor has a valid log.
`void`	`initializeRequester()` Force all necessary cross-initialization to occur prior to first use.
`void`	`setCustomDriverCommandProcessor(Processor aprocessor)`
`void`	`setCustomEngineCommandProcessor(Processor aprocessor)`
`void`	`setCustomTestStepProcessor(Processor aprocessor)`
`void`	`setDriverCommandProcessor(Processor aprocessor)`
`void`	`setEngineCommandProcessor(Processor aprocessor)`
`void`	`setLogUtilities(LogUtilities log)`
`void`	`setProcessorList(java.util.Vector processorList)` Set (or clear) any list of processors.
`void`	`setTestRecordData(TestRecordHelper testRecordData)`
`void`	`setTestStepProcessor(Processor aprocessor)`
`protected void`	`tryProcessor(Processor aprocessor)` Attempt execution of the current testRecordData.inputRecord.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DEBUG_MESSAGE
```
protected static final int DEBUG_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - GENERIC_MESSAGE
```
protected static final int GENERIC_MESSAGE
```
    Convenience for local referencing instead of referencing AbstractLogFacility.
    
    See Also:
    
    Constant Field Values
  - FAILED_MESSAGE
```
protected static final int FAILED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - FAILED_OK_MESSAGE
```
protected static final int FAILED_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - PASSED_MESSAGE
```
protected static final int PASSED_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_MESSAGE
```
protected static final int WARNING_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - WARNING_OK_MESSAGE
```
protected static final int WARNING_OK_MESSAGE
```
    Log MessageType for local referencing. Inherits AbstractLogFacility value.
    
    See Also:
    
    Constant Field Values
  - testRecordData
```
protected TestRecordHelper testRecordData
```
    TestRecordData Helper subclass to be used by this processor. This is generally provided via a class constructor.
  - log
```
protected LogUtilities log
```
    LogUtilities to be used by this processor. This is usually provide via the constructor.
  - requesterReady
```
protected boolean requesterReady
```
    true if we have non-null objects where required
  - initialized
```
protected boolean initialized
```
    true if initializeProcessor has been called at least once.
- Constructor Detail
  - ProcessRequest
```
public ProcessRequest()
```
    Noop constructor. Processor initialization must be completed by subsequent method calls.
  - ProcessRequest
```
public ProcessRequest(TestRecordHelper testRecordData,
                      LogUtilities log)
```
    Standard constructor allowing for default Driver Command and Test Step Processors. Processor initialization must be completed by subsequent method calls if different processors are to be used.
  - ProcessRequest
```
public ProcessRequest(TestRecordHelper testRecordData,
                      LogUtilities log,
                      Processor altDriverCommandsProcessor,
                      Processor altTestStepProcessor,
                      Processor altCustomDriverCommandsProcessor,
                      Processor altCustomTestStepProcessor)
```
    Advanced constructor allowing for Driver Command and Test Step Processors different from the those provided by default.
    Note: null values can be used for any of the Processors to effectively disable the handling of that type of test record. For example, a null value passed in for 'altTestStepProcessor' effectively disables the processing of 'standard' Test Step Records. Other non-null Processors will still be called, however.
  - ProcessRequest
```
public ProcessRequest(TestRecordHelper testRecordData,
                      LogUtilities log,
                      Processor altEngineCommandsProcessor,
                      Processor altDriverCommandsProcessor,
                      Processor altTestStepProcessor,
                      Processor altCustomEngineCommandsProcessor,
                      Processor altCustomDriverCommandsProcessor,
                      Processor altCustomTestStepProcessor)
```
    Advanced constructor allowing for Engine, Driver, and Test Processors different from the those provided by default.
    Note: null values can be used for any of the Processors to effectively disable the handling of that type of test record. For example, a null value passed in for 'altTestStepProcessor' effectively disables the processing of 'standard' Test Step Records. Other non-null Processors will still be called, however.
  - ProcessRequest
```
public ProcessRequest(TestRecordHelper testRecordData,
                      LogUtilities log,
                      java.util.Vector processorList)
```
    Advanced constructor allowing for an alternate list of processors.
    Note: null values will be set for standard processors to effectively disable their handling. Only those Processors in the provided processorList will be used.
    processorList is a Vector list of Processors. It is the user's responsibility to ensure any non-null Vector contains elements that are valid subclasses of org.safs.Processor. As always, additional processors can be added to the list with the addProcessor method.
- Method Detail
  - getEngineCommandProcessor
```
public Processor getEngineCommandProcessor()
```
  - setEngineCommandProcessor
```
public void setEngineCommandProcessor(Processor aprocessor)
```
  - getTestStepProcessor
```
public Processor getTestStepProcessor()
```
  - setTestStepProcessor
```
public void setTestStepProcessor(Processor aprocessor)
```
  - getDriverCommandProcessor
```
public Processor getDriverCommandProcessor()
```
  - setDriverCommandProcessor
```
public void setDriverCommandProcessor(Processor aprocessor)
```
  - getCustomEngineCommandProcessor
```
public Processor getCustomEngineCommandProcessor()
```
  - setCustomEngineCommandProcessor
```
public void setCustomEngineCommandProcessor(Processor aprocessor)
```
  - getCustomTestStepProcessor
```
public Processor getCustomTestStepProcessor()
```
  - setCustomTestStepProcessor
```
public void setCustomTestStepProcessor(Processor aprocessor)
```
  - getCustomDriverCommandProcessor
```
public Processor getCustomDriverCommandProcessor()
```
  - setCustomDriverCommandProcessor
```
public void setCustomDriverCommandProcessor(Processor aprocessor)
```
  - getTestRecordData
```
public TestRecordHelper getTestRecordData()
```
  - setTestRecordData
```
public void setTestRecordData(TestRecordHelper testRecordData)
```
  - getLogUtilities
```
public LogUtilities getLogUtilities()
```
  - setLogUtilities
```
public void setLogUtilities(LogUtilities log)
```
  - addProcessor
```
public void addProcessor(Processor aprocessor)
```
    Add a processor that is used instead of, or in addition to, the normal core and custom processors.
  - setProcessorList
```
public void setProcessorList(java.util.Vector processorList)
```
    Set (or clear) any list of processors.
    processorList is a Vector list of Processors. It is the user's responsibility to ensure any non-null Vector contains elements that are valid subclasses of org.safs.Processor. As always, additional processors can be added to the list with the addProcessor method.
  - initializeProcessor
```
protected void initializeProcessor(Processor aprocessor)
```
    Make sure the processor has a valid log. If it does not, set the processor to use our log. (Hopefully our log is not also null!)
    
    Parameters:
    
    aprocessor - -- Processor to initialize
  - initializeRequester
```
public void initializeRequester()
```
    Force all necessary cross-initialization to occur prior to first use. This can be invoked once all required assets have been 'set' from the constructor, or after all subsequent 'set' commands. Primarily, this makes sure all 'set' processors and other items are initialized to a valid log, etc..
    This method will be called at the first execution of doRequest if it has not already been called.
    
    See Also:
    
    initializeProcessor
  - doRequest
```
public void doRequest()
```
    Process a dispatch event for handling an input record from a hook/driver. All object instance preparation ('setX') must be complete prior to a call to this routine. This routine will force a one-time, final initialization of all object assets prior to processing the first test record. That generally means that all non-standard 'setX' calls and preparations must be complete prior test execution by the owning hook/driver. Of course, some hook/driver objects will handle this preparation automatically.
    .doRequest first grabs the request (recordType), then routes it. What we are processing here is a input record which comes from test tables in the form of Driver Commands, Test Steps, or other input record typs.
    Sample Test Table Input Records
    ==============================
    
    C , Expressions, ON
    T , Login , Password , SetTextValue , ^password
    T , Login , Submit , Click
    T , Error , Message , VerifyProperty , ^prop="Text", ^val="Invalid UserID or Password!"
    T , Error , OK , Click
  - tryProcessor
```
protected void tryProcessor(Processor aprocessor)
```
    Attempt execution of the current testRecordData.inputRecord. This method is normally called by .doRequest() and is not normally called directly.
    The method expects the testRecordData to be filled in as much as is normal when routing by record type. Thus, the getRecordType() method of testRecordData is expected to return the current record type to be executed.
    
    Parameters:
    
    aprocessor - -- the Processor to attempt execution of the current record.

Class ProcessRequest

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEBUG_MESSAGE

GENERIC_MESSAGE

FAILED_MESSAGE

FAILED_OK_MESSAGE

PASSED_MESSAGE

WARNING_MESSAGE

WARNING_OK_MESSAGE

testRecordData

log

requesterReady

initialized

Constructor Detail

ProcessRequest

ProcessRequest

ProcessRequest

ProcessRequest

ProcessRequest

Method Detail

getEngineCommandProcessor

setEngineCommandProcessor

getTestStepProcessor

setTestStepProcessor

getDriverCommandProcessor

setDriverCommandProcessor

getCustomEngineCommandProcessor

setCustomEngineCommandProcessor

getCustomTestStepProcessor

setCustomTestStepProcessor

getCustomDriverCommandProcessor

setCustomDriverCommandProcessor

getTestRecordData

setTestRecordData

getLogUtilities

setLogUtilities

addProcessor

setProcessorList

initializeProcessor

initializeRequester

doRequest

tryProcessor