|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.springframework.context.support.ApplicationObjectSupport org.springframework.web.portlet.handler.AbstractHandlerMapping
public abstract class AbstractHandlerMapping
Abstract base class for HandlerMapping
implementations. Supports ordering, a default handler, and handler interceptors.
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 | |
---|---|
AbstractHandlerMapping()
|
Method Summary | |
---|---|
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 (see setInterceptors(java.lang.Object[]) ). |
protected HandlerInterceptor[] |
getAdaptedInterceptors()
Return the adapted interceptors as HandlerInterceptor array. |
Object |
getDefaultHandler()
Return the default handler for this handler mapping, or null 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, returning null if no
specific one is found. |
int |
getOrder()
Return the order value of this object, with a higher value meaning greater in terms of sorting. |
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, isContextRequired, requiredContextClass, setApplicationContext |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public AbstractHandlerMapping()
Method Detail |
---|
public final void setOrder(int order)
Default value is Integer.MAX_VALUE
, meaning that it's non-ordered.
Ordered.getOrder()
public final int getOrder()
Ordered
Normally starting with 0 or 1, with Ordered.LOWEST_PRECEDENCE
indicating greatest. Same order values will result in arbitrary
positions for the affected objects.
Higher value can be interpreted as lower priority, consequently the first object has highest priority (somewhat analogous to Servlet "load-on-startup" values).
Note that order values below 0 are reserved for framework purposes. Application-specified values should always be 0 or greater, with only framework components (internal or third-party) supposed to use lower values.
Ordered.LOWEST_PRECEDENCE
public void setDefaultHandler(Object defaultHandler)
Default is null
, indicating no default handler.
public Object getDefaultHandler()
null
if none.
public void setInterceptors(Object[] interceptors)
Supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor will be wrapped in a WebRequestHandlerInterceptorAdapter.
interceptors
- array of handler interceptors, or null
if noneadaptInterceptor(java.lang.Object)
,
HandlerInterceptor
,
WebRequestInterceptor
public void setApplyWebRequestInterceptorsToRenderPhaseOnly(boolean applyWebRequestInterceptorsToRenderPhaseOnly)
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).
protected void initApplicationContext() throws BeansException
initApplicationContext
in class ApplicationObjectSupport
ApplicationContextException
- in case of initialization errors
BeansException
- if thrown by ApplicationContext methodsextendInterceptors(java.util.List)
,
initInterceptors()
protected void extendInterceptors(List interceptors)
setInterceptors(java.lang.Object[])
).
Will be invoked before initInterceptors()
adapts the specified
interceptors into HandlerInterceptor
instances.
The default implementation is empty.
interceptors
- the configured interceptor List (never null
),
allowing to add further interceptors before as well as after the existing
interceptorsprotected void initInterceptors()
protected HandlerInterceptor adaptInterceptor(Object interceptor)
Supported interceptor types are HandlerInterceptor and WebRequestInterceptor. Each given WebRequestInterceptor will be wrapped in a WebRequestHandlerInterceptorAdapter. Can be overridden in subclasses.
interceptor
- the specified interceptor object
setApplyWebRequestInterceptorsToRenderPhaseOnly(boolean)
,
HandlerInterceptor
,
WebRequestInterceptor
,
WebRequestHandlerInterceptorAdapter
protected final HandlerInterceptor[] getAdaptedInterceptors()
null
if nonepublic final HandlerExecutionChain getHandler(PortletRequest request) throws Exception
getHandler
in interface HandlerMapping
request
- current portlet request
Exception
- if there is an internal errorgetHandlerInternal(javax.portlet.PortletRequest)
protected abstract Object getHandlerInternal(PortletRequest request) throws Exception
null
if no
specific one is found. This method is called by getHandler;
a null
return value will lead to the default handler, if one is set.
- 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)
protected HandlerExecutionChain getHandlerExecutionChain(Object handler, PortletRequest request)
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.
handler
- the resolved handler instance (never null
)request
- current portlet request
null
)getAdaptedInterceptors()
|
The Spring Framework | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |