DefaultAnnotationHandlerMapping

Class Overview

Implementation of the HandlerMapping interface that maps handlers based on portlet modes expressed through the RequestMapping annotation at the type or method level.

Registered by default in DispatcherPortlet on Java 5+. NOTE: If you define custom HandlerMapping beans in your DispatcherPortlet context, you need to add a DefaultAnnotationHandlerMapping bean explicitly, since custom HandlerMapping beans replace the default mapping strategies. Defining a DefaultAnnotationHandlerMapping also allows for registering custom interceptors:

 <bean class="org.springframework.web.portlet.mvc.annotation.DefaultAnnotationHandlerMapping">
   <property name="interceptors">
     ...
   </property>
 </bean>

Annotated controllers are usually marked with the Controller stereotype at the type level. This is not strictly necessary when RequestMapping is applied at the type level (since such a handler usually implements the Controller interface). However, Controller is required for detecting RequestMapping annotations at the method level.

NOTE: Method-level mappings are only allowed to narrow the mapping expressed at the class level (if any). A portlet mode in combination with specific parameter conditions needs to uniquely map onto one specific handler bean, not spread across multiple handler beans. It is strongly recommended to co-locate related handler methods into the same bean.

The AnnotationMethodHandlerAdapter is responsible for processing annotated handler methods, as mapped by this HandlerMapping. For RequestMapping at the type level, specific HandlerAdapters such as SimpleControllerHandlerAdapter apply.

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

Public Constructors
	DefaultAnnotationHandlerMapping()

Public Methods
void	initApplicationContext() Calls the registerHandlers method in addition to the superclass's initialization.

Protected Methods
boolean	detectHandlerMethods(Class<?> handlerType, String beanName, RequestMapping typeMapping) Derive portlet mode mappings from the handler's method-level mappings.
void	detectHandlers() Register all handlers specified in the Portlet mode map for the corresponding modes.
PortletMode	getLookupKey(PortletRequest request) Uses the current PortletMode as lookup key.
void	validateHandler(Object handler, PortletRequest request) Validate the given annotated handler against the current request.
void	validateMapping(RequestMapping mapping, PortletRequest request) Validate the given type-level mapping metadata against the current request, checking HTTP request method and parameter conditions.

[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.