com.liferay.portletmvc4spring.mvc.method

Class AbstractPortletHandlerMethodAdapter

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

com.liferay.portletmvc4spring.context.PortletApplicationObjectSupport

com.liferay.portletmvc4spring.handler.PortletContentGenerator

com.liferay.portletmvc4spring.mvc.method.AbstractPortletHandlerMethodAdapter

All Implemented Interfaces:

PortletContextAware, HandlerAdapter, Aware, ApplicationContextAware, Ordered

Direct Known Subclasses:

PortletRequestMappingHandlerAdapter

public abstract class AbstractPortletHandlerMethodAdapter
extends PortletContentGenerator
implements HandlerAdapter, Ordered

Abstract base class for HandlerAdapter implementations that support handlers of type HandlerMethod.

Since:

5.1

Author:

Arjen Poutsma, Neil Griffin

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

Method Summary

Modifier and Type	Method and Description
int	getOrder()
void	handleAction(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, Object handler) Use the given handler to handle this action request.
protected abstract void	handleActionInternal(javax.portlet.ActionRequest request, javax.portlet.ActionResponse response, Object handler) Use the given handler method to handle the request.
void	handleEvent(javax.portlet.EventRequest request, javax.portlet.EventResponse response, Object handler) Use the given handler to handle this event request.
protected abstract void	handleEventInternal(javax.portlet.EventRequest request, javax.portlet.EventResponse response, Object handler) Use the given handler method to handle the request.
ModelAndView	handleRender(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, Object handler) Use the given handler to handle this render request.
protected abstract ModelAndView	handleRenderInternal(javax.portlet.RenderRequest request, javax.portlet.RenderResponse response, Object handler) Use the given handler method to handle the request.
ModelAndView	handleResource(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, Object handler) Use the given handler to handle this resource request.
protected abstract ModelAndView	handleResourceInternal(javax.portlet.ResourceRequest request, javax.portlet.ResourceResponse response, Object handler) Use the given handler method to handle the request.
void	setOrder(int order) Specify the order value for this HandlerAdapter bean.
boolean	supports(Object handler) Given a handler instance, return whether or not this HandlerAdapter can support it.
protected abstract boolean	supportsInternal(Object handler) Given a handler method, return whether or not this adapter can support it.

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

Constructor Detail

AbstractPortletHandlerMethodAdapter

public AbstractPortletHandlerMethodAdapter()

Method Detail

getOrder

public int getOrder()

Specified by:

getOrder in interface Ordered

handleAction

public void handleAction(javax.portlet.ActionRequest request,
                         javax.portlet.ActionResponse response,
                         Object handler)
                  throws Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this action request. The workflow that is required may vary widely.

Specified by:

handleAction in interface HandlerAdapter

Parameters:

request - current action request

response - current action response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Throws:

Exception - in case of errors

See Also:

Portlet.processAction(javax.portlet.ActionRequest, javax.portlet.ActionResponse)

handleEvent

public void handleEvent(javax.portlet.EventRequest request,
                        javax.portlet.EventResponse response,
                        Object handler)
                 throws Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this event request. The workflow that is required may vary widely.

Specified by:

handleEvent in interface HandlerAdapter

Parameters:

request - current action request

response - current action response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Throws:

Exception - in case of errors

See Also:

EventPortlet.processEvent(javax.portlet.EventRequest, javax.portlet.EventResponse)

handleRender

public ModelAndView handleRender(javax.portlet.RenderRequest request,
                                 javax.portlet.RenderResponse response,
                                 Object handler)
                          throws Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this render request. The workflow that is required may vary widely.

Specified by:

handleRender in interface HandlerAdapter

Parameters:

request - current render request

response - current render response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Returns:

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

See Also:

Portlet.render(javax.portlet.RenderRequest, javax.portlet.RenderResponse)

handleResource

public ModelAndView handleResource(javax.portlet.ResourceRequest request,
                                   javax.portlet.ResourceResponse response,
                                   Object handler)
                            throws Exception

Description copied from interface: HandlerAdapter

Use the given handler to handle this resource request. The workflow that is required may vary widely.

Specified by:

handleResource in interface HandlerAdapter

Parameters:

request - current render request

response - current render response

handler - handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.

Returns:

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

See Also:

ResourceServingPortlet.serveResource(javax.portlet.ResourceRequest, javax.portlet.ResourceResponse)

setOrder

public void setOrder(int order)

Specify the order value for this HandlerAdapter bean.

The default value is Ordered.LOWEST_PRECEDENCE, meaning non-ordered.

See Also:

Ordered.getOrder()

supports

public final boolean supports(Object handler)

Description copied from interface: HandlerAdapter

Given a handler instance, return whether or not this HandlerAdapter can support it. Typical HandlerAdapters will base the decision on the handler type. HandlerAdapters will usually only support one handler type each.

A typical implementation:

return (handler instanceof MyHandler);

Specified by:

supports in interface HandlerAdapter

Parameters:

handler - the handler instance to check

Returns:

whether or not this adapter can adapt the given handler

handleActionInternal

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

Use the given handler method to handle the request.

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 abstract void handleEventInternal(javax.portlet.EventRequest request,
                                            javax.portlet.EventResponse response,
                                            Object handler)
                                     throws Exception

Use the given handler method to handle the request.

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 abstract ModelAndView handleRenderInternal(javax.portlet.RenderRequest request,
                                                     javax.portlet.RenderResponse response,
                                                     Object handler)
                                              throws Exception

Use the given handler method to handle the request.

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 abstract ModelAndView handleResourceInternal(javax.portlet.ResourceRequest request,
                                                       javax.portlet.ResourceResponse response,
                                                       Object handler)
                                                throws Exception

Use the given handler method to handle the request.

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 abstract boolean supportsInternal(Object handler)

Given a handler method, return whether or not this adapter can support it.

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