net.devh.boot.grpc.server.serverfactory

Class AbstractGrpcServerFactory<T extends ServerBuilder<T>>

java.lang.Object

net.devh.boot.grpc.server.serverfactory.AbstractGrpcServerFactory<T>

Type Parameters:

T - The type of builder used by this factory.

All Implemented Interfaces:

GrpcServerFactory

Direct Known Subclasses:

InProcessGrpcServerFactory, NettyGrpcServerFactory, ShadedNettyGrpcServerFactory

public abstract class AbstractGrpcServerFactory<T extends ServerBuilder<T>>
extends Object
implements GrpcServerFactory

Abstract factory for grpc servers.

Since:

5/17/16

Field Summary

Fields

Modifier and Type	Field and Description
protected GrpcServerProperties	properties
protected List<GrpcServerConfigurer>	serverConfigurers

Constructor Summary

Constructors

Constructor and Description
AbstractGrpcServerFactory(GrpcServerProperties properties, List<GrpcServerConfigurer> serverConfigurers) Creates a new server factory with the given properties.

Method Summary

Modifier and Type	Method and Description
void	addService(GrpcServiceDefinition service) Adds the given grpc service definition to this factory.
protected void	configure(T builder) Configures the given server builder.
protected void	configureLimits(T builder) Configures limits such as max message sizes that should be used by the server.
protected void	configureSecurity(T builder) Configures the security options that should be used by the server.
protected void	configureServices(T builder) Configures the services that should be served by the server.
Server	createServer() Creates a new grpc server with the stored options.
void	destroy() Destroys this factory.
String	getAddress() Gets the IP address the created server will be bound to.
int	getPort() Gets the local port the created server will use to listen to requests.
protected abstract T	newServerBuilder() Creates a new server builder.
protected File	toCheckedFile(String context, String path) Converts the given path to a file.

Methods inherited from class java.lang.Object

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

Field Detail

properties

protected final GrpcServerProperties properties

serverConfigurers

protected final List<GrpcServerConfigurer> serverConfigurers

Constructor Detail

AbstractGrpcServerFactory

public AbstractGrpcServerFactory(GrpcServerProperties properties,
                                 List<GrpcServerConfigurer> serverConfigurers)

Creates a new server factory with the given properties.

Parameters:

properties - The properties used to configure the server.

serverConfigurers - The server configurers to use. Can be empty.

Method Detail

createServer

public Server createServer()

Description copied from interface: GrpcServerFactory

Creates a new grpc server with the stored options. The entire lifecycle management of the server should be managed by the calling class. This includes starting and stopping the server.

Specified by:

createServer in interface GrpcServerFactory

Returns:

The newly created grpc server.

newServerBuilder

protected abstract T newServerBuilder()

Creates a new server builder.

Returns:

The newly created server builder.

configure

protected void configure(T builder)

Configures the given server builder. This method can be overwritten to add features that are not yet supported by this library or use a GrpcServerConfigurer instead.

Parameters:

builder - The server builder to configure.

configureServices

protected void configureServices(T builder)

Configures the services that should be served by the server.

Parameters:

builder - The server builder to configure.

configureSecurity

protected void configureSecurity(T builder)

Configures the security options that should be used by the server.

Parameters:

builder - The server builder to configure.

toCheckedFile

protected File toCheckedFile(String context,
                             String path)

Converts the given path to a file. This method checks that the file exists and refers to a file.

Parameters:

context - The context for what the file is used. This value will be used in case of exceptions.

path - The path of the file to use.

Returns:

The file instance created with the given path.

configureLimits

protected void configureLimits(T builder)

Configures limits such as max message sizes that should be used by the server.

Parameters:

builder - The server builder to configure.

getAddress

public String getAddress()

Description copied from interface: GrpcServerFactory

Gets the IP address the created server will be bound to.

Specified by:

getAddress in interface GrpcServerFactory

Returns:

The IP address the server will be bound to.

getPort

public int getPort()

Description copied from interface: GrpcServerFactory

Gets the local port the created server will use to listen to requests.

Specified by:

getPort in interface GrpcServerFactory

Returns:

Gets the local port the server will use.

addService

public void addService(GrpcServiceDefinition service)

Description copied from interface: GrpcServerFactory

Adds the given grpc service definition to this factory. The created server will serve the services described by these definitions.

Note: Adding a service does not effect servers that have already been created.

Specified by:

addService in interface GrpcServerFactory

Parameters:

service - The service to add to the grpc server.

destroy

public void destroy()

Description copied from interface: GrpcServerFactory

Destroys this factory. This does not destroy or shutdown any server that was created using this factory.

Specified by:

destroy in interface GrpcServerFactory