io.micronaut.grpc.server

Class GrpcServerConfiguration

java.lang.Object

io.micronaut.grpc.server.GrpcServerConfiguration

@ConfigurationProperties(value="grpc.server")
public class GrpcServerConfiguration
extends java.lang.Object

Configuration for the GRPC server.

Since:

1.0

Author:

graemerocher

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PORT
static java.lang.String	HOST
static java.lang.String	PORT
static java.lang.String	PREFIX
protected io.grpc.netty.NettyServerBuilder	serverBuilder

Constructor Summary

Constructors

Constructor and Description
GrpcServerConfiguration(io.micronaut.context.env.Environment environment, java.lang.String serverHost, java.lang.Integer serverPort, java.util.concurrent.ExecutorService executorService)

Method Summary

Modifier and Type	Method and Description
io.grpc.ServerBuilder<?>	getServerBuilder() The server builder.
GrpcSslConfiguration	getServerConfiguration() The SSL configuration.
java.util.Optional<java.lang.String>	getServerHost() The server host.
int	getServerPort() The server port.
boolean	isSecure() Whether SSL is used.
void	setMaxInboundMessageSize(int bytes) Sets the maximum message size allowed to be received on the server.
void	setMaxInboundMetadataSize(int bytes) Sets the maximum size of metadata allowed to be received.
void	setServerConfiguration(GrpcSslConfiguration sslConfiguration) Sets the SSL configuration.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

PORT

public static final java.lang.String PORT

See Also:

Constant Field Values

HOST

public static final java.lang.String HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

serverBuilder

@ConfigurationBuilder(prefixes="")
protected final io.grpc.netty.NettyServerBuilder serverBuilder

Constructor Detail

GrpcServerConfiguration

public GrpcServerConfiguration(io.micronaut.context.env.Environment environment,
                               @Property(name="grpc.server.host") @Nullable
                               java.lang.String serverHost,
                               @Property(name="grpc.server.port") @Nullable
                               java.lang.Integer serverPort,
                               @Named(value="io")
                               java.util.concurrent.ExecutorService executorService)

Method Detail

isSecure

public boolean isSecure()

Whether SSL is used.

Returns:

True if SSL is used

getServerBuilder

@Nonnull
public io.grpc.ServerBuilder<?> getServerBuilder()

The server builder.

Returns:

The ServerBuilder

getServerHost

public java.util.Optional<java.lang.String> getServerHost()

The server host.

Returns:

The server host

getServerPort

public int getServerPort()

The server port.

Returns:

The server port

setMaxInboundMessageSize

public void setMaxInboundMessageSize(@ReadableBytes
                                     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.

Throws:

java.lang.IllegalArgumentException - if bytes is negative.

java.lang.UnsupportedOperationException - if unsupported.

Since:

1.13.0

setMaxInboundMetadataSize

public void setMaxInboundMetadataSize(@ReadableBytes
                                      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

Throws:

java.lang.IllegalArgumentException - if bytes is non-positive

Since:

1.17.0

getServerConfiguration

@Nonnull
public GrpcSslConfiguration getServerConfiguration()

The SSL configuration.

Returns:

The SSL configuration

setServerConfiguration

@Inject
public void setServerConfiguration(GrpcSslConfiguration sslConfiguration)

Sets the SSL configuration.

Parameters:

sslConfiguration - The server configuration