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 Object

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

Since:

5/17/16

Constructor Summary

Constructors

Constructor and Description
GrpcClientAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
AnnotationGlobalClientInterceptorConfigurer	annotationGlobalClientInterceptorConfigurer()
GrpcChannelConfigurer	compressionChannelConfigurer(CompressorRegistry registry)
GrpcChannelConfigurer	decompressionChannelConfigurer(DecompressorRegistry registry)
List<GrpcChannelConfigurer>	defaultChannelConfigurers()
GlobalClientInterceptorRegistry	globalClientInterceptorRegistry()
GrpcChannelsProperties	grpcChannelsProperties()
static GrpcClientBeanPostProcessor	grpcClientBeanPostProcessor(ApplicationContext applicationContext)
GrpcChannelConfigurer	grpcLoadBalancerConfigurer(LoadBalancer.Factory loadBalancerFactory) Deprecated. This method disables service-config-based policy selection, and may cause problems if NameResolver returns GRPCLB balancer addresses but a non-GRPCLB LoadBalancer is passed in here. Use GrpcChannelProperties.setDefaultLoadBalancingPolicy(String) instead.
NameResolver.Factory	grpcNameResolverFactory(GrpcChannelsProperties channelProperties) Creates a new name resolver factory with the given channel properties.
GrpcChannelFactory	inProcessGrpcChannelFactory(GrpcChannelsProperties properties, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, List<GrpcChannelConfigurer> channelConfigurers)
GrpcChannelFactory	nettyGrpcChannelFactory(GrpcChannelsProperties properties, NameResolver.Factory nameResolverFactory, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, List<GrpcChannelConfigurer> channelConfigurers)
GrpcChannelFactory	shadedNettyGrpcChannelFactory(GrpcChannelsProperties properties, NameResolver.Factory nameResolverFactory, GlobalClientInterceptorRegistry globalClientInterceptorRegistry, 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 static GrpcClientBeanPostProcessor grpcClientBeanPostProcessor(ApplicationContext applicationContext)

grpcChannelsProperties

@ConditionalOnMissingBean
 @Bean
public GrpcChannelsProperties grpcChannelsProperties()

globalClientInterceptorRegistry

@ConditionalOnMissingBean
 @Bean
public GlobalClientInterceptorRegistry globalClientInterceptorRegistry()

annotationGlobalClientInterceptorConfigurer

@Bean
public AnnotationGlobalClientInterceptorConfigurer annotationGlobalClientInterceptorConfigurer()

grpcLoadBalancerConfigurer

@ConditionalOnSingleCandidate(value=io.grpc.LoadBalancer.Factory.class)
 @ConditionalOnMissingBean(name="grpcLoadBalancerConfigurer")
 @Bean
 @Deprecated
public GrpcChannelConfigurer grpcLoadBalancerConfigurer(LoadBalancer.Factory loadBalancerFactory)

Deprecated. This method disables service-config-based policy selection, and may cause problems if NameResolver returns GRPCLB balancer addresses but a non-GRPCLB LoadBalancer is passed in here. Use GrpcChannelProperties.setDefaultLoadBalancingPolicy(String) instead.

Creates the load balancer configurer bean for the given load balancer factory.

Parameters:

loadBalancerFactory - The factory that should be used for all

Returns:

The load balancer factory bean.

See Also:

ManagedChannelBuilder.loadBalancerFactory(io.grpc.LoadBalancer.Factory)

grpcNameResolverFactory

@ConditionalOnMissingBean
 @Lazy
 @Bean
public 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.

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(CompressorRegistry registry)

decompressionChannelConfigurer

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

defaultChannelConfigurers

@ConditionalOnMissingBean(value=GrpcChannelConfigurer.class)
 @Bean
public 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,
                                                                                                                                                                                                                                                               NameResolver.Factory nameResolverFactory,
                                                                                                                                                                                                                                                               GlobalClientInterceptorRegistry globalClientInterceptorRegistry,
                                                                                                                                                                                                                                                               List<GrpcChannelConfigurer> channelConfigurers)

nettyGrpcChannelFactory

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

inProcessGrpcChannelFactory

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