Class Command

Object
   |
   +--Command

Direct Known Subclasses:

HelloAction, LoginAction, SecretAction

class Command

This is Command class the base class for all user defined commands.
Defined in Command.js

Constructor Detail

Command

Command(<Config> config)

Constructs a new instance of Command class.

Parameters:
config - The instance of Config class.

execute

ResponseContext execute(<Environment> environment, <RequestContext> requestCxt)

Performs business logic and returns responseContext

Parameters:
environment - The instance of Environment class.
requestCxt - The instance of RequestContext class.

Returns:
The instance of ResponseContext or undefined if this methis handles the output itself.

findForward

Forward findForward(<RequestContext> requestCxt, <String> forwardName)

Searches Command mappings from config.xml for Forward object and returns it if found. It throws errors if the Forward object could not be located.

For example we can this Command definition in config.xml:

         <cmd-map action="secretAction">
             <name>secretForm</name>
             <type>SecretAction</type>
             <forwards>
                 <forward name="success" redirect="false"
                          path="/views/secret.xsl"/>
             </forwards>
         </cmd-map>
 

In execute() method of the Command object we would call:

 var forward = this.findForward(secretForm, "success");

 //change the forward fields
 forward.redirect = true;
 forward.path = "/views/secret2.xsl";

 

Parameters:
requestCxt - The RequestContext instance.
forwardName - The name of the Forward declaration.

Returns:
The instance of Forward. A Forward object is indirect handle to view.

getConnectionString

String getConnectionString(<String> dbName)

Looks up database connection string from Config class and return it.

In our config.xml:

 <db-connection name="helloworld-db"
                        conn-string="Driver={Microsoft Access Driver (*.mdb)};Dbq=${root}/WEB-INF/data/helloworld.mdb;"/>
 

 var connStr = this.getConnectionString("helloworld-db");

 

Parameters:
dbName - The name of the database to lookup.

init

Command init(<Config> config)

Initializes Command.

Parameters:
config - The XSL template file to transform.

Returns:
Command object instance itself.

logError

void logError(<Object> error)

Logs error message to application log file. The error parameter will be queried and broken into name/value pairs before being written into the log file.

Log file configuration is specified in config.xml:

    <logger>
         <file-name>${root}/WEB-INF/logs/application.log</file-name>
         <max-size>1024</max-size>
         <generations>2</generations>
         <log-level>FILTER_INFO</log-level>
     </logger>
 

 The code like this:

     this.logError("Error1");
     this.logError(secretForm);


 Will produce the output in application.log as follows:

 [2007/03/23 10:15:27] {E} TRAN ID - 1174644927701-1 {E} Error1
 [2007/03/23 10:15:27] {E} TRAN ID - 1174644927701-2 {E} action=secretAction |
 

Parameters:
error - The error object.

logInfo

void logInfo(<String> msg)

Logs info message to application log file.

Log file configuration is specified in config.xml:

    <logger>
         <file-name>${root}/WEB-INF/logs/application.log</file-name>
         <max-size>1024</max-size>
         <generations>2</generations>
         <log-level>FILTER_INFO</log-level>
     </logger>
 

 The code like this:

     //create an object dynamically
     var obj2 = {};
     obj2.prop1 = 100;
     obj2.prop2 = "value2";

     this.logInfo(obj2);
     this.logInfo(obj2.toXML());

 Will produce the output in application.log as follows:

 [2007/03/23 10:15:27] {I} TRAN ID - 1174644927701-4 {I} {"prop1":100,"prop2":"value2"}
 [2007/03/23 10:15:27] {I} TRAN ID - 1174644927701-5 {I} 
 

Parameters:
msg - The info message.

logWarn

void logWarn(<String> msg)

Logs warning message to application log file.

Log file configuration is specified in config.xml:

    <logger>
         <file-name>${root}/WEB-INF/logs/application.log</file-name>
         <max-size>1024</max-size>
         <generations>2</generations>
         <log-level>FILTER_INFO</log-level>
     </logger>
 

 The code like this:

     this.logWarn("Warning1");

 [2007/03/23 10:15:27] {W} TRAN ID - 1174644927701-3 {W} Warning1
 

Parameters:
msg - The warning message.