ServerBuilder (grpc-api 1.44.0 API)

java.lang.Object
- io.grpc.ServerBuilder<T>

Type Parameters:

T - The concrete type of this builder.

Direct Known Subclasses:

ForwardingServerBuilder
```
public abstract class ServerBuilder<T extends ServerBuilder<T>>
extends Object
```
A builder for Server instances.

Since:

1.0.0

Constructor Summary

Constructors
Constructor and Description

ServerBuilder()

Constructors
Constructor and Description
`ServerBuilder()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`abstract T`	`addService(BindableService bindableService)` Adds a service implementation to the handler registry.
`abstract T`	`addService(ServerServiceDefinition service)` Adds a service implementation to the handler registry.
`T`	`addServices(List<ServerServiceDefinition> services)` Adds a list of service implementations to the handler registry together.
`T`	`addStreamTracerFactory(ServerStreamTracer.Factory factory)` Adds a `ServerStreamTracer.Factory` to measure server-side traffic.
`T`	`addTransportFilter(ServerTransportFilter filter)` Adds a `ServerTransportFilter`.
`abstract Server`	`build()` Builds a server using the given parameters.
`T`	`callExecutor(ServerCallExecutorSupplier executorSupplier)` Allows for defining a way to provide a custom executor to handle the server call.
`abstract T`	`compressorRegistry(CompressorRegistry registry)` Set the compression registry for use in the channel.
`abstract T`	`decompressorRegistry(DecompressorRegistry registry)` Set the decompression registry for use in the channel.
`abstract T`	`directExecutor()` Execute application code directly in the transport thread.
`abstract T`	`executor(Executor executor)` Provides a custom executor.
`abstract T`	`fallbackHandlerRegistry(HandlerRegistry fallbackRegistry)` Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry.
`static ServerBuilder<?>`	`forPort(int port)` Static factory for creating a new ServerBuilder.
`T`	`handshakeTimeout(long timeout, TimeUnit unit)` Sets the permitted time for new connections to complete negotiation handshakes before being killed.
`T`	`intercept(ServerInterceptor interceptor)` Adds a `ServerInterceptor` that is run for all services on the server.
`T`	`maxInboundMessageSize(int bytes)` Sets the maximum message size allowed to be received on the server.
`T`	`maxInboundMetadataSize(int bytes)` Sets the maximum size of metadata allowed to be received.
`T`	`setBinaryLog(BinaryLog binaryLog)` Sets the BinaryLog object that this server should log to.
`abstract T`	`useTransportSecurity(File certChain, File privateKey)` Makes the server use TLS.
`T`	`useTransportSecurity(InputStream certChain, InputStream privateKey)` Makes the server use TLS.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServerBuilder
```
public ServerBuilder()
```
- Method Detail
  - forPort
```
public static ServerBuilder<?> forPort(int port)
```
    Static factory for creating a new ServerBuilder.
    
    Parameters:
    
    port - the port to listen on
    
    Since:
    
    1.0.0
  - directExecutor
```
public abstract T directExecutor()
```
    Execute application code directly in the transport thread.
    Depending on the underlying transport, using a direct executor may lead to substantial performance improvements. However, it also requires the application to not block under any circumstances.
    Calling this method is semantically equivalent to calling executor(Executor) and passing in a direct executor. However, this is the preferred way as it may allow the transport to perform special optimizations.
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - executor
```
public abstract T executor(@Nullable
                           Executor executor)
```
    Provides a custom executor.
    It's an optional parameter. If the user has not provided an executor when the server is built, the builder will use a static cached thread pool.
    The server won't take ownership of the given executor. It's caller's responsibility to shut down the executor when it's desired.
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - callExecutor
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/8274")
public T callExecutor(ServerCallExecutorSupplier executorSupplier)
```
    Allows for defining a way to provide a custom executor to handle the server call. This executor is the result of calling ServerCallExecutorSupplier.getExecutor(ServerCall, Metadata) per RPC.
    It's an optional parameter. If it is provided, the executor(Executor) would still run necessary tasks before the ServerCallExecutorSupplier is ready to be called, then it switches over. But if calling ServerCallExecutorSupplier returns null, the server call is still handled by the default executor(Executor) as a fallback.
    
    Parameters:
    
    executorSupplier - the server call executor provider
    
    Returns:
    
    this
    
    Since:
    
    1.39.0
  - addService
```
public abstract T addService(ServerServiceDefinition service)
```
    Adds a service implementation to the handler registry.
    
    Parameters:
    
    service - ServerServiceDefinition object
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - addService
```
public abstract T addService(BindableService bindableService)
```
    Adds a service implementation to the handler registry.
    
    Parameters:
    
    bindableService - BindableService object
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - addServices
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/7925")
public final T addServices(List<ServerServiceDefinition> services)
```
    Adds a list of service implementations to the handler registry together.
    
    Parameters:
    
    services - the list of ServerServiceDefinition objects
    
    Returns:
    
    this
    
    Since:
    
    1.37.0
  - intercept
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/3117")
public T intercept(ServerInterceptor interceptor)
```
    Adds a ServerInterceptor that is run for all services on the server. Interceptors added through this method always run before per-service interceptors added through ServerInterceptors. Interceptors run in the reverse order in which they are added, just as with consecutive calls to ServerInterceptors.intercept().
    
    Parameters:
    
    interceptor - the all-service interceptor
    
    Returns:
    
    this
    
    Since:
    
    1.5.0
  - addTransportFilter
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/2132")
public T addTransportFilter(ServerTransportFilter filter)
```
    Adds a ServerTransportFilter. The order of filters being added is the order they will be executed.
    
    Returns:
    
    this
    
    Since:
    
    1.2.0
  - addStreamTracerFactory
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/2861")
public T addStreamTracerFactory(ServerStreamTracer.Factory factory)
```
    Adds a ServerStreamTracer.Factory to measure server-side traffic. The order of factories being added is the order they will be executed.
    
    Returns:
    
    this
    
    Since:
    
    1.3.0
  - fallbackHandlerRegistry
```
public abstract T fallbackHandlerRegistry(@Nullable
                                          HandlerRegistry fallbackRegistry)
```
    Sets a fallback handler registry that will be looked up in if a method is not found in the primary registry. The primary registry (configured via addService()) is faster but immutable. The fallback registry is more flexible and allows implementations to mutate over time and load services on-demand.
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - useTransportSecurity
```
public abstract T useTransportSecurity(File certChain,
                                       File privateKey)
```
    Makes the server use TLS.
    
    Parameters:
    
    certChain - file containing the full certificate chain
    
    privateKey - file containing the private key
    
    Returns:
    
    this
    
    Throws:
    
    UnsupportedOperationException - if the server does not support TLS.
    
    Since:
    
    1.0.0
  - useTransportSecurity
```
public T useTransportSecurity(InputStream certChain,
                              InputStream privateKey)
```
    Makes the server use TLS.
    
    Parameters:
    
    certChain - InputStream containing the full certificate chain
    
    privateKey - InputStream containing the private key
    
    Returns:
    
    this
    
    Throws:
    
    UnsupportedOperationException - if the server does not support TLS, or does not support reading these files from an InputStream.
    
    Since:
    
    1.12.0
  - decompressorRegistry
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public abstract T decompressorRegistry(@Nullable
                                                                                                               DecompressorRegistry registry)
```
    Set the decompression registry for use in the channel. This is an advanced API call and shouldn't be used unless you are using custom message encoding. The default supported decompressors are in DecompressorRegistry.getDefaultInstance.
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - compressorRegistry
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1704")
public abstract T compressorRegistry(@Nullable
                                                                                                             CompressorRegistry registry)
```
    Set the compression registry for use in the channel. This is an advanced API call and shouldn't be used unless you are using custom message encoding. The default supported compressors are in CompressorRegistry.getDefaultInstance.
    
    Returns:
    
    this
    
    Since:
    
    1.0.0
  - handshakeTimeout
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/3706")
public T handshakeTimeout(long timeout,
                                                                                                  TimeUnit unit)
```
    Sets the permitted time for new connections to complete negotiation handshakes before being killed.
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if timeout is negative
    
    UnsupportedOperationException - if unsupported
    
    Since:
    
    1.8.0
  - maxInboundMessageSize
```
public T maxInboundMessageSize(int bytes)
```
    Sets the maximum message size allowed to be received on the server. If not called, defaults to 4 MiB. The default provides protection to servers who haven't considered the possibility of receiving large messages while trying to be large enough to not be hit in normal usage.
    This method is advisory, and implementations may decide to not enforce this. Currently, the only known transport to not enforce this is InProcessServer.
    
    Parameters:
    
    bytes - the maximum number of bytes a single message can be.
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if bytes is negative.
    
    UnsupportedOperationException - if unsupported.
    
    Since:
    
    1.13.0
  - maxInboundMetadataSize
```
public T maxInboundMetadataSize(int bytes)
```
    Sets the maximum size of metadata allowed to be received. Integer.MAX_VALUE disables the enforcement. The default is implementation-dependent, but is not generally less than 8 KiB and may be unlimited.
    This is cumulative size of the metadata. The precise calculation is implementation-dependent, but implementations are encouraged to follow the calculation used for HTTP/2's SETTINGS_MAX_HEADER_LIST_SIZE. It sums the bytes from each entry's key and value, plus 32 bytes of overhead per entry.
    
    Parameters:
    
    bytes - the maximum size of received metadata
    
    Returns:
    
    this
    
    Throws:
    
    IllegalArgumentException - if bytes is non-positive
    
    Since:
    
    1.17.0
  - setBinaryLog
```
@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/4017")
public T setBinaryLog(BinaryLog binaryLog)
```
    Sets the BinaryLog object that this server should log to. The server does not take ownership of the object, and users are responsible for calling Closeable.close().
    
    Parameters:
    
    binaryLog - the object to provide logging.
    
    Returns:
    
    this
    
    Since:
    
    1.13.0
  - build
```
public abstract Server build()
```
    Builds a server using the given parameters.
    The returned service will not been started or be bound a port. You will need to start it with Server.start().
    
    Returns:
    
    a new Server
    
    Since:
    
    1.0.0

Class ServerBuilder<T extends ServerBuilder<T>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServerBuilder

Method Detail

forPort

directExecutor

executor

callExecutor

addService

addService

addServices

intercept

addTransportFilter

addStreamTracerFactory

fallbackHandlerRegistry

useTransportSecurity

useTransportSecurity

decompressorRegistry

compressorRegistry

handshakeTimeout

maxInboundMessageSize

maxInboundMetadataSize

setBinaryLog

build