Apache Struts API Documentation: Class SwitchAction

Apache Struts API

previous page next page

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.apache.struts.actions Class SwitchAction

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

public class SwitchAction
extends Action

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: 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.
`protected static MessageResources`	`messages` The message resources for this package.

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

defaultLocale, servlet, token

Constructor Summary
`SwitchAction()`

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.

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.

messages

protected static MessageResources messages

The message resources for this package.

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 java.lang.Exception

Description copied from class: Action

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. 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

Following copied from class: org.apache.struts.action.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