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)
NameResolver.Factory	grpcNameResolverFactory(GrpcChannelsProperties channelProperties, NameResolverRegistry registry) Creates a new name resolver factory with the given channel properties.
NameResolverRegistration	grpcNameResolverRegistration(List<NameResolverProvider> nameResolverProviders) Creates a new NameResolverRegistration.
NameResolverRegistry	grpcNameResolverRegistry(NameResolverRegistration registration) Adds grpc's default registry to spring's application context.
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()

grpcNameResolverRegistration

@ConditionalOnMissingBean
 @Lazy
 @Bean
public NameResolverRegistration grpcNameResolverRegistration(@Autowired(required=false)
                                                                                                     List<NameResolverProvider> nameResolverProviders)

Creates a new NameResolverRegistration. This ensures that the NameResolverProvider's get unregistered when spring shuts down. This is mostly required for tests/when using the grpc's static default registry.

Parameters:

nameResolverProviders - The spring managed providers to manage.

Returns:

The newly created NameResolverRegistration bean.

grpcNameResolverRegistry

@ConditionalOnMissingBean
 @Lazy
 @Bean
public NameResolverRegistry grpcNameResolverRegistry(NameResolverRegistration registration)

Adds grpc's default registry to spring's application context.

Note: If multiple spring applications run in the same JVM, then you should consider creating separate registries.

Parameters:

registration - The name resolver registration that contains all name resolver providers that should be registered.

Returns:

grpc's default name resolver bean.

grpcNameResolverFactory

@ConditionalOnMissingBean(name="grpcNameResolverFactory")
 @Lazy
 @Bean
 @Primary
public NameResolver.Factory grpcNameResolverFactory(GrpcChannelsProperties channelProperties,
                                                                                                                                      NameResolverRegistry registry)

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 manually register your NameResolverProvider in the NameResolverRegistry.
• If you want to change the behavior when no address is given, you have to overwrite this bean.

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)