Apache Struts API Documentation: Class DefinitionDispatcherAction

Apache Struts API


org.apache.struts.tiles.actions Class DefinitionDispatcherAction

java.lang.Object
  |
  +--org.apache.struts.action.Action
        |
        +--org.apache.struts.tiles.actions.DefinitionDispatcherAction

public class DefinitionDispatcherAction
extends Action

An Action that dispatches to a Tiles Definition that is named by the request parameter whose name is specified by the parameter property of the corresponding ActionMapping. This action is useful in following situations:

    • To associate an Url to a definition
      To use Struts <html:link> tag on a definition
  • To configure the use of this action in your struts-config.xml file, create an entry like this:

    <action path="/saveSubscription" type="org.apache.struts.tiles.actions.DefinitionDispatcherAction" parameter="def"/> <forward name="success" path="anything" //> <forward name="error" path="path.to.error.page" //>

    which will use the value of the request parameter named "def" to pick the appropriate definition name.

    The value for success doesn't matter. The forward will forward to appropriate definition.

    The value for error should denote a valid jsp path or definition name.

    Version:
    $Rev: 54929 $ $Date: 2004-10-16 17:38:42 +0100 (Sat, 16 Oct 2004) $

    Field Summary
    protected static org.apache.commons.logging.Log log
              Commons Logging instance.
     
    Fields inherited from class org.apache.struts.action.Action
    defaultLocale, servlet, token
     
    Constructor Summary
    DefinitionDispatcherAction()
               
     
    Method Summary
     ActionForward execute(ActionMapping mapping, ActionForm form, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
              Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it), with provision for handling exceptions thrown by the business logic.
    protected  void printError(javax.servlet.http.HttpServletResponse response, java.lang.String msg)
              Deprecated. This will be removed after Struts 1.2.
     
    Methods inherited from class org.apache.struts.action.Action
    addErrors, addMessages, execute, generateToken, getDataSource, getDataSource, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet
     
    Methods inherited from class java.lang.Object
    , clone, equals, finalize, getClass, hashCode, notify, notifyAll, registerNatives, toString, wait, wait, wait
     

    Field Detail

    log

    protected static org.apache.commons.logging.Log log
    Commons Logging instance.
    Constructor Detail

    DefinitionDispatcherAction

    public DefinitionDispatcherAction()
    Method Detail

    execute

    public ActionForward execute(ActionMapping mapping,
                                 ActionForm form,
                                 javax.servlet.http.HttpServletRequest request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws java.lang.Exception
    Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it), with provision for handling exceptions thrown by the business logic.
    Overrides:
    execute in class Action
    Parameters:
    mapping - The ActionMapping used to select this instance
    form - The optional ActionForm bean for this request (if any)
    request - The HTTP request we are processing
    response - The HTTP response we are creating
    Throws:
    java.lang.Exception - if the application business logic throws an exception
    Since:
    Struts 1.1

    printError

    protected void printError(javax.servlet.http.HttpServletResponse response,
                              java.lang.String msg)
                       throws java.io.IOException
    Deprecated. This will be removed after Struts 1.2.



    Copyright © 2000-2005 - The Apache Software Foundation