Top Description Constructors Methods
org.springframework.web.servlet.handler

public Class SimpleServletHandlerAdapter

extends Object
implements HandlerAdapter
Class Inheritance
All Implemented Interfaces
org.springframework.web.servlet.HandlerAdapter
Imports
jakarta.servlet.Servlet, jakarta.servlet.http.HttpServletRequest, .HttpServletResponse, org.springframework.lang.Nullable, org.springframework.web.servlet.HandlerAdapter, .ModelAndView
Adapter to use the Servlet interface with the generic DispatcherServlet. Calls the Servlet's service method to handle a request.

Last-modified checking is not explicitly supported: This is typically handled by the Servlet implementation itself (usually deriving from the HttpServlet base class).

This adapter is not activated by default; it needs to be defined as a bean in the DispatcherServlet context. It will automatically apply to mapped handler beans that implement the Servlet interface then.

Note that Servlet instances defined as bean will not receive initialization and destruction callbacks, unless a special post-processor such as SimpleServletPostProcessor is defined in the DispatcherServlet context.

Alternatively, consider wrapping a Servlet with Spring's ServletWrappingController. This is particularly appropriate for existing Servlet classes, allowing to specify Servlet initialization parameters etc.

Author
Juergen Hoeller
Since
1.1.5
See Also
jakarta.servlet.Servlet, jakarta.servlet.http.HttpServlet, SimpleServletPostProcessor, org.springframework.web.servlet.mvc.ServletWrappingController

Constructor Summary

AccessConstructor and Description
public
SimpleServletHandlerAdapter()

Method Summary

Modifier and TypeMethod and Description
public long
getLastModified(HttpServletRequest
current HTTP request
request, Object
the handler to use
handler)

Implements org.springframework.web.servlet.HandlerAdapter.getLastModified.

Same contract as for HttpServlet's getLastModified method.

public ModelAndView
handle(HttpServletRequest
current HTTP request
request, HttpServletResponse
current HTTP response
response, Object
the handler to use. This object must have previously been passed to the supports method of this interface, which must have returned true.
handler)

Implements org.springframework.web.servlet.HandlerAdapter.handle.

Use the given handler to handle this request.

public boolean
supports(Object
the handler object to check
handler)

Implements org.springframework.web.servlet.HandlerAdapter.supports.

Given a handler instance, return whether this HandlerAdapter can support it.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

SimpleServletHandlerAdapterback to summary
public SimpleServletHandlerAdapter()

Method Detail

getLastModifiedback to summary
public long getLastModified(HttpServletRequest request, Object handler)

Implements org.springframework.web.servlet.HandlerAdapter.getLastModified.

Doc from org.springframework.web.servlet.HandlerAdapter.getLastModified.

Same contract as for HttpServlet's getLastModified method. Can simply return -1 if there's no support in the handler class.

Parameters
request:HttpServletRequest

current HTTP request

handler:Object

the handler to use

Returns:long

the lastModified value for the given handler

Annotations
@Override
@SuppressWarnings:deprecation
handleback to summary
public ModelAndView handle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception

Implements org.springframework.web.servlet.HandlerAdapter.handle.

Doc from org.springframework.web.servlet.HandlerAdapter.handle.

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

Parameters
request:HttpServletRequest

current HTTP request

response:HttpServletResponse

current HTTP response

handler:Object

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

Returns:ModelAndView

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

Annotations
@Override
@Nullable
Exceptions
Exception:
in case of errors
supportsback to summary
public boolean supports(Object handler)

Implements org.springframework.web.servlet.HandlerAdapter.supports.

Doc from org.springframework.web.servlet.HandlerAdapter.supports.

Given a handler instance, return whether 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);

Parameters
handler:Object

the handler object to check

Returns:boolean

whether this object can use the given handler

Annotations
@Override