Class AbstractHandlerMapping
- java.lang.Object
- org.springframework.context.support.ApplicationObjectSupport
- org.springframework.web.portlet.handler.AbstractHandlerMapping
- All Implemented Interfaces:
Aware
,ApplicationContextAware
,Ordered
,HandlerMapping
- Direct Known Subclasses:
AbstractMapBasedHandlerMapping
public abstract class AbstractHandlerMapping extends ApplicationObjectSupport implements HandlerMapping, Ordered
Abstract base class forHandlerMapping
implementations. Supports ordering, a default handler, and handler interceptors.- Since:
- 2.0
- Author:
- Juergen Hoeller, John A. Lewis
- See Also:
getHandlerInternal(javax.portlet.PortletRequest)
,setDefaultHandler(java.lang.Object)
,setInterceptors(java.lang.Object[])
,HandlerInterceptor
Field Summary
Fields inherited from class org.springframework.context.support.ApplicationObjectSupport
logger
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary
Constructors Constructor Description AbstractHandlerMapping()
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected HandlerInterceptor
adaptInterceptor(Object interceptor)
Adapt the given interceptor object to the HandlerInterceptor interface.protected void
extendInterceptors(List<?> interceptors)
Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (seesetInterceptors(java.lang.Object[])
).protected HandlerInterceptor[]
getAdaptedInterceptors()
Return the adapted interceptors as HandlerInterceptor array.Object
getDefaultHandler()
Return the default handler for this handler mapping, ornull
if none.HandlerExecutionChain
getHandler(PortletRequest request)
Look up a handler for the given request, falling back to the default handler if no specific one is found.protected HandlerExecutionChain
getHandlerExecutionChain(Object handler, PortletRequest request)
Build a HandlerExecutionChain for the given handler, including applicable interceptors.protected abstract Object
getHandlerInternal(PortletRequest request)
Look up a handler for the given request, returningnull
if no specific one is found.int
getOrder()
Get the order value of this object.protected void
initApplicationContext()
Initializes the interceptors.protected 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.void
setOrder(int order)
Specify the order value for this HandlerMapping bean.Methods inherited from class org.springframework.context.support.ApplicationObjectSupport
getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext
Constructor Detail
AbstractHandlerMapping
public AbstractHandlerMapping()
Method Detail
setOrder
public final void setOrder(int order)
Specify the order value for this HandlerMapping bean.Default value is
Integer.MAX_VALUE
, meaning that it's non-ordered.- See Also:
Ordered.getOrder()
getOrder
public final int getOrder()
Description copied from interface:Ordered
Get the order value of this object.Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet
load-on-startup
values).Same order values will result in arbitrary sort positions for the affected objects.
- Specified by:
getOrder
in interfaceOrdered
- Returns:
- the order value
- See Also:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
setDefaultHandler
public void setDefaultHandler(Object defaultHandler)
Set the default handler for this handler mapping. This handler will be returned if no specific mapping was found.Default is
null
, indicating no default handler.
getDefaultHandler
public Object getDefaultHandler()
Return the default handler for this handler mapping, ornull
if none.
setInterceptors
public void setInterceptors(Object[] interceptors)
Set the interceptors to apply for all handlers mapped by this handler mapping.Supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor will be wrapped in a WebRequestHandlerInterceptorAdapter.
- Parameters:
interceptors
- array of handler interceptors, ornull
if none- See Also:
adaptInterceptor(java.lang.Object)
,HandlerInterceptor
,WebRequestInterceptor
setApplyWebRequestInterceptorsToRenderPhaseOnly
public 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").Default is "true", since WebRequestInterceptors are usually built for MVC-style handler execution plus rendering process (which is, for example, the primary target scenario for "Open Session in View" interceptors, offering lazy loading of persistent objects during view rendering). Set this to "false" to have WebRequestInterceptors apply to the action phase as well (for example, in case of an "Open Session in View" interceptor, to allow for lazy loading outside of a transaction during the action phase).
initApplicationContext
protected void initApplicationContext() throws BeansException
Initializes the interceptors.- Overrides:
initApplicationContext
in classApplicationObjectSupport
- Throws:
ApplicationContextException
- in case of initialization errorsBeansException
- if thrown by ApplicationContext methods- See Also:
extendInterceptors(java.util.List)
,initInterceptors()
extendInterceptors
protected void extendInterceptors(List<?> interceptors)
Extension hook that subclasses can override to register additional interceptors, given the configured interceptors (seesetInterceptors(java.lang.Object[])
).Will be invoked before
initInterceptors()
adapts the specified interceptors intoHandlerInterceptor
instances.The default implementation is empty.
- Parameters:
interceptors
- the configured interceptor List (nevernull
), allowing to add further interceptors before as well as after the existing interceptors
initInterceptors
protected void initInterceptors()
Initialize the specified interceptors, adapting them where necessary.
adaptInterceptor
protected HandlerInterceptor adaptInterceptor(Object interceptor)
Adapt the given interceptor object to the HandlerInterceptor interface.Supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor will be wrapped in a WebRequestHandlerInterceptorAdapter. Can be overridden in subclasses.
- Parameters:
interceptor
- the specified interceptor object- Returns:
- the interceptor wrapped as HandlerInterceptor
- See Also:
setApplyWebRequestInterceptorsToRenderPhaseOnly(boolean)
,HandlerInterceptor
,WebRequestInterceptor
,WebRequestHandlerInterceptorAdapter
getAdaptedInterceptors
protected final HandlerInterceptor[] getAdaptedInterceptors()
Return the adapted interceptors as HandlerInterceptor array.- Returns:
- the array of HandlerInterceptors, or
null
if none
getHandler
public final HandlerExecutionChain getHandler(PortletRequest request) throws Exception
Look up a handler for the given request, falling back to the default handler if no specific one is found.- Specified by:
getHandler
in interfaceHandlerMapping
- Parameters:
request
- current portlet request- Returns:
- the corresponding handler instance, or the default handler
- Throws:
Exception
- if there is an internal error- See Also:
getHandlerInternal(javax.portlet.PortletRequest)
getHandlerInternal
protected abstract Object getHandlerInternal(PortletRequest request) throws Exception
Look up a handler for the given request, returningnull
if no specific one is found. This method is called bygetHandler(javax.portlet.PortletRequest)
; anull
return value will lead to the default handler, if one is set.Note: This method may also return a pre-built
HandlerExecutionChain
, combining a handler object with dynamically determined interceptors. Statically specified interceptors will get merged into such an existing chain.- Parameters:
request
- current portlet request- Returns:
- the corresponding handler instance, or
null
if none found - Throws:
Exception
- if there is an internal error- See Also:
getHandler(javax.portlet.PortletRequest)
getHandlerExecutionChain
protected HandlerExecutionChain getHandlerExecutionChain(Object handler, PortletRequest request)
Build a HandlerExecutionChain for the given handler, including applicable interceptors.The default implementation simply builds a standard HandlerExecutionChain with the given handler and this handler mapping's common interceptors. Subclasses may override this in order to extend/rearrange the list of interceptors.
NOTE: The passed-in handler object may be a raw handler or a pre-built HandlerExecutionChain. This method should handle those two cases explicitly, either building a new HandlerExecutionChain or extending the existing chain.
For simply adding an interceptor, consider calling
super.getHandlerExecutionChain
and invokingHandlerExecutionChain.addInterceptor(org.springframework.web.portlet.HandlerInterceptor)
on the returned chain object.- Parameters:
handler
- the resolved handler instance (nevernull
)request
- current portlet request- Returns:
- the HandlerExecutionChain (never
null
) - See Also:
getAdaptedInterceptors()