Package io.github.grumpystuff.grumpyrest.servlet

Class RestServlet

java.lang.Object
jakarta.servlet.GenericServlet
jakarta.servlet.http.HttpServlet
io.github.grumpystuff.grumpyrest.servlet.RestServlet
All Implemented Interfaces:
jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable
public class RestServlet extends jakarta.servlet.http.HttpServlet
Java servlet that serves a REST API defined by a RestApi object.
See Also:

  • Field Summary

    Fields inherited from class jakarta.servlet.http.HttpServlet

    LEGACY_DO_HEAD

  • Constructor Summary

    Constructors
    Constructor
    Description
    RestServlet(RestApi api, RequestPathSourcingStrategy requestPathSourcingStrategy)
    Constructor.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected void
    doDelete(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
     
    protected void
    doGet(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
     
    protected void
    doPost(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
     
    protected void
    doPut(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
     

    Methods inherited from class jakarta.servlet.http.HttpServlet

    doHead, doOptions, doTrace, getLastModified, init, 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

    • RestServlet

      public RestServlet(RestApi api, RequestPathSourcingStrategy requestPathSourcingStrategy)
      Constructor.
      Parameters:
      api - the API definition
      requestPathSourcingStrategy - how to determine the request path from the servlet request object

  • Method Details

    • doGet

      protected void doGet(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
      Overrides:
      doGet in class jakarta.servlet.http.HttpServlet

    • doPut

      protected void doPut(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
      Overrides:
      doPut in class jakarta.servlet.http.HttpServlet

    • doPost

      protected void doPost(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
      Overrides:
      doPost in class jakarta.servlet.http.HttpServlet

    • doDelete

      protected void doDelete(jakarta.servlet.http.HttpServletRequest servletRequest, jakarta.servlet.http.HttpServletResponse servletResponse)
      Overrides:
      doDelete in class jakarta.servlet.http.HttpServlet