Apache Struts API Documentation: Class ActionMapping

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.action Class ActionMapping

java.lang.Object
  |
  +--org.apache.struts.config.ActionConfig
        |
        +--org.apache.struts.action.ActionMapping

All Implemented Interfaces:: java.io.Serializable

Direct Known Subclasses:: RequestActionMapping, SessionActionMapping

public class ActionMapping
extends ActionConfig

An ActionMapping represents the information that the controller, RequestProcessor, knows about the mapping of a particular request to an instance of a particular Action class. The ActionMapping instance used to select a particular Action is passed on to that Action, thereby providing access to any custom configuration information included with the ActionMapping object.

Since Struts 1.1 this class extends ActionConfig.

NOTE - This class would have been deprecated and replaced by org.apache.struts.config.ActionConfig except for the fact that it is part of the public API that existing applications are using.

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

Fields inherited from class org.apache.struts.config.ActionConfig

attribute, configured, exceptions, forward, forwards, include, input, moduleConfig, multipartClass, name, parameter, path, prefix, roleNames, roles, scope, suffix, type, unknown, validate

Constructor Summary
`ActionMapping()`

Method Summary
`ActionForward`	`findForward(java.lang.String name)` Find and return the `ForwardConfig` instance defining how forwarding to the specified logical name should be handled.
`java.lang.String[]`	`findForwards()` Return the logical names of all locally defined forwards for this mapping.
`ActionForward`	`getInputForward()` Create (if necessary) and return an `ActionForward` that corresponds to the `input` property of this Action.

Methods inherited from class org.apache.struts.config.ActionConfig

addExceptionConfig, addForwardConfig, findException, findExceptionConfig, findExceptionConfigs, findForwardConfig, findForwardConfigs, freeze, getAttribute, getForward, getInclude, getInput, getModuleConfig, getMultipartClass, getName, getParameter, getPath, getPrefix, getRoleNames, getRoles, getScope, getSuffix, getType, getUnknown, getValidate, removeExceptionConfig, removeForwardConfig, setAttribute, setForward, setInclude, setInput, setModuleConfig, setMultipartClass, setName, setParameter, setPath, setPrefix, setRoles, setScope, setSuffix, setType, setUnknown, setValidate, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ActionMapping

public ActionMapping()

Method Detail

findForward

public ActionForward findForward(java.lang.String name)

Find and return the ForwardConfig instance defining how forwarding to the specified logical name should be handled. This is performed by checking local and then global configurations for the specified forwarding configuration. If no forwarding configuration can be found, return null.

Parameters:: name - Logical name of the forwarding instance to be returned

findForwards

public java.lang.String[] findForwards()

Return the logical names of all locally defined forwards for this mapping. If there are no such forwards, a zero-length array is returned.

getInputForward

public ActionForward getInputForward()

Create (if necessary) and return an ActionForward that corresponds to the input property of this Action.

Since:: Struts 1.1