io.spine.server

Class GrpcContainer.Builder

java.lang.Object

io.spine.server.ConnectionBuilder

io.spine.server.GrpcContainer.Builder

Enclosing class:

GrpcContainer

public static final class GrpcContainer.Builder
extends ConnectionBuilder

The builder for GrpcContainer allows to define a port and services exposed by the container.

Method Summary

Modifier and Type	Method and Description
GrpcContainer.Builder	addService(io.grpc.BindableService service) Adds a gRPC service to deploy within the container being built.
GrpcContainer	build()
int	getPort() Deprecated. please use ConnectionBuilder.port().
com.google.common.collect.ImmutableSet<io.grpc.ServerServiceDefinition>	getServices() Deprecated. please use GrpcContainer.Builder.services().
GrpcContainer.Builder	removeService(io.grpc.ServerServiceDefinition service) Removes the previously added gRPC service.
com.google.common.collect.ImmutableSet<io.grpc.ServerServiceDefinition>	services() Obtains the services already added to the builder.
GrpcContainer.Builder	setPort(int ignored) Deprecated. please use GrpcContainer.atPort(int).
GrpcContainer.Builder	withServer(GrpcContainer.ConfigureServer action) Sets an additional configuration action for the gRPC Server instance, created for this GrpcContainer to run on top of.

Methods inherited from class io.spine.server.ConnectionBuilder

port, serverName

Methods inherited from class java.lang.Object

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

Method Detail

setPort

@Deprecated
public GrpcContainer.Builder setPort(int ignored)

Deprecated. please use GrpcContainer.atPort(int).

Does nothing.

getPort

@Deprecated
public int getPort()

Deprecated. please use ConnectionBuilder.port().

Obtains the port to be used by the container.

addService

@CanIgnoreReturnValue
public GrpcContainer.Builder addService(io.grpc.BindableService service)

Adds a gRPC service to deploy within the container being built.

Returns:

this instance of Builder, for call chaining

removeService

@CanIgnoreReturnValue
public GrpcContainer.Builder removeService(io.grpc.ServerServiceDefinition service)

Removes the previously added gRPC service.

If the service under the given definition was not added previously, this method does nothing.

Returns:

this instance of Builder, for call chaining

withServer

@Experimental
 @CanIgnoreReturnValue
public GrpcContainer.Builder withServer(GrpcContainer.ConfigureServer action)

Sets an additional configuration action for the gRPC Server instance, created for this GrpcContainer to run on top of. This configuration is applied right before the server is started.

Allows the direct access to gRPC ServerBuilder's API.

Please note this API is experimental.

Returns:

this instance of Builder, for call chaining

See Also:

GrpcContainer.ConfigureServer

getServices

@Deprecated
public com.google.common.collect.ImmutableSet<io.grpc.ServerServiceDefinition> getServices()

Deprecated. please use GrpcContainer.Builder.services().

Obtains the services already added to the builder.

services

public com.google.common.collect.ImmutableSet<io.grpc.ServerServiceDefinition> services()

Obtains the services already added to the builder.

build

public GrpcContainer build()