com.opensymphony.webwork.dispatcher
Class ServletDispatcherResult

java.lang.Object
  extended by com.opensymphony.webwork.dispatcher.WebWorkResultSupport
      extended by com.opensymphony.webwork.dispatcher.ServletDispatcherResult
All Implemented Interfaces:
WebWorkStatics, Result, Serializable
Direct Known Subclasses:
TilesResult

public class ServletDispatcherResult
extends WebWorkResultSupport

Includes or forwards to a view (usually a jsp). Behind the scenes WebWork will use a RequestDispatcher, where the target servlet/JSP receives the same request/response objects as the original servlet/JSP. Therefore, you can pass data between them using request.setAttribute() - the WebWork action is available.

There are three possible ways the result can be executed:

This result type takes the following parameters: Example:

 <result name="success" type="dispatcher">
   <param name="location">foo.jsp</param>
 </result>
 
This result follows the same rules from WebWorkResultSupport.

Author:
Patrick Lightbody
See Also:
RequestDispatcher, Serialized Form

Field Summary
 
Fields inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport
DEFAULT_PARAM, encode, location, parse
 
Fields inherited from interface com.opensymphony.webwork.WebWorkStatics
HTTP_REQUEST, HTTP_RESPONSE, PAGE_CONTEXT, SERVLET_CONTEXT, SERVLET_DISPATCHER
 
Constructor Summary
ServletDispatcherResult()
           
 
Method Summary
 void doExecute(String finalLocation, ActionInvocation invocation)
          Dispatches to the given location.
 
Methods inherited from class com.opensymphony.webwork.dispatcher.WebWorkResultSupport
conditionalParse, execute, setEncode, setLocation, setParse
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletDispatcherResult

public ServletDispatcherResult()
Method Detail

doExecute

public void doExecute(String finalLocation,
                      ActionInvocation invocation)
               throws Exception
Dispatches to the given location. Does its forward via a RequestDispatcher. If the dispatch fails a 404 error will be sent back in the http response.

Specified by:
doExecute in class WebWorkResultSupport
Parameters:
finalLocation - the location to dispatch to.
invocation - the execution state of the action
Throws:
Exception - if an error occurs. If the dispatch fails the error will go back via the HTTP request.

WebWork Project Page