java.lang.Object | +--CacheableCommandImpl | +--com.ibm.commerce.command.AbstractECTargetableCommand | +--com.ibm.commerce.command.TaskCommandImpl | +--com.ibm.commerce.usermanagement.commands.ProcessRequestPropertiesCmdImpl
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
public static final java.lang.String CLASSNAME
protected TypedProperty requestProperties
protected TypedProperty responseProperties
protected boolean bToolsFramework
protected java.lang.String istrXMLFile
protected boolean bCheckURL
Constructor Detail |
---|
public ProcessRequestPropertiesCmdImpl()
Method Detail |
---|
public boolean getCheckURL()
getCheckURL
in interface
ProcessRequestPropertiesCmd
public TypedProperty getRequestProperties()
getRequestProperties
in interface
ProcessRequestPropertiesCmd
public TypedProperty getResponseProperties()
getResponseProperties
in interface
ProcessRequestPropertiesCmd
public java.lang.String getXMLFile()
getXMLFile
in interface
ProcessRequestPropertiesCmd
public boolean isToolsFramework()
isToolsFramework
in interface
ProcessRequestPropertiesCmd
public void performExecute() throws ECException
performExecute
in interface
ECCommand
performExecute
in class
AbstractECTargetableCommand
ECException
- If there was a problem extracting the request properties.public void removeToolsFrameworkProperties(TypedProperty aProperties)
aProperties
- the request properties.public void setCheckURL(boolean abCheckURL)
setCheckURL
in interface
ProcessRequestPropertiesCmd
abCheckURL
- whether to check for the URL
parameter.public void setRequestProperties(TypedProperty aRequestProperties)
setRequestProperties
in interface
ProcessRequestPropertiesCmd
aRequestProperties
- the request
properties.