org.apache.struts.actions

Class SwitchAction

java.lang.Object

org.apache.struts.action.Action

org.apache.struts.actions.BaseAction

org.apache.struts.actions.SwitchAction

public class SwitchAction
extends BaseAction

A standard Action that switches to a new module and then forwards control to a URI (specified in a number of possible ways) within the new module.

Valid request parameters for this Action are:

• page - Module-relative URI (beginning with "/") to which control should be forwarded after switching.
• prefix - The module prefix (beginning with "/") of the module to which control should be switched. Use a zero-length string for the default module. The appropriate ModuleConfig object will be stored as a request attribute, so any subsequent logic will assume the new module.

Since:

Struts 1.1

Version:

$Rev: 471754 $ $Date: 2005-05-14 21:27:02 -0400 (Sat, 14 May 2005) $

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log Commons Logging instance.

Fields inherited from class org.apache.struts.actions.BaseAction

messages

Fields inherited from class org.apache.struts.action.Action

servlet

Constructor Summary

Constructors

Constructor and Description
SwitchAction()

Method Summary

Modifier and Type	Method and Description
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).

Methods inherited from class org.apache.struts.action.Action

addErrors, addMessages, execute, generateToken, getErrors, getLocale, getMessages, getResources, getResources, getServlet, isCancelled, isTokenValid, isTokenValid, resetToken, saveErrors, saveErrors, saveMessages, saveMessages, saveToken, setLocale, setServlet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

Commons Logging instance.

Constructor Detail

SwitchAction

public SwitchAction()

Method Detail

execute

public ActionForward execute(ActionMapping mapping,
                             ActionForm form,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws Exception

Process the specified HTTP request, and create the corresponding HTTP response (or forward to another web component that will create it). Return an ActionForward instance describing where and how control should be forwarded, or null if the response has already been completed.

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

Returns:

Return an ActionForward instance describing where and how control should be forwarded, or null if the response has already been completed.

Throws:

Exception - if an exception occurs