PortletModeParameterHandlerMapping

Class Overview

Implementation of the HandlerMapping interface to map from the current PortletMode and a request parameter to request handler beans. The mapping consists of two levels: first the PortletMode and then the parameter value. In order to be mapped, both elements must match the mapping definition.

This is a combination of the methods used in PortletModeHandlerMapping and ParameterHandlerMapping. Unlike those two classes, this mapping cannot be initialized with properties since it requires a two-level map.

The default name of the parameter is "action", but can be changed using setParameterName().

By default, the same parameter value may not be used in two different portlet modes. This is so that if the portal itself changes the portlet mode, the request will no longer be valid in the mapping. This behavior can be changed with setAllowDupParameters().

The bean configuration for this mapping will look somthing like this:

 <bean id="portletModeParameterHandlerMapping" class="org.springframework.web.portlet.handler.PortletModeParameterHandlerMapping">
   <property name="portletModeParameterMap">
     <map>
       <entry key="view"> <!-- portlet mode: view -->
         <map>
           <entry key="add"><ref bean="addItemHandler"/></entry>
           <entry key="edit"><ref bean="editItemHandler"/></entry>
           <entry key="delete"><ref bean="deleteItemHandler"/></entry>
         </map>
       </entry>
       <entry key="edit"> <!-- portlet mode: edit -->
         <map>
           <entry key="prefs"><ref bean="preferencesHandler"/></entry>
           <entry key="resetPrefs"><ref bean="resetPreferencesHandler"/></entry>
         </map>
       </entry>
     </map>
   </property>
 </bean>

This mapping can be chained ahead of a PortletModeHandlerMapping, which can then provide defaults for each mode and an overall default as well.

Thanks to Rainer Schmitz and Yujin Kim for suggesting this mapping strategy!

Summary

[Expand] Inherited Constants
From interface org.springframework.core.Ordered int HIGHEST_PRECEDENCE Useful constant for the highest precedence value. int LOWEST_PRECEDENCE Useful constant for the lowest precedence value.

[Expand] Inherited Fields
From class org.springframework.context.support.ApplicationObjectSupport protected final Log logger Logger that is available to subclasses

[Expand] Inherited Methods
From class org.springframework.web.portlet.handler.AbstractMapBasedHandlerMapping Object getHandlerInternal(PortletRequest request) Determines a handler for the computed lookup key for the given request. abstract K getLookupKey(PortletRequest request) Build a lookup key for the given request. void registerHandler(K lookupKey, Object handler, AbstractMapBasedHandlerMapping.PortletRequestMappingPredicate predicate) Register the given handler instance for the given parameter value. void registerHandler(K lookupKey, Object handler) Register the given handler instance for the given parameter value. void registerHandlers(Map<K, ?> handlerMap) Register all handlers specified in the Portlet mode map for the corresponding modes. void setLazyInitHandlers(boolean lazyInitHandlers) Set whether to lazily initialize handlers.
From class org.springframework.web.portlet.handler.AbstractHandlerMapping HandlerInterceptor adaptInterceptor(Object interceptor) Adapt the given interceptor object to the HandlerInterceptor interface. void extendInterceptors(List interceptors) Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (see setInterceptors(Object[])). final HandlerInterceptor[] getAdaptedInterceptors() Return the adapted interceptors as HandlerInterceptor array. Object getDefaultHandler() Return the default handler for this handler mapping, or null if none. final HandlerExecutionChain getHandler(PortletRequest request) Look up a handler for the given request, falling back to the default handler if no specific one is found. HandlerExecutionChain getHandlerExecutionChain(Object handler, PortletRequest request) Build a HandlerExecutionChain for the given handler, including applicable interceptors. abstract Object getHandlerInternal(PortletRequest request) Look up a handler for the given request, returning null if no specific one is found. final int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting. void initApplicationContext() Initializes the interceptors. void initInterceptors() Initialize the specified interceptors, adapting them where necessary. void setApplyWebRequestInterceptorsToRenderPhaseOnly(boolean applyWebRequestInterceptorsToRenderPhaseOnly) Specify whether to apply WebRequestInterceptors to the Portlet render phase only ("true", or whether to apply them to the Portlet action phase as well ("false"). void setDefaultHandler(Object defaultHandler) Set the default handler for this handler mapping. void setInterceptors(Object[] interceptors) Set the interceptors to apply for all handlers mapped by this handler mapping. final void setOrder(int order) Specify the order value for this HandlerMapping bean.
From class org.springframework.context.support.ApplicationObjectSupport final ApplicationContext getApplicationContext() Return the ApplicationContext that this object is associated with. final MessageSourceAccessor getMessageSourceAccessor() Return a MessageSourceAccessor for the application context used by this object, for easy message access. void initApplicationContext() Subclasses can override this for custom initialization behavior. void initApplicationContext(ApplicationContext context) Subclasses can override this for custom initialization behavior. boolean isContextRequired() Determine whether this application object needs to run in an ApplicationContext. Class requiredContextClass() Determine the context class that any context passed to setApplicationContext must be an instance of. final void setApplicationContext(ApplicationContext context) Set the ApplicationContext that this object runs in.
From class java.lang.Object Object clone() boolean equals(Object arg0) void finalize() final Class<?> getClass() int hashCode() final void notify() final void notifyAll() String toString() final void wait() final void wait(long arg0, int arg1) final void wait(long arg0)
From interface org.springframework.context.ApplicationContextAware abstract void setApplicationContext(ApplicationContext applicationContext) Set the ApplicationContext that this object runs in.
From interface org.springframework.core.Ordered abstract int getOrder() Return the order value of this object, with a higher value meaning greater in terms of sorting.
From interface org.springframework.web.portlet.HandlerMapping abstract HandlerExecutionChain getHandler(PortletRequest request) Return a handler and any interceptors for this request.