Class AbstractHandlerMethodAdapter

java.lang.Object

org.springframework.context.support.ApplicationObjectSupport

org.springframework.web.context.support.WebApplicationObjectSupport

org.springframework.web.servlet.support.WebContentGenerator

org.springframework.web.servlet.mvc.method.AbstractHandlerMethodAdapter

All Implemented Interfaces:

Aware, ApplicationContextAware, Ordered, ServletContextAware, HandlerAdapter

Direct Known Subclasses:

RequestMappingHandlerAdapter

public abstract class AbstractHandlerMethodAdapter
extends WebContentGenerator
implements HandlerAdapter, Ordered

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

Since:

3.1

Author:

Arjen Poutsma

Field Summary

Fields inherited from class WebContentGenerator

HEADER_CACHE_CONTROL, METHOD_GET, METHOD_HEAD, METHOD_POST

Fields inherited from class ApplicationObjectSupport

logger

Fields inherited from interface Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
AbstractHandlerMethodAdapter()

Method Summary

Modifier and Type	Method	Description
int	getOrder()	Get the order value of this object.
final @Nullable ModelAndView	handle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, Object handler)	This implementation expects the handler to be an HandlerMethod.
protected abstract @Nullable ModelAndView	handleInternal(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, HandlerMethod handlerMethod)	Use the given handler method to handle the request.
void	setOrder(int order)	Specify the order value for this HandlerAdapter bean.
final boolean	supports(Object handler)	This implementation expects the handler to be an HandlerMethod.
protected abstract boolean	supportsInternal(HandlerMethod handlerMethod)	Given a handler method, return whether this adapter can support it.

Methods inherited from class WebContentGenerator

applyCacheControl, applyCacheSeconds, checkRequest, getAllowHeader, getCacheControl, getCacheSeconds, getSupportedMethods, getVaryByRequestHeaders, isRequireSession, prepareResponse, setCacheControl, setCacheSeconds, setRequireSession, setSupportedMethods, setVaryByRequestHeaders

Methods inherited from class WebApplicationObjectSupport

getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

Methods inherited from class ApplicationObjectSupport

getApplicationContext, getMessageSourceAccessor, initApplicationContext, obtainApplicationContext, requiredContextClass, setApplicationContext

Methods inherited from class Object

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

Constructor Details

AbstractHandlerMethodAdapter

public AbstractHandlerMethodAdapter()

Method Details

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()

getOrder

public int getOrder()

Description copied from interface: Ordered

Get the order value of this object.

Higher values are interpreted as lower priority. As a consequence, the object with the lowest value has the highest priority (somewhat analogous to Servlet load-on-startup values).

Same order values will result in arbitrary sort positions for the affected objects.

Specified by:

getOrder in interface Ordered

Returns:

the order value

See Also:

• Ordered.HIGHEST_PRECEDENCE
• Ordered.LOWEST_PRECEDENCE

supports

public final boolean supports(Object handler)

This implementation expects the handler to be an HandlerMethod.

Specified by:

supports in interface HandlerAdapter

Parameters:

handler - the handler instance to check

Returns:

whether this adapter can adapt the given handler

supportsInternal

protected abstract boolean supportsInternal(HandlerMethod handlerMethod)

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

Parameters:

handlerMethod - the handler method to check

Returns:

whether this adapter can adapt the given method

handle

public final @Nullable ModelAndView handle(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 Object handler)
                                    throws Exception

This implementation expects the handler to be an HandlerMethod.

Specified by:

handle in interface HandlerAdapter

Parameters:

request - current HTTP request

response - current HTTP response

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

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

handleInternal

protected abstract @Nullable ModelAndView handleInternal(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 HandlerMethod handlerMethod)
                                                  throws Exception

Use the given handler method to handle the request.

Parameters:

request - current HTTP request

response - current HTTP response

handlerMethod - handler method to use. This object must have previously been passed to the supportsInternal(HandlerMethod) this interface, which must have returned true.

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