Class GrpcServlet

  • All Implemented Interfaces:
    jakarta.servlet.Servlet, jakarta.servlet.ServletConfig, Serializable

    @ExperimentalApi("https://github.com/grpc/grpc-java/issues/5066")
    public class GrpcServlet
    extends jakarta.servlet.http.HttpServlet
    A simple servlet backed by a gRPC server. Must set asyncSupported to true. The /contextRoot/urlPattern must match the gRPC services' path, which is "/full-service-name/short-method-name".

    The API is experimental. The authors would like to know more about the real usecases. Users are welcome to provide feedback by commenting on the tracking issue.

    See Also:
    Serialized Form
    • Constructor Summary

      Constructors 
      Constructor Description
      GrpcServlet​(List<? extends BindableService> bindableServices)
      Instantiate the servlet serving the given list of gRPC services.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void destroy()  
      protected void doGet​(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)  
      protected void doPost​(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)  
      • Methods inherited from class jakarta.servlet.http.HttpServlet

        doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service
      • Methods inherited from class jakarta.servlet.GenericServlet

        getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, init, log, log
    • Method Detail

      • doGet

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

        protected final void doPost​(jakarta.servlet.http.HttpServletRequest request,
                                    jakarta.servlet.http.HttpServletResponse response)
                             throws IOException
        Overrides:
        doPost in class jakarta.servlet.http.HttpServlet
        Throws:
        IOException
      • destroy

        public void destroy()
        Specified by:
        destroy in interface jakarta.servlet.Servlet
        Overrides:
        destroy in class jakarta.servlet.GenericServlet