net.devh.boot.grpc.client.autoconfigure

Class GrpcClientAutoConfiguration

java.lang.Object

net.devh.boot.grpc.client.autoconfigure.GrpcClientAutoConfiguration

@Configuration
 @EnableConfigurationProperties
 @AutoConfigureAfter(name="org.springframework.cloud.client.CommonsClientAutoConfiguration",
                    value=net.devh.boot.grpc.common.autoconfigure.GrpcCommonCodecAutoConfiguration.class)
public class GrpcClientAutoConfiguration
extends java.lang.Object

The auto configuration used by Spring-Boot that contains all beans to create and inject grpc clients into beans.

Since:

5/17/16

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	GrpcClientAutoConfiguration.TraceClientAutoConfiguration

Constructor Summary

Constructors

Constructor and Description
GrpcClientAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
AnnotationGlobalClientInterceptorConfigurer	annotationGlobalClientInterceptorConfigurer()
GrpcChannelConfigurer	compressionChannelConfigurer(io.grpc.CompressorRegistry registry)
GrpcChannelConfigurer	decompressionChannelConfigurer(io.grpc.DecompressorRegistry registry)
java.util.List<GrpcChannelConfigurer>	defaultChannelConfigurers()
GlobalClientInterceptorRegistry	globalClientInterceptorRegistry()
GrpcChannelsProperties	grpcChannelsProperties()
GrpcClientBeanPostProcessor	grpcClientBeanPostProcessor(org.springframework.context.ApplicationContext applicationContext)
io.grpc.LoadBalancer.Factory	grpcLoadBalancerFactory()
io.grpc.NameResolver.Factory	grpcNameResolverFactory(GrpcChannelsProperties channelProperties) Creates a new name resolver factory with the given channel properties.
GrpcChannelFactory	inProcessGrpcChannelFactory(GrpcChannelsProperties properties, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, java.util.List<GrpcChannelConfigurer> channelConfigurers)
GrpcChannelFactory	nettyGrpcChannelFactory(GrpcChannelsProperties properties, io.grpc.LoadBalancer.Factory loadBalancerFactory, io.grpc.NameResolver.Factory nameResolverFactory, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, java.util.List<GrpcChannelConfigurer> channelConfigurers)
GrpcChannelFactory	shadedNettyGrpcChannelFactory(GrpcChannelsProperties properties, io.grpc.LoadBalancer.Factory loadBalancerFactory, io.grpc.NameResolver.Factory nameResolverFactory, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, java.util.List<GrpcChannelConfigurer> channelConfigurers)

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcClientAutoConfiguration

public GrpcClientAutoConfiguration()

Method Detail

grpcClientBeanPostProcessor

@Bean
public GrpcClientBeanPostProcessor grpcClientBeanPostProcessor(org.springframework.context.ApplicationContext applicationContext)

grpcChannelsProperties

@ConditionalOnMissingBean
 @Bean
public GrpcChannelsProperties grpcChannelsProperties()

globalClientInterceptorRegistry

@Bean
public GlobalClientInterceptorRegistry globalClientInterceptorRegistry()

annotationGlobalClientInterceptorConfigurer

@Bean
public AnnotationGlobalClientInterceptorConfigurer annotationGlobalClientInterceptorConfigurer()

grpcLoadBalancerFactory

@ConditionalOnMissingBean
 @Lazy
 @Bean
public io.grpc.LoadBalancer.Factory grpcLoadBalancerFactory()

grpcNameResolverFactory

@ConditionalOnMissingBean
 @Lazy
 @Bean
public io.grpc.NameResolver.Factory grpcNameResolverFactory(GrpcChannelsProperties channelProperties)

Creates a new name resolver factory with the given channel properties. The properties are used to map the client name to the actual service addresses. If you want to add more name resolver schemes or modify existing ones, you can do that in the following ways:

• If you only rely on the client properties or other static beans, then you can simply add an entry to java's service discovery for NameResolverProviders.
• If you need access to other beans, then you have to redefine this bean and use a CompositeNameResolverFactory as the delegate for the ConfigMappedNameResolverFactory.

You can access the client name and properties via the params that are used to create the name resolver.

Parameters:

channelProperties - The properties for the channels.

Returns:

The default config mapped name resolver factory.

compressionChannelConfigurer

@ConditionalOnBean(value=io.grpc.CompressorRegistry.class)
 @Bean
public GrpcChannelConfigurer compressionChannelConfigurer(io.grpc.CompressorRegistry registry)

decompressionChannelConfigurer

@ConditionalOnBean(value=io.grpc.DecompressorRegistry.class)
 @Bean
public GrpcChannelConfigurer decompressionChannelConfigurer(io.grpc.DecompressorRegistry registry)

defaultChannelConfigurers

@ConditionalOnMissingBean(value=GrpcChannelConfigurer.class)
 @Bean
public java.util.List<GrpcChannelConfigurer> defaultChannelConfigurers()

shadedNettyGrpcChannelFactory

@ConditionalOnMissingBean(value=GrpcChannelFactory.class)
 @ConditionalOnClass(name={"io.grpc.netty.shaded.io.netty.channel.Channel","io.grpc.netty.shaded.io.grpc.netty.NettyChannelBuilder"})
 @Bean
public GrpcChannelFactory shadedNettyGrpcChannelFactory(GrpcChannelsProperties properties,
                                                                                                                                                                                                                                                               io.grpc.LoadBalancer.Factory loadBalancerFactory,
                                                                                                                                                                                                                                                               io.grpc.NameResolver.Factory nameResolverFactory,
                                                                                                                                                                                                                                                               GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                                                                                                                                                                                                                                                               java.util.List<GrpcChannelConfigurer> channelConfigurers)

nettyGrpcChannelFactory

@ConditionalOnMissingBean(value=GrpcChannelFactory.class)
 @ConditionalOnClass(name={"io.netty.channel.Channel","io.grpc.netty.NettyChannelBuilder"})
 @Bean
public GrpcChannelFactory nettyGrpcChannelFactory(GrpcChannelsProperties properties,
                                                                                                                                                                                                               io.grpc.LoadBalancer.Factory loadBalancerFactory,
                                                                                                                                                                                                               io.grpc.NameResolver.Factory nameResolverFactory,
                                                                                                                                                                                                               GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                                                                                                                                                                                                               java.util.List<GrpcChannelConfigurer> channelConfigurers)

inProcessGrpcChannelFactory

@ConditionalOnMissingBean(value=GrpcChannelFactory.class)
 @Bean
public GrpcChannelFactory inProcessGrpcChannelFactory(GrpcChannelsProperties properties,
                                                                                                                       GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                                                                                                                       java.util.List<GrpcChannelConfigurer> channelConfigurers)