public class

ParameterMappingInterceptor

extends HandlerInterceptorAdapter
java.lang.Object
   ↳ org.springframework.web.portlet.handler.HandlerInterceptorAdapter
     ↳ org.springframework.web.portlet.handler.ParameterMappingInterceptor

Class Overview

Interceptor to forward a request parameter from the ActionRequest to the RenderRequest.

This can be useful when using ParameterHandlerMapping or PortletModeParameterHandlerMapping. It will ensure that the parameter that was used to map the ActionRequest to a handler will be forwarded to the RenderRequest so that it will also be mapped the same way.

When using this Interceptor, you can still change the value of the mapping parameter in your handler in order to change where the render request will get mapped.

Be aware that this Interceptor does call ActionResponse.setRenderParameter, which means that you will not be able to call ActionResponse.sendRedirect in your handler. If you may need to issue a redirect, then you should avoid this Interceptor and either write a different one that does this in a different way, or manually forward the parameter from within your handler(s).

Thanks to Rainer Schmitz for suggesting this mapping strategy!

Summary

Constants
String DEFAULT_PARAMETER_NAME Request parameter name to use for mapping to handlers
Public Constructors
ParameterMappingInterceptor()
Public Methods
boolean preHandleAction(ActionRequest request, ActionResponse response, Object handler)
If request is an javax.portlet.ActionRequest ActionRequest, get handler mapping parameter and add it to the ActionResponse.
void setParameterName(String parameterName)
Set the name of the parameter used for mapping.
[Expand]
Inherited Methods
From class org.springframework.web.portlet.handler.HandlerInterceptorAdapter
From class java.lang.Object
From interface org.springframework.web.portlet.HandlerInterceptor

Constants

public static final String DEFAULT_PARAMETER_NAME

Request parameter name to use for mapping to handlers

Constant Value: "action"

Public Constructors

public ParameterMappingInterceptor ()

Public Methods

public boolean preHandleAction (ActionRequest request, ActionResponse response, Object handler)

If request is an javax.portlet.ActionRequest ActionRequest, get handler mapping parameter and add it to the ActionResponse.

Parameters
request current portlet action request
response current portlet action response
handler chosen handler to execute, for type and/or instance evaluation
Returns
  • true if the execution chain should proceed with the next interceptor or the handler itself. Else, DispatcherPortlet assumes that this interceptor has already dealt with the response itself

public void setParameterName (String parameterName)

Set the name of the parameter used for mapping.