com.liferay.portletmvc4spring.mvc.method.annotation

Class PortletRequestMappingHandlerAdapter

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

com.liferay.portletmvc4spring.context.PortletApplicationObjectSupport

com.liferay.portletmvc4spring.handler.PortletContentGenerator

com.liferay.portletmvc4spring.mvc.method.AbstractPortletHandlerMethodAdapter

com.liferay.portletmvc4spring.mvc.method.annotation.PortletRequestMappingHandlerAdapter

All Implemented Interfaces:

PortletContextAware, HandlerAdapter, Aware, BeanFactoryAware, InitializingBean, ApplicationContextAware, Ordered

public class PortletRequestMappingHandlerAdapter
extends AbstractPortletHandlerMethodAdapter
implements BeanFactoryAware, InitializingBean

Extension of AbstractPortletHandlerMethodAdapter that supports HandlerMethods annotated with ActionMapping, EventMapping, RenderMapping, or ResourceMapping.

Support for custom argument and return value types can be added via setCustomArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>) and setCustomReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>), or alternatively, to re-configure all argument and return value types, use setArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>) and setReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>).

Since:

5.1

Author:

Rossen Stoyanchev, Juergen Hoeller, Neil Griffin

See Also:

HandlerMethodArgumentResolver, HandlerMethodReturnValueHandler

Field Summary

Fields

Modifier and Type	Field and Description
static String	IMPLICIT_MODEL_RENDER_PARAMETER
static String	IMPLICIT_MODEL_SESSION_ATTRIBUTE
static ReflectionUtils.MethodFilter	INIT_BINDER_METHODS MethodFilter that matches @InitBinder methods.
static ReflectionUtils.MethodFilter	MODEL_ATTRIBUTE_METHODS MethodFilter that matches @ModelAttribute methods.

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 and Description
PortletRequestMappingHandlerAdapter()

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet()
protected InitBinderDataBinderFactory	createDataBinderFactory(List<InvocableHandlerMethod> binderMethods) Template method to create a new InitBinderDataBinderFactory instance.
protected PortletInvocableHandlerMethod	createInvocableHandlerMethod(HandlerMethod handlerMethod) Create a PortletInvocableHandlerMethod from the given HandlerMethod definition.
protected ModelAndView	doHandle(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, HandlerMethod handlerMethod)
protected ModelAndView	doHandle(javax.portlet.PortletRequest request, javax.portlet.PortletResponse response, Object handler)
List<HandlerMethodArgumentResolver>	getArgumentResolvers() Return the configured argument resolvers, or possibly null if not initialized yet via afterPropertiesSet().
protected ConfigurableBeanFactory	getBeanFactory() Return the owning factory of this bean instance, or null if none.
List<HandlerMethodArgumentResolver>	getCustomArgumentResolvers() Return the custom argument resolvers, or null.
List<HandlerMethodReturnValueHandler>	getCustomReturnValueHandlers() Return the custom return value handlers, or null.
List<HandlerMethodArgumentResolver>	getInitBinderArgumentResolvers() Return the argument resolvers for @InitBinder methods, or possibly null if not initialized yet via afterPropertiesSet().
List<HttpMessageConverter<?>>	getMessageConverters() Return the configured message body converters.
List<ModelAndViewResolver>	getModelAndViewResolvers() Return the configured ModelAndViewResolvers, or null.
List<HandlerMethodReturnValueHandler>	getReturnValueHandlers() Return the configured handlers, or possibly null if not initialized yet via afterPropertiesSet().
WebBindingInitializer	getWebBindingInitializer() Return the configured WebBindingInitializer, or null if none.
protected void	handleActionInternal(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, Object handler) Use the given handler method to handle the request.
protected void	handleEventInternal(javax.portlet.EventRequest request, javax.portlet.EventResponse response, Object handler) Use the given handler method to handle the request.
protected ModelAndView	handleRenderInternal(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, Object handler) Use the given handler method to handle the request.
protected ModelAndView	handleResourceInternal(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, Object handler) Use the given handler method to handle the request.
void	setArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.
void	setBeanFactory(BeanFactory beanFactory) A ConfigurableBeanFactory is expected for resolving expressions in method argument default values.
void	setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager) Set the ContentNegotiationManager to use to determine requested media types.
void	setCustomArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) Provide resolvers for custom argument types.
void	setCustomReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) Provide handlers for custom return value types.
void	setInitBinderArgumentResolvers(List<HandlerMethodArgumentResolver> argumentResolvers) Configure the supported argument types in @InitBinder methods.
void	setMessageConverters(List<HttpMessageConverter<?>> messageConverters) Provide the converters to use in argument resolvers and return value handlers that support reading and/or writing to the body of the request and response.
void	setModelAndViewResolvers(List<ModelAndViewResolver> modelAndViewResolvers) Provide custom ModelAndViewResolvers.
void	setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer) Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g.
void	setReturnValueHandlers(List<HandlerMethodReturnValueHandler> returnValueHandlers) Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.
void	setSessionAttributeStore(SessionAttributeStore sessionAttributeStore) Specify the strategy to store session attributes with.
void	setTaskExecutor(AsyncTaskExecutor taskExecutor) Set the default AsyncTaskExecutor to use when a controller method return a Callable.
void	setWebBindingInitializer(WebBindingInitializer webBindingInitializer) Provide a WebBindingInitializer with "global" initialization to apply to every DataBinder instance.
protected boolean	supportsInternal(Object handler) Always return true since any method argument and return value type will be processed in some way.

Methods inherited from class com.liferay.portletmvc4spring.mvc.method.AbstractPortletHandlerMethodAdapter

getOrder, handleAction, handleEvent, handleRender, handleResource, setOrder, supports

Methods inherited from class com.liferay.portletmvc4spring.handler.PortletContentGenerator

applyCacheSeconds, cacheForSeconds, check, checkAndPrepare, checkAndPrepare, getCacheSeconds, isRequireSession, preventCaching, setCacheSeconds, setRequireSession

Methods inherited from class com.liferay.portletmvc4spring.context.PortletApplicationObjectSupport

getPortletContext, getTempDir, isContextRequired, setPortletContext

Methods inherited from class org.springframework.context.support.ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

IMPLICIT_MODEL_SESSION_ATTRIBUTE

public static final String IMPLICIT_MODEL_SESSION_ATTRIBUTE

IMPLICIT_MODEL_RENDER_PARAMETER

public static final String IMPLICIT_MODEL_RENDER_PARAMETER

See Also:

Constant Field Values

INIT_BINDER_METHODS

public static final ReflectionUtils.MethodFilter INIT_BINDER_METHODS

MethodFilter that matches @InitBinder methods.

MODEL_ATTRIBUTE_METHODS

public static final ReflectionUtils.MethodFilter MODEL_ATTRIBUTE_METHODS

MethodFilter that matches @ModelAttribute methods.

Constructor Detail

PortletRequestMappingHandlerAdapter

public PortletRequestMappingHandlerAdapter()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

getArgumentResolvers

@Nullable
public List<HandlerMethodArgumentResolver> getArgumentResolvers()

Return the configured argument resolvers, or possibly null if not initialized yet via afterPropertiesSet().

getCustomArgumentResolvers

@Nullable
public List<HandlerMethodArgumentResolver> getCustomArgumentResolvers()

Return the custom argument resolvers, or null.

getCustomReturnValueHandlers

@Nullable
public List<HandlerMethodReturnValueHandler> getCustomReturnValueHandlers()

Return the custom return value handlers, or null.

getInitBinderArgumentResolvers

@Nullable
public List<HandlerMethodArgumentResolver> getInitBinderArgumentResolvers()

Return the argument resolvers for @InitBinder methods, or possibly null if not initialized yet via afterPropertiesSet().

getMessageConverters

public List<HttpMessageConverter<?>> getMessageConverters()

Return the configured message body converters.

getModelAndViewResolvers

@Nullable
public List<ModelAndViewResolver> getModelAndViewResolvers()

Return the configured ModelAndViewResolvers, or null.

getReturnValueHandlers

@Nullable
public List<HandlerMethodReturnValueHandler> getReturnValueHandlers()

Return the configured handlers, or possibly null if not initialized yet via afterPropertiesSet().

getWebBindingInitializer

@Nullable
public WebBindingInitializer getWebBindingInitializer()

Return the configured WebBindingInitializer, or null if none.

setArgumentResolvers

public void setArgumentResolvers(@Nullable
                                 List<HandlerMethodArgumentResolver> argumentResolvers)

Configure the complete list of supported argument types thus overriding the resolvers that would otherwise be configured by default.

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

A ConfigurableBeanFactory is expected for resolving expressions in method argument default values.

Specified by:

setBeanFactory in interface BeanFactoryAware

setContentNegotiationManager

public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

Set the ContentNegotiationManager to use to determine requested media types. If not set, the default constructor is used.

setCustomArgumentResolvers

public void setCustomArgumentResolvers(@Nullable
                                       List<HandlerMethodArgumentResolver> argumentResolvers)

Provide resolvers for custom argument types. Custom resolvers are ordered after built-in ones. To override the built-in support for argument resolution use setArgumentResolvers(java.util.List<org.springframework.web.method.support.HandlerMethodArgumentResolver>) instead.

setCustomReturnValueHandlers

public void setCustomReturnValueHandlers(@Nullable
                                         List<HandlerMethodReturnValueHandler> returnValueHandlers)

Provide handlers for custom return value types. Custom handlers are ordered after built-in ones. To override the built-in support for return value handling use setReturnValueHandlers(java.util.List<org.springframework.web.method.support.HandlerMethodReturnValueHandler>).

setInitBinderArgumentResolvers

public void setInitBinderArgumentResolvers(@Nullable
                                           List<HandlerMethodArgumentResolver> argumentResolvers)

Configure the supported argument types in @InitBinder methods.

setMessageConverters

public void setMessageConverters(List<HttpMessageConverter<?>> messageConverters)

Provide the converters to use in argument resolvers and return value handlers that support reading and/or writing to the body of the request and response.

setModelAndViewResolvers

public void setModelAndViewResolvers(@Nullable
                                     List<ModelAndViewResolver> modelAndViewResolvers)

Provide custom ModelAndViewResolvers.

Note: This method is available for backwards compatibility only. However, it is recommended to re-write a ModelAndViewResolver as HandlerMethodReturnValueHandler. An adapter between the two interfaces is not possible since the HandlerMethodReturnValueHandler.supportsReturnType(org.springframework.core.MethodParameter) method cannot be implemented. Hence ModelAndViewResolvers are limited to always being invoked at the end after all other return value handlers have been given a chance.

A HandlerMethodReturnValueHandler provides better access to the return type and controller method information and can be ordered freely relative to other return value handlers.

setParameterNameDiscoverer

public void setParameterNameDiscoverer(ParameterNameDiscoverer parameterNameDiscoverer)

Set the ParameterNameDiscoverer to use for resolving method parameter names if needed (e.g. for default attribute names).

Default is a DefaultParameterNameDiscoverer.

setReturnValueHandlers

public void setReturnValueHandlers(@Nullable
                                   List<HandlerMethodReturnValueHandler> returnValueHandlers)

Configure the complete list of supported return value types thus overriding handlers that would otherwise be configured by default.

setSessionAttributeStore

public void setSessionAttributeStore(SessionAttributeStore sessionAttributeStore)

Specify the strategy to store session attributes with. The default is DefaultSessionAttributeStore, storing session attributes in the HttpSession with the same attribute name as in the model.

setTaskExecutor

public void setTaskExecutor(AsyncTaskExecutor taskExecutor)

Set the default AsyncTaskExecutor to use when a controller method return a Callable. Controller methods can override this default on a per-request basis by returning an WebAsyncTask.

By default a SimpleAsyncTaskExecutor instance is used. It's recommended to change that default in production as the simple executor does not re-use threads.

setWebBindingInitializer

public void setWebBindingInitializer(@Nullable
                                     WebBindingInitializer webBindingInitializer)

Provide a WebBindingInitializer with "global" initialization to apply to every DataBinder instance.

createDataBinderFactory

protected InitBinderDataBinderFactory createDataBinderFactory(List<InvocableHandlerMethod> binderMethods)
                                                       throws Exception

Template method to create a new InitBinderDataBinderFactory instance.

The default implementation creates a PortletRequestDataBinderFactory. This can be overridden for custom ServletRequestDataBinder subclasses.

Parameters:

binderMethods - @InitBinder methods

Returns:

the InitBinderDataBinderFactory instance to use

Throws:

Exception - in case of invalid state or arguments

createInvocableHandlerMethod

protected PortletInvocableHandlerMethod createInvocableHandlerMethod(HandlerMethod handlerMethod)

Create a PortletInvocableHandlerMethod from the given HandlerMethod definition.

Parameters:

handlerMethod - the HandlerMethod definition

Returns:

the corresponding PortletInvocableHandlerMethod (or custom subclass thereof)

Since:

5.1

doHandle

protected ModelAndView doHandle(javax.portlet.PortletRequest request,
                                javax.portlet.PortletResponse response,
                                Object handler)
                         throws Exception

Throws:

Exception

doHandle

protected ModelAndView doHandle(javax.portlet.PortletRequest request,
                                javax.portlet.PortletResponse response,
                                HandlerMethod handlerMethod)
                         throws Exception

Throws:

Exception

getBeanFactory

@Nullable
protected ConfigurableBeanFactory getBeanFactory()

Return the owning factory of this bean instance, or null if none.

handleActionInternal

protected void handleActionInternal(javax.portlet.ActionRequest request,
                                    javax.portlet.ActionResponse response,
                                    Object handler)
                             throws Exception

Description copied from class: AbstractPortletHandlerMethodAdapter

Use the given handler method to handle the request.

Specified by:

handleActionInternal in class AbstractPortletHandlerMethodAdapter

Parameters:

request - current action request

response - current action response

handler - refers to an instance of a class with a method annotated with ActionMapping. Alternatively refers to an instance of HandlerMethod.

Throws:

Exception - in case of errors

handleEventInternal

protected void handleEventInternal(javax.portlet.EventRequest request,
                                   javax.portlet.EventResponse response,
                                   Object handler)
                            throws Exception

Description copied from class: AbstractPortletHandlerMethodAdapter

Use the given handler method to handle the request.

Specified by:

handleEventInternal in class AbstractPortletHandlerMethodAdapter

Parameters:

request - current action request

response - current action response

handler - refers to an instance of a class with a method annotated with EventMapping. Alternatively refers to an instance of HandlerMethod.

Throws:

Exception - in case of errors

handleRenderInternal

protected ModelAndView handleRenderInternal(javax.portlet.RenderRequest request,
                                            javax.portlet.RenderResponse response,
                                            Object handler)
                                     throws Exception

Description copied from class: AbstractPortletHandlerMethodAdapter

Use the given handler method to handle the request.

Specified by:

handleRenderInternal in class AbstractPortletHandlerMethodAdapter

Parameters:

request - current action request

response - current action response

handler - refers to an instance of a class with a method annotated with RenderMapping. Alternatively refers to an instance of HandlerMethod.

Returns:

a ModelAndView object with the name of the view and the required model data, or null if the request has been handled directly

Throws:

Exception - in case of errors

handleResourceInternal

protected ModelAndView handleResourceInternal(javax.portlet.ResourceRequest request,
                                              javax.portlet.ResourceResponse response,
                                              Object handler)
                                       throws Exception

Description copied from class: AbstractPortletHandlerMethodAdapter

Use the given handler method to handle the request.

Specified by:

handleResourceInternal in class AbstractPortletHandlerMethodAdapter

Parameters:

request - current action request

response - current action response

handler - refers to an instance of a class with a method annotated with ResourceMapping. Alternatively refers to an instance of HandlerMethod.

Returns:

a ModelAndView object with the name of the view and the required model data, or null if the request has been handled directly

Throws:

Exception - in case of errors

supportsInternal

protected boolean supportsInternal(Object handler)

Always return true since any method argument and return value type will be processed in some way. A method argument not recognized by any HandlerMethodArgumentResolver is interpreted as a request parameter if it is a simple type, or as a model attribute otherwise. A return value not recognized by any HandlerMethodReturnValueHandler will be interpreted as a model attribute.

Specified by:

supportsInternal in class AbstractPortletHandlerMethodAdapter

Parameters:

handler - refers to an instance of a class with a method annotated with ActionMapping, EventMapping, RenderMapping, or ResourceMapping. Alternatively refers to an instance of HandlerMethod.

Returns:

whether or not this adapter can adapt the given method