com.ibm.commerce.command
Class AbstractRedirectViewCommand

java.lang.Object
  |
  +--com.ibm.commerce.command.AbstractECCommand
        |
        +--com.ibm.commerce.command.AbstractViewCommand
              |
              +--com.ibm.commerce.command.AbstractRedirectViewCommand
All Implemented Interfaces:
AccCommand, ECCommand, RedirectViewCommand, ViewCommand
Direct Known Subclasses:
HttpRedirectViewCommandImpl, HttpsRedirectViewCommandImpl

public abstract class AbstractRedirectViewCommand
extends AbstractViewCommand
implements RedirectViewCommand

The abstract base implementation of all redirect view commands. All redirect view commands should extend from this class.


Field Summary
 
Fields inherited from class com.ibm.commerce.command. AbstractViewCommand
requestProperties, responseProperties
 
Fields inherited from class com.ibm.commerce.command. AbstractECCommand
commandContext
 
Fields inherited from interface com.ibm.commerce.command. RedirectViewCommand
COPYRIGHT
 
Fields inherited from interface com.ibm.commerce.command. ECCommand
defaultCommandClassName
 
Constructor Summary
AbstractRedirectViewCommand()
          Constructor for AbstractRedirectViewCommand
 
Method Summary
 java.lang.String getDocumentPathName()
          Returns the path name of the document to be forwarded.
 java.lang.String getRedirectUrl()
          Gets the EC_REDIRECTURL property from the request properties.
 void setViewStorePath(java.lang.Integer storePathId)
          Sets the directory for the store path used to instantiate this view command.
 
Methods inherited from class com.ibm.commerce.command. AbstractViewCommand
fulfills, getForUserId, getOwner, getRequestProperties, getResourceOwners, getResponseProperties, getViewName, mergeProperties, performExecute, setForUserId, setOwner, setRequestProperties, setResponseProperties, setViewName
 
Methods inherited from class com.ibm.commerce.command. AbstractECCommand
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
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.ibm.commerce.command. ViewCommand
getRequestProperties, getResponseProperties, getViewName, mergeProperties, setRequestProperties, setViewName
 
Methods inherited from interface com.ibm.commerce.command. AccCommand
accessControlCheck, getAccCheck, getForUserId, getResourceOwners, setAccCheck, setForUserId, setOwner
 
Methods inherited from interface com.ibm.commerce.command. ECCommand
checkIsAllowed, checkResourcePermission, createCommandExecutionEvent, execute, getCommandContext, getCommandIfName, getCommandName, getCommandStoreId, getDefaultProperties, getResources, getStoreId, getUser, getUserId, performExecute, setCommandContext, setCommandIfName, setCommandStoreId, setDefaultProperties, validateParameters
 

Constructor Detail

AbstractRedirectViewCommand

public AbstractRedirectViewCommand()
Constructor for AbstractRedirectViewCommand
Method Detail

setViewStorePath

public void setViewStorePath(java.lang.Integer storePathId)
Sets the directory for the store path used to instantiate this view command.
Parameters:
storePathId - store path identifier

getDocumentPathName

public java.lang.String getDocumentPathName()
                                     throws ECException
Returns the path name of the document to be forwarded.
Specified by:
getDocumentPathName in interface RedirectViewCommand
Returns:
Document path name
Throws:
ECException

getRedirectUrl

public java.lang.String getRedirectUrl()
                                throws ECException
Gets the EC_REDIRECTURL property from the request properties. If none is found try to get the EC_URL property instead. If none is found, throws a parameter not found exception. After the EC_REDIRECTURL or EC_REDIRECTURL has been retrieved, it will be removed from the properties list so that it won't be added as parameters to the redirect url itself.
Specified by:
getRedirectUrl in interface RedirectViewCommand
Returns:
the redirect URL
Throws:
ECException