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:

AutoCloseable, GrpcChannelFactory

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

This channel factory creates and manages netty based GrpcChannelFactorys.

This class utilizes connection pooling and thus needs to be closed after usage.

Field Summary

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

channelConfigurers, globalClientInterceptorRegistry

Constructor Summary

Constructors

Constructor and Description
NettyChannelFactory(GrpcChannelsProperties properties, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, List<GrpcChannelConfigurer> channelConfigurers) Creates a new GrpcChannelFactory for netty with the given options.

Method Summary

Modifier and Type	Method and Description
protected static void	configureAcceptedServerCertificates(GrpcChannelProperties.Security security, io.netty.handler.ssl.SslContextBuilder sslContextBuilder) Configures the server certificates accepted by the ssl context.
protected static void	configureProvidedClientCertificate(GrpcChannelProperties.Security security, io.netty.handler.ssl.SslContextBuilder sslContextBuilder) Configures the client certificate provided by the ssl context.
protected void	configureSecurity(io.grpc.netty.NettyChannelBuilder builder, String name) Configures the security options that should be used by the channel.
protected io.grpc.netty.NettyChannelBuilder	newChannelBuilder(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, getConnectivityState, getDefaultScheme, getPropertiesFor, isNonNullAndNonBlank, newManagedChannel, watchConnectivityState

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.devh.boot.grpc.client.channelfactory.GrpcChannelFactory

createChannel

Constructor Detail

NettyChannelFactory

public NettyChannelFactory(GrpcChannelsProperties properties,
                           GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                           List<GrpcChannelConfigurer> channelConfigurers)

Creates a new GrpcChannelFactory for netty with the given options.

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

newChannelBuilder

protected io.grpc.netty.NettyChannelBuilder newChannelBuilder(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,
                                 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.

configureProvidedClientCertificate

protected static void configureProvidedClientCertificate(GrpcChannelProperties.Security security,
                                                         io.netty.handler.ssl.SslContextBuilder sslContextBuilder)

Configures the client certificate provided by the ssl context.

Parameters:

security - The security configuration to use.

sslContextBuilder - The ssl context builder to configure.

configureAcceptedServerCertificates

protected static void configureAcceptedServerCertificates(GrpcChannelProperties.Security security,
                                                          io.netty.handler.ssl.SslContextBuilder sslContextBuilder)

Configures the server certificates accepted by the ssl context.

Parameters:

security - The security configuration to use.

sslContextBuilder - The ssl context builder 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.