Package io.grpc.servlet

Class ServletServerBuilder

  • @ExperimentalApi("https://github.com/grpc/grpc-java/issues/5066")
@NotThreadSafe
public final class ServletServerBuilder
extends io.grpc.ForwardingServerBuilder<ServletServerBuilder>
    Builder to build a gRPC server that can run as a servlet. This is for advanced custom settings. Normally, users should consider extending the out-of-box GrpcServlet directly instead.

    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.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      io.grpc.Server build()
      Builds a gRPC server that can run as a servlet.
      ServletAdapter buildServletAdapter()
      Creates a ServletAdapter.
      protected io.grpc.ServerBuilder<?> delegate()  
      ServletServerBuilder maxInboundMessageSize​(int bytes)  
      ServletServerBuilder scheduledExecutorService​(java.util.concurrent.ScheduledExecutorService scheduler)
      Provides a custom scheduled executor service to the server builder.
      ServletServerBuilder useTransportSecurity​(java.io.File certChain, java.io.File privateKey)
      Throws UnsupportedOperationException.

      • Methods inherited from class io.grpc.ForwardingServerBuilder

        addService, addService, addStreamTracerFactory, addTransportFilter, callExecutor, compressorRegistry, decompressorRegistry, directExecutor, executor, fallbackHandlerRegistry, forPort, handshakeTimeout, intercept, keepAliveTime, keepAliveTimeout, maxConnectionAge, maxConnectionAgeGrace, maxConnectionIdle, maxInboundMetadataSize, permitKeepAliveTime, permitKeepAliveWithoutCalls, setBinaryLog, toString, useTransportSecurity

      • Methods inherited from class io.grpc.ServerBuilder

        addServices

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • ServletServerBuilder

        public ServletServerBuilder()

    • Method Detail

      • build

        public io.grpc.Server build()
        Builds a gRPC server that can run as a servlet.

        The returned server will not be started or bound to a port.

        Users should not call this method directly. Instead users should call buildServletAdapter() which internally will call build() and start() appropriately.

        Overrides:
        build in class io.grpc.ForwardingServerBuilder<ServletServerBuilder>
        Throws:
        java.lang.IllegalStateException - if this method is called by users directly

      • delegate

        @Internal
protected io.grpc.ServerBuilder<?> delegate()
        Specified by:
        delegate in class io.grpc.ForwardingServerBuilder<ServletServerBuilder>

      • useTransportSecurity

        public ServletServerBuilder useTransportSecurity​(java.io.File certChain,
                                                 java.io.File privateKey)
        Throws UnsupportedOperationException. TLS should be configured by the servlet container.
        Overrides:
        useTransportSecurity in class io.grpc.ForwardingServerBuilder<ServletServerBuilder>

      • scheduledExecutorService

        public ServletServerBuilder scheduledExecutorService​(java.util.concurrent.ScheduledExecutorService scheduler)
        Provides a custom scheduled executor service to the server builder.
        Returns:
        this