Class HandlerFunctionAdapter
- java.lang.Object
- org.springframework.web.servlet.function.support.HandlerFunctionAdapter
- All Implemented Interfaces:
Ordered
,HandlerAdapter
public class HandlerFunctionAdapter extends Object implements HandlerAdapter, Ordered
HandlerAdapter
implementation that supportsHandlerFunction
s.- Since:
- 5.2
- Author:
- Arjen Poutsma
Field Summary
Fields inherited from interface org.springframework.core.Ordered
HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE
Constructor Summary
Constructors Constructor Description HandlerFunctionAdapter()
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description long
getLastModified(HttpServletRequest request, Object handler)
Same contract as for HttpServlet'sgetLastModified
method.int
getOrder()
Get the order value of this object.ModelAndView
handle(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Object handler)
Use the given handler to handle this 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 thisHandlerAdapter
can support it.
Constructor Detail
HandlerFunctionAdapter
public HandlerFunctionAdapter()
Method Detail
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 interfaceOrdered
- Returns:
- the order value
- See Also:
Ordered.HIGHEST_PRECEDENCE
,Ordered.LOWEST_PRECEDENCE
supports
public boolean supports(Object handler)
Description copied from interface:HandlerAdapter
Given a handler instance, return whether or not thisHandlerAdapter
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 interfaceHandlerAdapter
- Parameters:
handler
- the handler object to check- Returns:
- whether or not this object can use the given handler
handle
@Nullable public ModelAndView handle(HttpServletRequest servletRequest, HttpServletResponse servletResponse, Object handler) throws Exception
Description copied from interface:HandlerAdapter
Use the given handler to handle this request. The workflow that is required may vary widely.- Specified by:
handle
in interfaceHandlerAdapter
- Parameters:
servletRequest
- current HTTP requestservletResponse
- current HTTP responsehandler
- the handler to use. This object must have previously been passed to thesupports
method of this interface, which must have returnedtrue
.- 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
getLastModified
public long getLastModified(HttpServletRequest request, Object handler)
Description copied from interface:HandlerAdapter
Same contract as for HttpServlet'sgetLastModified
method. Can simply return -1 if there's no support in the handler class.- Specified by:
getLastModified
in interfaceHandlerAdapter
- Parameters:
request
- current HTTP requesthandler
- the handler to use- Returns:
- the lastModified value for the given handler
- See Also:
HttpServlet.getLastModified(javax.servlet.http.HttpServletRequest)
,LastModified.getLastModified(javax.servlet.http.HttpServletRequest)