Package io.grpc.servlet

Class GrpcServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

io.grpc.servlet.GrpcServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/5066")
public class GrpcServlet
extends javax.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

Field Summary

Fields

Modifier and Type	Field	Description
private static long	serialVersionUID
private ServletAdapter	servletAdapter

Constructor Summary

Constructors

Constructor	Description
GrpcServlet(ServletAdapter servletAdapter)
GrpcServlet(java.util.List<? extends BindableService> bindableServices)	Instantiate the servlet serving the given list of gRPC services.

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doGet(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	doPost(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
private static ServletAdapter	loadServices(java.util.List<? extends BindableService> bindableServices)

Methods inherited from class javax.servlet.http.HttpServlet

doDelete, doHead, doOptions, doPut, doTrace, getLastModified, service, service

Methods inherited from class javax.servlet.GenericServlet

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

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

servletAdapter

private final ServletAdapter servletAdapter

Constructor Detail

GrpcServlet

GrpcServlet(ServletAdapter servletAdapter)

GrpcServlet

public GrpcServlet(java.util.List<? extends BindableService> bindableServices)

Instantiate the servlet serving the given list of gRPC services. ServerInterceptors can be added on each gRPC service by ServerInterceptors.intercept(BindableService, io.grpc.ServerInterceptor...)

Method Detail

loadServices

private static ServletAdapter loadServices(java.util.List<? extends BindableService> bindableServices)

doGet

protected final void doGet(javax.servlet.http.HttpServletRequest request,
                           javax.servlet.http.HttpServletResponse response)
                    throws java.io.IOException

Overrides:

doGet in class javax.servlet.http.HttpServlet

Throws:

java.io.IOException

doPost

protected final void doPost(javax.servlet.http.HttpServletRequest request,
                            javax.servlet.http.HttpServletResponse response)
                     throws java.io.IOException

Overrides:

doPost in class javax.servlet.http.HttpServlet

Throws:

java.io.IOException

destroy

public void destroy()

Specified by:

destroy in interface javax.servlet.Servlet

Overrides:

destroy in class javax.servlet.GenericServlet