Class DefaultServletHttpRequestHandler

java.lang.Object
org.springframework.web.servlet.resource.DefaultServletHttpRequestHandler
All Implemented Interfaces:
Aware, ServletContextAware, HttpRequestHandler
public class DefaultServletHttpRequestHandler extends Object implements HttpRequestHandler, ServletContextAware
An HttpRequestHandler for serving static files using the Servlet container's "default" Servlet.

This handler is intended to be used with a "/*" mapping when the DispatcherServlet is mapped to "/", thus overriding the Servlet container's default handling of static resources. The mapping to this handler should generally be ordered as the last in the chain so that it will only execute when no other more specific mappings (i.e., to controllers) can be matched.

Requests are handled by forwarding through the RequestDispatcher obtained via the name specified through the "defaultServletName" property. In most cases, the defaultServletName does not need to be set explicitly, as the handler checks at initialization time for the presence of the default Servlet of well-known containers such as Tomcat, Jetty, WebLogic and WebSphere. However, when running in a container where the default Servlet's name is not known, or where it has been customized via server configuration, the defaultServletName will need to be set explicitly.

Since:
3.0.4
Author:
Jeremy Grelle, Juergen Hoeller

  • Constructor Summary

    Constructors
    Constructor
    Description
    DefaultServletHttpRequestHandler()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    Process the given request, generating a response.
    void
    setDefaultServletName(String defaultServletName)
    Set the name of the default Servlet to be forwarded to for static resource requests.
    void
    setServletContext(jakarta.servlet.ServletContext servletContext)
    If the defaultServletName property has not been explicitly set, attempts to locate the default Servlet using the known common container-specific names.

    Methods inherited from class Object

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

  • Constructor Details

    • DefaultServletHttpRequestHandler

      public DefaultServletHttpRequestHandler()

  • Method Details

    • setDefaultServletName

      public void setDefaultServletName(String defaultServletName)
      Set the name of the default Servlet to be forwarded to for static resource requests.

    • setServletContext

      public void setServletContext(jakarta.servlet.ServletContext servletContext)
      If the defaultServletName property has not been explicitly set, attempts to locate the default Servlet using the known common container-specific names.
      Specified by:
      setServletContext in interface ServletContextAware
      Parameters:
      servletContext - the ServletContext object to be used by this object
      See Also:

    • handleRequest

      public void handleRequest(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws jakarta.servlet.ServletException, IOException
      Description copied from interface: HttpRequestHandler
      Process the given request, generating a response.
      Specified by:
      handleRequest in interface HttpRequestHandler
      Parameters:
      request - current HTTP request
      response - current HTTP response
      Throws:
      jakarta.servlet.ServletException - in case of general errors
      IOException - in case of I/O errors