Package alpine.server.servlets

Class StaticResourceServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
alpine.server.servlets.StaticResourceServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
Direct Known Subclasses:
FileSystemResourceServlet
public abstract class StaticResourceServlet extends jakarta.servlet.http.HttpServlet
The StaticResourceServlet provides a foundation in which to serve static resources similar to a conventional web server. This class is designed to be extended to provide specific functionality. Adapted from http://stackoverflow.com/questions/132052/servlet-for-serving-static-content
Since:
1.2.0
Author:
Steve Springett
See Also:

  • Field Summary

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    StaticResourceServlet()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    protected void
    doHead(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
     
    protected abstract alpine.server.servlets.StaticResource
    getStaticResource(jakarta.servlet.http.HttpServletRequest request)
    Returns the static resource associated with the given HTTP servlet request.

    Methods inherited from class jakarta.servlet.http.HttpServlet

    doDelete, doOptions, doPatch, doPost, doPut, doTrace, getLastModified, init, isSensitiveHeader, service, service

    Methods inherited from class jakarta.servlet.GenericServlet

    destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • StaticResourceServlet

      public StaticResourceServlet()

  • Method Details

    • doHead

      protected void doHead(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws jakarta.servlet.ServletException, IOException
      Overrides:
      doHead in class jakarta.servlet.http.HttpServlet
      Throws:
      jakarta.servlet.ServletException
      IOException

    • doGet

      protected void doGet(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response) throws jakarta.servlet.ServletException, IOException
      Overrides:
      doGet in class jakarta.servlet.http.HttpServlet
      Throws:
      jakarta.servlet.ServletException
      IOException

    • getStaticResource

      protected abstract alpine.server.servlets.StaticResource getStaticResource(jakarta.servlet.http.HttpServletRequest request) throws IllegalArgumentException
      Returns the static resource associated with the given HTTP servlet request. This returns null when the resource does actually not exist. The servlet will then return a HTTP 404 error.
      Parameters:
      request - The involved HTTP servlet request.
      Returns:
      The static resource associated with the given HTTP servlet request.
      Throws:
      IllegalArgumentException - When the request is mangled in such way that it's not recognizable as a valid static resource request. The servlet will then return a HTTP 400 error.