Apache Struts API Documentation: Class IncludeAction

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 IncludeAction

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

public class IncludeAction
extends Action

An Action that includes the context-relative URI specified by the parameter property of our associated ActionMapping. This can be used to integrate Struts with other business logic components that are implemented as servlets (or JSP pages), but still take advantage of the Struts controller servlet's functionality (such as processing of form beans).

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.actions.IncludeAction"
           name="subscriptionForm"
          scope="request"
          input="/subscription.jsp"
      parameter="/path/to/processing/servlet">

which will include the context-relative URI specified by the parameter attribute.

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

Field Summary
`protected static MessageResources`	`messages` The message resources for this package.

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

defaultLocale, servlet, token

Constructor Summary
`IncludeAction()`

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

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

messages

protected static MessageResources messages

The message resources for this package.

Constructor Detail

IncludeAction

public IncludeAction()

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). 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
Throws:: java.lang.Exception - if an error occurs