io.grpc

Class ForwardingServerBuilder<T extends ForwardingServerBuilder<T>>

java.lang.Object

io.grpc.ServerBuilder<T>

io.grpc.ForwardingServerBuilder<T>

Type Parameters:

T - The type of the subclass extending this abstract class.

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/7393")
public abstract class ForwardingServerBuilder<T extends ForwardingServerBuilder<T>>
extends ServerBuilder<T>

A ServerBuilder that delegates all its builder method to another builder by default.

Since:

1.33.0

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ForwardingServerBuilder() The default constructor.

Method Summary

Modifier and Type	Method and Description
T	addService(BindableService bindableService) Adds a service implementation to the handler registry.
T	addService(ServerServiceDefinition service) Adds a service implementation to the handler registry.
T	addStreamTracerFactory(ServerStreamTracer.Factory factory) Adds a ServerStreamTracer.Factory to measure server-side traffic.
T	addTransportFilter(ServerTransportFilter filter) Adds a ServerTransportFilter.
Server	build() Returns the Server built by the delegate by default.
T	compressorRegistry(CompressorRegistry registry) Set the compression registry for use in the channel.
T	decompressorRegistry(DecompressorRegistry registry) Set the decompression registry for use in the channel.
protected abstract ServerBuilder<?>	delegate() Returns the delegated ServerBuilder.
T	directExecutor() Execute application code directly in the transport thread.
T	executor(Executor executor) Provides a custom executor.
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) This method serves to force sub classes to "hide" this static factory.
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.
protected T	thisT() Returns the correctly typed version of the builder.
String	toString()
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, wait, wait, wait

Constructor Detail

ForwardingServerBuilder

protected ForwardingServerBuilder()

The default constructor.

Method Detail

forPort

public static ServerBuilder<?> forPort(int port)

This method serves to force sub classes to "hide" this static factory.

delegate

protected abstract ServerBuilder<?> delegate()

Returns the delegated ServerBuilder.

directExecutor

public T directExecutor()

Description copied from class: ServerBuilder

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 ServerBuilder.executor(Executor) and passing in a direct executor. However, this is the preferred way as it may allow the transport to perform special optimizations.

Specified by:

directExecutor in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

executor

public T executor(@Nullable
                  Executor executor)

Description copied from class: ServerBuilder

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.

Specified by:

executor in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

addService

public T addService(ServerServiceDefinition service)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry.

Specified by:

addService in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

service - ServerServiceDefinition object

Returns:

this

addService

public T addService(BindableService bindableService)

Description copied from class: ServerBuilder

Adds a service implementation to the handler registry.

Specified by:

addService in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

bindableService - BindableService object

Returns:

this

intercept

public T intercept(ServerInterceptor interceptor)

Description copied from class: ServerBuilder

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().

Overrides:

intercept in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

interceptor - the all-service interceptor

Returns:

this

addTransportFilter

public T addTransportFilter(ServerTransportFilter filter)

Description copied from class: ServerBuilder

Adds a ServerTransportFilter. The order of filters being added is the order they will be executed.

Overrides:

addTransportFilter in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

addStreamTracerFactory

public T addStreamTracerFactory(ServerStreamTracer.Factory factory)

Description copied from class: ServerBuilder

Adds a ServerStreamTracer.Factory to measure server-side traffic. The order of factories being added is the order they will be executed.

Overrides:

addStreamTracerFactory in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

fallbackHandlerRegistry

public T fallbackHandlerRegistry(@Nullable
                                 HandlerRegistry fallbackRegistry)

Description copied from class: ServerBuilder

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.

Specified by:

fallbackHandlerRegistry in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

useTransportSecurity

public T useTransportSecurity(File certChain,
                              File privateKey)

Description copied from class: ServerBuilder

Makes the server use TLS.

Specified by:

useTransportSecurity in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

certChain - file containing the full certificate chain

privateKey - file containing the private key

Returns:

this

useTransportSecurity

public T useTransportSecurity(InputStream certChain,
                              InputStream privateKey)

Description copied from class: ServerBuilder

Makes the server use TLS.

Overrides:

useTransportSecurity in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

certChain - InputStream containing the full certificate chain

privateKey - InputStream containing the private key

Returns:

this

decompressorRegistry

public T decompressorRegistry(@Nullable
                              DecompressorRegistry registry)

Description copied from class: ServerBuilder

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.

Specified by:

decompressorRegistry in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

compressorRegistry

public T compressorRegistry(@Nullable
                            CompressorRegistry registry)

Description copied from class: ServerBuilder

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.

Specified by:

compressorRegistry in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

handshakeTimeout

public T handshakeTimeout(long timeout,
                          TimeUnit unit)

Description copied from class: ServerBuilder

Sets the permitted time for new connections to complete negotiation handshakes before being killed.

Overrides:

handshakeTimeout in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

this

maxInboundMessageSize

public T maxInboundMessageSize(int bytes)

Description copied from class: ServerBuilder

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.

Overrides:

maxInboundMessageSize in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

bytes - the maximum number of bytes a single message can be.

Returns:

this

maxInboundMetadataSize

public T maxInboundMetadataSize(int bytes)

Description copied from class: ServerBuilder

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.

Overrides:

maxInboundMetadataSize in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

bytes - the maximum size of received metadata

Returns:

this

setBinaryLog

public T setBinaryLog(BinaryLog binaryLog)

Description copied from class: ServerBuilder

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().

Overrides:

setBinaryLog in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Parameters:

binaryLog - the object to provide logging.

Returns:

this

build

public Server build()

Returns the Server built by the delegate by default. Overriding method can return different value.

Specified by:

build in class ServerBuilder<T extends ForwardingServerBuilder<T>>

Returns:

a new Server

toString

public String toString()

Overrides:

toString in class Object

thisT

protected final T thisT()

Returns the correctly typed version of the builder.