public class DefaultAnnotationHandlerMapping extends AbstractMapBasedHandlerMapping<PortletMode>
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
.
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.
RequestMapping
,
AnnotationMethodHandlerAdapter
Modifier and Type | Class and Description |
---|---|
private static class |
DefaultAnnotationHandlerMapping.AbstractParameterMappingPredicate |
private static class |
DefaultAnnotationHandlerMapping.ActionMappingPredicate |
private static class |
DefaultAnnotationHandlerMapping.EventMappingPredicate |
private static class |
DefaultAnnotationHandlerMapping.MethodLevelMappingPredicate |
private static class |
DefaultAnnotationHandlerMapping.RenderMappingPredicate |
private static class |
DefaultAnnotationHandlerMapping.ResourceMappingPredicate |
private static interface |
DefaultAnnotationHandlerMapping.SpecialRequestTypePredicate |
private static class |
DefaultAnnotationHandlerMapping.TypeLevelMappingPredicate |
AbstractMapBasedHandlerMapping.PortletRequestMappingPredicate
logger
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor and Description |
---|
DefaultAnnotationHandlerMapping() |
Modifier and Type | Method and Description |
---|---|
protected boolean |
detectHandlerMethods(java.lang.Class<?> handlerType,
java.lang.String beanName,
RequestMapping typeMapping)
Derive portlet mode mappings from the handler's method-level mappings.
|
protected void |
detectHandlers()
Register all handlers specified in the Portlet mode map for the corresponding modes.
|
protected PortletMode |
getLookupKey(PortletRequest request)
Uses the current PortletMode as lookup key.
|
void |
initApplicationContext()
Calls the
registerHandlers method in addition
to the superclass's initialization. |
getHandlerInternal, registerHandler, registerHandler, registerHandlers, setLazyInitHandlers
adaptInterceptor, extendInterceptors, getAdaptedInterceptors, getDefaultHandler, getHandler, getHandlerExecutionChain, getOrder, initInterceptors, setApplyWebRequestInterceptorsToRenderPhaseOnly, setDefaultHandler, setInterceptors, setOrder
getApplicationContext, getMessageSourceAccessor, initApplicationContext, isContextRequired, requiredContextClass, setApplicationContext
public void initApplicationContext() throws BeansException
registerHandlers
method in addition
to the superclass's initialization.initApplicationContext
in class AbstractHandlerMapping
ApplicationContextException
- in case of initialization errorsBeansException
- if thrown by ApplicationContext methodsdetectHandlers()
protected void detectHandlers() throws BeansException
BeansException
- if the handler couldn't be registeredprotected boolean detectHandlerMethods(java.lang.Class<?> handlerType, java.lang.String beanName, RequestMapping typeMapping)
handlerType
- the handler type to introspectbeanName
- the name of the bean introspectedtypeMapping
- the type level mapping (if any)true
if at least 1 handler method has been registered;
false
otherwiseprotected PortletMode getLookupKey(PortletRequest request) throws java.lang.Exception
getLookupKey
in class AbstractMapBasedHandlerMapping<PortletMode>
request
- current portlet requestnull
)java.lang.Exception
- if key computation failed