net.devh.boot.grpc.client.channelfactory

Class AbstractChannelFactory<T extends io.grpc.ManagedChannelBuilder<T>>

java.lang.Object

net.devh.boot.grpc.client.channelfactory.AbstractChannelFactory<T>

Type Parameters:

T - The type of builder used by this channel factory.

All Implemented Interfaces:

java.lang.AutoCloseable, GrpcChannelFactory

Direct Known Subclasses:

InProcessChannelFactory, NettyChannelFactory, ShadedNettyChannelFactory

public abstract class AbstractChannelFactory<T extends io.grpc.ManagedChannelBuilder<T>>
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

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<GrpcChannelConfigurer>	channelConfigurers
protected GlobalClientInterceptorRegistry	globalClientInterceptorRegistry

Constructor Summary

Constructors

Constructor and Description
AbstractChannelFactory(GrpcChannelsProperties properties, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, java.util.List<GrpcChannelConfigurer> channelConfigurers) 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(T builder, java.lang.String name) Configures the given netty channel builder.
protected void	configureCompression(T builder, java.lang.String name) Configures the compression options that should be used by the channel.
protected void	configureKeepAlive(T builder, java.lang.String name) Configures the keep alive options that should be used by the channel.
protected void	configureLimits(T builder, java.lang.String name) Configures limits such as max message sizes that should be used by the channel.
protected void	configureSecurity(T 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> customInterceptors) 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 boolean	isNonNullAndNonBlank(java.lang.String value)
protected abstract T	newChannelBuilder(java.lang.String name) Creates a new ManagedChannelBuilder for the given client name.
protected io.grpc.ManagedChannel	newManagedChannel(java.lang.String name) Creates a new ManagedChannel for the given client name.
protected java.io.File	toCheckedFile(java.lang.String context, java.lang.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

globalClientInterceptorRegistry

protected final GlobalClientInterceptorRegistry globalClientInterceptorRegistry

channelConfigurers

protected final java.util.List<GrpcChannelConfigurer> channelConfigurers

Constructor Detail

AbstractChannelFactory

public AbstractChannelFactory(GrpcChannelsProperties properties,
                              GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                              java.util.List<GrpcChannelConfigurer> channelConfigurers)

Creates a new AbstractChannelFactory with eager initialized references.

Parameters:

properties - The properties for the channels to create.

globalClientInterceptorRegistry - The interceptor registry to use.

channelConfigurers - The channel configurers to use. Can be empty.

Method Detail

createChannel

public final 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> customInterceptors)

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.

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

Returns:

The newly created channel for the given service.

newChannelBuilder

protected abstract T newChannelBuilder(java.lang.String name)

Creates a new ManagedChannelBuilder for the given client name.

Parameters:

name - The name to create the channel builder for.

Returns:

The newly created channel builder.

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:

newChannelBuilder(String), configure(ManagedChannelBuilder, 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(T 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(T 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(T 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.

toCheckedFile

protected java.io.File toCheckedFile(java.lang.String context,
                                     java.lang.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.

isNonNullAndNonBlank

protected boolean isNonNullAndNonBlank(java.lang.String value)

configureLimits

protected void configureLimits(T 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(T 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()

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. If the channels don't have terminated after 60 seconds then they will be forcefully shutdown.

Specified by:

close in interface java.lang.AutoCloseable

Specified by:

close in interface GrpcChannelFactory