public class

DelegatingRequestProcessor

extends RequestProcessor
java.lang.Object
   ↳ RequestProcessor
     ↳ org.springframework.web.struts.DelegatingRequestProcessor

This class is deprecated.
as of Spring 3.0

Class Overview

Subclass of Struts's default RequestProcessor that looks up Spring-managed Struts Action Actions defined in ContextLoaderPlugIn's WebApplicationContext (or, as a fallback, in the root WebApplicationContext).

In the Struts config file, you can either specify the original Action class (as when generated by XDoclet), or no Action class at all. In any case, Struts will delegate to an Action bean in the ContextLoaderPlugIn context.

<action path="/login" type="myapp.MyAction"/>
or
<action path="/login"/>
The name of the Action bean in the WebApplicationContext will be determined from the mapping path and module prefix. This can be customized by overriding the determineActionBeanName(ActionMapping) method.

Example:

  • mapping path "/login" -> bean name "/login"
  • mapping path "/login", module prefix "/mymodule" -> bean name "/mymodule/login"

A corresponding bean definition in the ContextLoaderPlugin context would look as follows; notice that the Action is now able to leverage fully Spring's configuration facilities:

 <bean name="/login" class="myapp.MyAction">
   <property name="...">...</property>
 </bean>
Note that you can use a single ContextLoaderPlugIn for all Struts modules. That context can in turn be loaded from multiple XML files, for example split according to Struts modules. Alternatively, define one ContextLoaderPlugIn per Struts module, specifying appropriate "contextConfigLocation" parameters. In both cases, the Spring bean name has to include the module prefix.

If you also need the Tiles setup functionality of the original TilesRequestProcessor, use DelegatingTilesRequestProcessor. As there is just a single central class to customize in Struts, we have to provide another subclass here, covering both the Tiles and the Spring delegation aspect.

If this RequestProcessor conflicts with the need for a different RequestProcessor subclass (other than TilesRequestProcessor), consider using DelegatingActionProxy as the Struts Action type in your struts-config file.

The default implementation delegates to the DelegatingActionUtils class as much as possible, to reuse as much code as possible despite the need to provide two RequestProcessor subclasses. If you need to subclass yet another RequestProcessor, take this class as a template, delegating to DelegatingActionUtils just like it.

Summary

Public Constructors
DelegatingRequestProcessor()
Public Methods
void init(ActionServlet actionServlet, ModuleConfig moduleConfig)
Protected Methods
String determineActionBeanName(ActionMapping mapping)
Determine the name of the Action bean, to be looked up in the WebApplicationContext.
Action getDelegateAction(ActionMapping mapping)
Return the delegate Action for the given mapping.
final WebApplicationContext getWebApplicationContext()
Return the WebApplicationContext that this processor delegates to.
WebApplicationContext initWebApplicationContext(ActionServlet actionServlet, ModuleConfig moduleConfig)
Fetch ContextLoaderPlugIn's WebApplicationContext from the ServletContext, falling back to the root WebApplicationContext.
Action processActionCreate(HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)
Override the base class method to return the delegate action.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public DelegatingRequestProcessor ()

Public Methods

public void init (ActionServlet actionServlet, ModuleConfig moduleConfig)

Throws
ServletException

Protected Methods

protected String determineActionBeanName (ActionMapping mapping)

Determine the name of the Action bean, to be looked up in the WebApplicationContext.

The default implementation takes the org.apache.struts.action.ActionMapping#getPath mapping path and prepends the org.apache.struts.config.ModuleConfig#getPrefix module prefix, if any.

Parameters
mapping the Struts ActionMapping
Returns
  • the name of the Action bean
See Also

protected Action getDelegateAction (ActionMapping mapping)

Return the delegate Action for the given mapping.

The default implementation determines a bean name from the given ActionMapping and looks up the corresponding bean in the WebApplicationContext.

Parameters
mapping the Struts ActionMapping
Returns
  • the delegate Action, or null if none found
Throws
BeansException if thrown by WebApplicationContext methods

protected final WebApplicationContext getWebApplicationContext ()

Return the WebApplicationContext that this processor delegates to.

protected WebApplicationContext initWebApplicationContext (ActionServlet actionServlet, ModuleConfig moduleConfig)

Fetch ContextLoaderPlugIn's WebApplicationContext from the ServletContext, falling back to the root WebApplicationContext.

This context is supposed to contain the Struts Action beans to delegate to.

Parameters
actionServlet the associated ActionServlet
moduleConfig the associated ModuleConfig
Returns
  • the WebApplicationContext
Throws
IllegalStateException if no WebApplicationContext could be found

protected Action processActionCreate (HttpServletRequest request, HttpServletResponse response, ActionMapping mapping)

Override the base class method to return the delegate action.

Throws
IOException