com.ibm.commerce.struts

Class ECActionForward

  • java.lang.Object
    • org.apache.struts.config.ForwardConfig
      • org.apache.struts.action.ActionForward
        • com.ibm.commerce.struts.ECActionForward
  • All Implemented Interfaces:
    java.io.Serializable


    public class ECActionForward
    extends org.apache.struts.action.ActionForward
    This class defines a customized action forward class that can handle additional properties pertaining to executing a forward in WebSphere Commerce. The additional properties are:
    direct
    indicates whether this is a direct view
    interfaceName
    the interface name
    implClassName
    the command implementation class
    resourceClassName
    the resource class to use when performing access control checking for this view
    isStoreView
    indicates whether this is a store view
    properties
    name-value pairs in the form of an HTTP request query string
    The first three properties work together: when direct is true, the BaseAction class will not return the ActionForward object to the struts request processor but will execute the command defined by interfaceName and implClassName instead. This is used to handle customized HttpForwardViewCommands and HttpRedirectViewCommands, as well as commands returning an output stream.

    The properties property provides a generic way to define other properties for the view.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor and Description
      ECActionForward()
      This is the default constructor for this class.
      ECActionForward(java.lang.String path)
      This is a constructor for this class with one parameter.
      ECActionForward(java.lang.String path, boolean redirect)
      This method constructs an ECActionForward object with specified parameters.
      ECActionForward(java.lang.String name, java.lang.String path, boolean redirect)
      This method constructs an ECActionForward object with specified parameters.
      ECActionForward(java.lang.String name, java.lang.String path, boolean redirect, boolean contextRelative)
      This method constructs an ECActionForward object with specified parameters.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      java.lang.String getCredentialsAccepted()
      This method sets the flag that represents the type of authentication that is required to access the forward.
      java.util.Map getDefaultProperties()
      This method gets all the properties associated with this ActionForward object.
      java.lang.String getImplClassName()
      This method gets the implementation class name, as specified by the set-property element in the struts configuration file.
      java.lang.String getInterfaceName()
      This method gets the interface name, as specified by the set-property element in the struts configuration file.
      java.lang.String getProperties()
      This method gets the value of the properties property.
      java.lang.String getResourceClassName()
      This method gets the resource class name, as specified by the set-property element in the struts configuration file.
      java.lang.String getStoreDir()
      This method gets the store directory.
      java.lang.Integer getStoreId()
      This method gets the store id associated with this ActionForward object.
      boolean isDirectView()
      This method determines whether this is a direct view.
      boolean isGeneric()
      This method determines whether this view can be executed by a generic user.
      boolean isStoreView()
      This method determines whether this is a store view.
      void setCredentialsAccepted(java.lang.String credentialsAccepted)
      This method sets the flag that determines whether or not a user that is partially authenticated is allowed to access this URL.
      void setDirect(java.lang.String value)
      This method sets the value of the direct view property.
      void setImplClassName(java.lang.String string)
      This method sets the implementation class name, as specified by the set-property element in the struts configuration file.
      void setInterfaceName(java.lang.String string)
      This method sets the interface name, as specified by the set-property element in the struts configuration file.
      void setProperties(java.lang.String value)
      This method sets the value of the properties property, a multi-valued property similar to a query string.
      void setResourceClassName(java.lang.String string)
      This method sets the resource class name, as specified by the set-property element in the struts configuration file.
      void setStoreView(java.lang.String value)
      This method sets the value of the store view property.
      • Methods inherited from class org.apache.struts.config.ForwardConfig

        freeze, getContextRelative, getModule, getName, getPath, getRedirect, setContextRelative, setModule, setName, setPath, setRedirect, toString
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
    • Constructor Detail

      • ECActionForward

        public ECActionForward(java.lang.String name,
                               java.lang.String path,
                               boolean redirect)
        This method constructs an ECActionForward object with specified parameters.
        Parameters:
        name - The name for this object.
        path - The path for this object.
        redirect - A boolean value; true if this is a redirect object and false otherwise.
      • ECActionForward

        public ECActionForward(java.lang.String name,
                               java.lang.String path,
                               boolean redirect,
                               boolean contextRelative)
        This method constructs an ECActionForward object with specified parameters.
        Parameters:
        name - The name for this object.
        path - The path for this object.
        redirect - A boolean value; true if this is a redirect object and false otherwise.
        contextRelative - A boolean value; true if path should be interpreted as context-relative and false otherwise.
      • ECActionForward

        public ECActionForward(java.lang.String path,
                               boolean redirect)
        This method constructs an ECActionForward object with specified parameters.
        Parameters:
        path - The path for this object.
        redirect - A boolean value; true if this is a redirect object and false otherwise.
      • ECActionForward

        public ECActionForward()
        This is the default constructor for this class. It calls the constructor from the superclass. It constructs an ECActionForward object with ActionForward object values.
      • ECActionForward

        public ECActionForward(java.lang.String path)
        This is a constructor for this class with one parameter. This method constructs an ECActionForward object with specified parameters.
        Parameters:
        path - The path for this object.
    • Method Detail

      • setProperties

        public void setProperties(java.lang.String value)
        This method sets the value of the properties property, a multi-valued property similar to a query string. This method extracts each individual name/value pair from value and saves it in a map.
        Parameters:
        value - The new value of the properties property.
      • getProperties

        public java.lang.String getProperties()
        This method gets the value of the properties property.
        Returns:
        The value of the properties property.
      • getDefaultProperties

        public java.util.Map getDefaultProperties()
        This method gets all the properties associated with this ActionForward object.
        Returns:
        A map of all the properties.
      • setDirect

        public void setDirect(java.lang.String value)
        This method sets the value of the direct view property.
        Parameters:
        value - A boolean value; true means "direct view".
      • isDirectView

        public boolean isDirectView()
        This method determines whether this is a direct view.
        Returns:
        A boolean value; true if it is a direct view and false otherwise.
      • isGeneric

        public boolean isGeneric()
        This method determines whether this view can be executed by a generic user.
        Returns:
        A boolean value; true if it can be executed by a generic user and false otherwise.
      • getStoreDir

        public java.lang.String getStoreDir()
        This method gets the store directory.
        Returns:
        The store directory.
      • isStoreView

        public boolean isStoreView()
        This method determines whether this is a store view. It returns false by default.
        Returns:
        This method returns true if this is a store view and false otherwise.
      • getStoreId

        public java.lang.Integer getStoreId()
        This method gets the store id associated with this ActionForward object.
        Returns:
        The store id.
      • getImplClassName

        public java.lang.String getImplClassName()
        This method gets the implementation class name, as specified by the set-property element in the struts configuration file.
        Returns:
        The implementation class name.
      • getInterfaceName

        public java.lang.String getInterfaceName()
        This method gets the interface name, as specified by the set-property element in the struts configuration file.
        Returns:
        The interface name.
      • getResourceClassName

        public java.lang.String getResourceClassName()
        This method gets the resource class name, as specified by the set-property element in the struts configuration file.
        Returns:
        The resource class name.
      • setImplClassName

        public void setImplClassName(java.lang.String string)
        This method sets the implementation class name, as specified by the set-property element in the struts configuration file.
        Parameters:
        string - The implementation class name.
      • setInterfaceName

        public void setInterfaceName(java.lang.String string)
        This method sets the interface name, as specified by the set-property element in the struts configuration file.
        Parameters:
        string - The interface name.
      • setResourceClassName

        public void setResourceClassName(java.lang.String string)
        This method sets the resource class name, as specified by the set-property element in the struts configuration file.
        Parameters:
        string - The resource class name.
      • getCredentialsAccepted

        public java.lang.String getCredentialsAccepted()

        This method sets the flag that represents the type of authentication that is required to access the forward.

        • R or null - The partially authenticated user has no access.
        • P - The partially authenticated user can access the URL.
        Unless there is a value of P, a partially authenticated user is not entitled to access any resource by default.
        Returns:
        The flag that represents the type of authentication that is required to access the forward.
      • setCredentialsAccepted

        public void setCredentialsAccepted(java.lang.String credentialsAccepted)
        This method sets the flag that determines whether or not a user that is partially authenticated is allowed to access this URL.
        • R or null - The partially authenticated user has no access.
        • P - The partially authenticated user can access the URL.
        Unless there is a value of P, a partially authenticated user is not entitled to access any resource by default.
        Parameters:
        credentialsAccepted - The flag that represents the type of authentication that is required to access the forward.
      • setStoreView

        public void setStoreView(java.lang.String value)
        This method sets the value of the store view property.
        Parameters:
        value - A boolean value; true for store view and false otherwise.