net.devh.springboot.autoconfigure.grpc.client

Class AbstractChannelFactory

java.lang.Object

net.devh.springboot.autoconfigure.grpc.client.AbstractChannelFactory

All Implemented Interfaces:

java.lang.AutoCloseable, GrpcChannelFactory

Direct Known Subclasses:

AddressChannelFactory, DiscoveryClientChannelFactory

public abstract class AbstractChannelFactory
extends java.lang.Object
implements GrpcChannelFactory

This abstract channel factory contains some shared code for other GrpcChannelFactorys. This class utilizes connection pooling and thus needs to be closed after usage.

Since:

5/17/16

Constructor Summary

Constructors

Constructor and Description
AbstractChannelFactory(GrpcChannelsProperties properties, io.grpc.LoadBalancer.Factory loadBalancerFactory, java.util.function.Function<T,io.grpc.NameResolver.Factory> nameResolverFactoryCreator, GlobalClientInterceptorRegistry globalClientInterceptorRegistry) Creates a new AbstractChannelFactory with partially lazy initialized references.
AbstractChannelFactory(GrpcChannelsProperties properties, io.grpc.LoadBalancer.Factory loadBalancerFactory, io.grpc.NameResolver.Factory nameResolverFactory, GlobalClientInterceptorRegistry globalClientInterceptorRegistry) Creates a new AbstractChannelFactory with eager initialized references.

Method Summary

Modifier and Type	Method and Description
void	close() Closes this channel factory and the channels created by this instance.
protected void	configure(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures the given netty channel builder.
protected void	configureCompression(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures the compression options that should be used by the channel.
protected void	configureKeepAlive(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures the keep alive options that should be used by the channel.
protected void	configureLimits(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures limits such as max message sizes that should be used by the channel.
protected void	configureSecurity(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures the security options that should be used by the channel.
io.grpc.Channel	createChannel(java.lang.String name) Creates a new channel for the given service name.
io.grpc.Channel	createChannel(java.lang.String name, java.util.List<io.grpc.ClientInterceptor> interceptors) Creates a new channel for the given service name.
protected GrpcChannelProperties	getPropertiesFor(java.lang.String name) Gets the channel properties for the given client name.
protected io.grpc.ManagedChannel	newManagedChannel(java.lang.String name) Creates a new ManagedChannel for the given client name.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractChannelFactory

public AbstractChannelFactory(GrpcChannelsProperties properties,
                              io.grpc.LoadBalancer.Factory loadBalancerFactory,
                              io.grpc.NameResolver.Factory nameResolverFactory,
                              GlobalClientInterceptorRegistry globalClientInterceptorRegistry)

Creates a new AbstractChannelFactory with eager initialized references.

Parameters:

properties - The properties for the channels to create.

loadBalancerFactory - The load balancer factory to use.

nameResolverFactory - The name resolver factory to use.

globalClientInterceptorRegistry - The interceptor registry to use.

AbstractChannelFactory

public AbstractChannelFactory(GrpcChannelsProperties properties,
                              io.grpc.LoadBalancer.Factory loadBalancerFactory,
                              java.util.function.Function<T,io.grpc.NameResolver.Factory> nameResolverFactoryCreator,
                              GlobalClientInterceptorRegistry globalClientInterceptorRegistry)

Creates a new AbstractChannelFactory with partially lazy initialized references.

Type Parameters:

T - The type of the actual factory class or one of its super classes.

Parameters:

properties - The properties for the channels to create.

loadBalancerFactory - The load balancer factory to use.

nameResolverFactoryCreator - The function that creates the name resolver factory.

globalClientInterceptorRegistry - The interceptor registry to use.

Method Detail

createChannel

public io.grpc.Channel createChannel(java.lang.String name)

Description copied from interface: GrpcChannelFactory

Creates a new channel for the given service name. The returned channel will use all globally registered ClientInterceptors.

Note: The underlying implementation might reuse existing ManagedChannels allow connection reuse.

Specified by:

createChannel in interface GrpcChannelFactory

Parameters:

name - The name of the service.

Returns:

The newly created channel for the given service.

createChannel

public io.grpc.Channel createChannel(java.lang.String name,
                                     java.util.List<io.grpc.ClientInterceptor> interceptors)

Description copied from interface: GrpcChannelFactory

Creates a new channel for the given service name. The returned channel will use all globally registered ClientInterceptors.

Note: The underlying implementation might reuse existing ManagedChannels allow connection reuse.

Note: The given interceptors will be applied after the global interceptors. But the interceptors that were applied last, will be called first.

Specified by:

createChannel in interface GrpcChannelFactory

Parameters:

name - The name of the service.

interceptors - A list of additional client interceptors that should be added to the channel.

Returns:

The newly created channel for the given service.

newManagedChannel

protected io.grpc.ManagedChannel newManagedChannel(java.lang.String name)

Creates a new ManagedChannel for the given client name. The name will be used to determine the properties for the new channel. The calling method is responsible for lifecycle management of the created channel. ManagedChannels should be reused if possible to allow connection reuse.

Parameters:

name - The name to create the channel for.

Returns:

The newly created channel.

See Also:

configure(NettyChannelBuilder, String)

getPropertiesFor

protected final GrpcChannelProperties getPropertiesFor(java.lang.String name)

Gets the channel properties for the given client name.

Parameters:

name - The client name to use.

Returns:

The properties for the given client name.

configure

protected void configure(io.grpc.netty.NettyChannelBuilder builder,
                         java.lang.String name)

Configures the given netty channel builder. This method can be overwritten to add features that are not yet supported by this library.

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

configureKeepAlive

protected void configureKeepAlive(io.grpc.netty.NettyChannelBuilder builder,
                                  java.lang.String name)

Configures the keep alive options that should be used by the channel.

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

configureSecurity

protected void configureSecurity(io.grpc.netty.NettyChannelBuilder builder,
                                 java.lang.String name)

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

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

configureLimits

protected void configureLimits(io.grpc.netty.NettyChannelBuilder builder,
                               java.lang.String name)

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

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

configureCompression

protected void configureCompression(io.grpc.netty.NettyChannelBuilder builder,
                                    java.lang.String name)

Configures the compression options that should be used by the channel.

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

close

@PreDestroy
public void close()
                       throws java.lang.InterruptedException

Closes this channel factory and the channels created by this instance. The shutdown happens in two phases, first an orderly shutdown is initiated on all channels and then the method waits for all channels to terminate.

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.InterruptedException