com.ibm.commerce.usermanagement.commands
Class ProcessRequestPropertiesCmdImpl

java.lang.Object
  |
  +--CacheableCommandImpl
        |
        +--com.ibm.commerce.command.AbstractECTargetableCommand
              |
              +--com.ibm.commerce.command.TaskCommandImpl
                    |
                    +--com.ibm.commerce.usermanagement.commands.ProcessRequestPropertiesCmdImpl
All Implemented Interfaces:
ECCommand, ECTargetableCommand, ProcessRequestPropertiesCmd, TaskCommand

public class ProcessRequestPropertiesCmdImpl
extends TaskCommandImpl
implements ProcessRequestPropertiesCmd

This task command is used to process request properties for URL commands.

If the request properties contain 'XML' parameter, it assumes that the URL command is called in tools framework; otherwise it assumes the URL command is directly called from URL. If called from tools framework, the command will process the request properties to convert the xml file to name-value pair stored in TypedProperty. The task command also generates a response properties, set 'viewTaskName' property to 'RedirectView'. If called from tools framework, it also put 'XMLFile' and 'redirectURL' properties. Inputs of this task command are:

 setRequestProperties(TypedProperty)
 - sets request properties need to be processed.
 setCheckURL(boolean)
 - sets the indicator which determines if the task command needs to check the 'URL' parameter is not null and its length large than 0.
   default is true.

<dl>
<dt>See Also:<dd>Serialized Form</dl>
<hr>


<table> <tr> <td>Field Summary</td> </tr> <tr> <td>protected boolean</td> <td>bCheckURL
Whether to check that the URL was specified.</td> </tr> <tr> <td>protected boolean</td> <td>bToolsFramework
Whether this request came from the tools framework.</td> </tr> <tr> <td>static java.lang.String</td> <td>CLASSNAME
The name of this implementation of the command.</td> </tr> <tr> <td>static java.lang.String</td> <td>COPYRIGHT
IBM Copyright notice field.</td> </tr> <tr> <td>protected java.lang.String</td> <td>istrXMLFile
The XML if the request was a tools framework request.</td> </tr> <tr> <td>protected TypedProperty</td> <td>requestProperties
The request properties.</td> </tr> <tr> <td>protected TypedProperty</td> <td>responseProperties
The response properties.</td> </tr> </table> <table> <tr> <td>Fields inherited from class com.ibm.commerce.command.AbstractECTargetableCommand</td> </tr> <tr> <td>commandContext</td> </tr> </table> <table> <tr> <td>Fields inherited from interface com.ibm.commerce.usermanagement.commands.ProcessRequestPropertiesCmd</td> </tr> <tr> <td>defaultCommandClassName, NAME</td> </tr> </table> <table> <tr> <td>Fields inherited from interface com.ibm.commerce.command.ECCommand</td> </tr> <tr> <td>defaultCommandClassName</td> </tr> </table> <table> <tr> <td>Constructor Summary</td> </tr> <tr> <td>ProcessRequestPropertiesCmdImpl()
</td> </tr> </table> <table> <tr> <td>Method Summary</td> </tr> <tr> <td>boolean</td> <td>getCheckURL()
Returns whether a check for the URL parameter is needed.</td> </tr> <tr> <td>TypedProperty</td> <td>getRequestProperties()
Returns the request properties.</td> </tr> <tr> <td>TypedProperty</td> <td>getResponseProperties()
Returns the response properties.</td> </tr> <tr> <td>java.lang.String</td> <td>getXMLFile()
Returns the XML request.</td> </tr> <tr> <td>boolean</td> <td>isToolsFramework()
Whether the command is a tools framework command.</td> </tr> <tr> <td>void</td> <td>performExecute()
Extract the request properties.</td> </tr> <tr> <td>void</td> <td>removeToolsFrameworkProperties(TypedProperty aProperties)
Removes the tools framework objects from the request properties.</td> </tr> <tr> <td>void</td> <td>setCheckURL(boolean abCheckURL)
Sets whether to check for the URL parameter.</td> </tr> <tr> <td>void</td> <td>setRequestProperties(TypedProperty aRequestProperties)
Sets the request properties.</td> </tr> </table> <table> <tr> <td>Methods inherited from class com.ibm.commerce.command.AbstractECTargetableCommand</td> </tr> <tr> <td>accessControlCheck, checkIsAllowed, checkParameters, checkResourcePermission, createCommandExecutionEvent, execute, finalize, getAccCheck, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, isReadyToCallExecute, reset, setAccCheck, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters</td> </tr> </table> <table> <tr> <td>Methods inherited from class java.lang.Object</td> </tr> <tr> <td>clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</td> </tr> </table>
<table> <tr> <td>Field Detail</td> </tr> </table> <h3> COPYRIGHT</h3> <pre> public static final java.lang.String COPYRIGHT
IBM Copyright notice field.
See Also:
Constant Field Values

CLASSNAME

public static final java.lang.String CLASSNAME
The name of this implementation of the command.
See Also:
Constant Field Values

requestProperties

protected TypedProperty requestProperties
The request properties.

responseProperties

protected TypedProperty responseProperties
The response properties.

bToolsFramework

protected boolean bToolsFramework
Whether this request came from the tools framework.

istrXMLFile

protected java.lang.String istrXMLFile
The XML if the request was a tools framework request.

bCheckURL

protected boolean bCheckURL
Whether to check that the URL was specified.
Constructor Detail

ProcessRequestPropertiesCmdImpl

public ProcessRequestPropertiesCmdImpl()
Method Detail

getCheckURL

public boolean getCheckURL()
Returns whether a check for the URL parameter is needed.
Specified by:
getCheckURL in interface ProcessRequestPropertiesCmd
Returns:
Whether to check for the URL parameter.

getRequestProperties

public TypedProperty getRequestProperties()
Returns the request properties.
Specified by:
getRequestProperties in interface ProcessRequestPropertiesCmd
Returns:
The request properties.

getResponseProperties

public TypedProperty getResponseProperties()
Returns the response properties.
Specified by:
getResponseProperties in interface ProcessRequestPropertiesCmd
Returns:
The response properties.

getXMLFile

public java.lang.String getXMLFile()
Returns the XML request.
Specified by:
getXMLFile in interface ProcessRequestPropertiesCmd
Returns:
The XML request.

isToolsFramework

public boolean isToolsFramework()
Whether the command is a tools framework command.
Specified by:
isToolsFramework in interface ProcessRequestPropertiesCmd
Returns:
Whether the command is a tools framework command.

performExecute

public void performExecute()
                    throws ECException
Extract the request properties.
Specified by:
performExecute in interface ECCommand
Overrides:
performExecute in class AbstractECTargetableCommand
Throws:
ECException - If there was a problem extracting the request properties.

removeToolsFrameworkProperties

public void removeToolsFrameworkProperties(TypedProperty aProperties)
Removes the tools framework objects from the request properties.
Parameters:
aProperties - the request properties.

setCheckURL

public void setCheckURL(boolean abCheckURL)
Sets whether to check for the URL parameter.
Specified by:
setCheckURL in interface ProcessRequestPropertiesCmd
Parameters:
abCheckURL - whether to check for the URL parameter.

setRequestProperties

public void setRequestProperties(TypedProperty aRequestProperties)
Sets the request properties.
Specified by:
setRequestProperties in interface ProcessRequestPropertiesCmd
Parameters:
aRequestProperties - the request properties.