net.devh.boot.grpc.client.channelfactory

Class NettyChannelFactory

java.lang.Object

net.devh.boot.grpc.client.channelfactory.AbstractChannelFactory<io.grpc.netty.NettyChannelBuilder>

net.devh.boot.grpc.client.channelfactory.NettyChannelFactory

All Implemented Interfaces:

java.lang.AutoCloseable, GrpcChannelFactory

public class NettyChannelFactory
extends AbstractChannelFactory<io.grpc.netty.NettyChannelBuilder>

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

Since:

5/17/16

Field Summary

Fields inherited from class net.devh.boot.grpc.client.channelfactory.AbstractChannelFactory

channelConfigurers, globalClientInterceptorRegistry

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	configureSecurity(io.grpc.netty.NettyChannelBuilder builder, java.lang.String name) Configures the security options that should be used by the channel.
protected io.grpc.netty.NettyChannelBuilder	newChannelBuilder(java.lang.String name) Creates a new ManagedChannelBuilder for the given client name.
protected static io.grpc.netty.NegotiationType	of(NegotiationType negotiationType) Converts the given negotiation type to netty's negotiation type.

Methods inherited from class net.devh.boot.grpc.client.channelfactory.AbstractChannelFactory

close, configure, configureCompression, configureKeepAlive, configureLimits, createChannel, createChannel, getPropertiesFor, isNonNullAndNonBlank, newManagedChannel, toCheckedFile

Methods inherited from class java.lang.Object

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

Constructor Detail

NettyChannelFactory

public NettyChannelFactory(GrpcChannelsProperties properties,
                           io.grpc.LoadBalancer.Factory loadBalancerFactory,
                           io.grpc.NameResolver.Factory nameResolverFactory,
                           GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                           java.util.List<GrpcChannelConfigurer> channelConfigurers)

Creates a new AbstractNettyChannelFactory 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.

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

NettyChannelFactory

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

Creates a new AbstractNettyChannelFactory 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.

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

Method Detail

newChannelBuilder

protected io.grpc.netty.NettyChannelBuilder newChannelBuilder(java.lang.String name)

Description copied from class: AbstractChannelFactory

Creates a new ManagedChannelBuilder for the given client name.

Specified by:

newChannelBuilder in class AbstractChannelFactory<io.grpc.netty.NettyChannelBuilder>

Parameters:

name - The name to create the channel builder for.

Returns:

The newly created channel builder.

configureSecurity

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

Description copied from class: AbstractChannelFactory

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

Overrides:

configureSecurity in class AbstractChannelFactory<io.grpc.netty.NettyChannelBuilder>

Parameters:

builder - The channel builder to configure.

name - The name of the client to configure.

of

protected static io.grpc.netty.NegotiationType of(NegotiationType negotiationType)

Converts the given negotiation type to netty's negotiation type.

Parameters:

negotiationType - The negotiation type to convert.

Returns:

The converted negotiation type.