net.devh.boot.grpc.server.autoconfigure

Class GrpcServerFactoryAutoConfiguration

java.lang.Object

net.devh.boot.grpc.server.autoconfigure.GrpcServerFactoryAutoConfiguration

@Configuration(proxyBeanMethods=false)
 @ConditionalOnMissingBean(value={GrpcServerFactory.class,GrpcServerLifecycle.class})
 @AutoConfigureAfter(value=GrpcServerAutoConfiguration.class)
public class GrpcServerFactoryAutoConfiguration
extends Object

The auto configuration that will create the GrpcServerFactorys and GrpcServerLifecycles, if the developer hasn't specified their own variant.

Constructor Summary

Constructors

Constructor and Description
GrpcServerFactoryAutoConfiguration()

Method Summary

Modifier and Type	Method and Description
InProcessGrpcServerFactory	inProcessGrpcServerFactory(GrpcServerProperties properties, GrpcServiceDiscoverer serviceDiscoverer) Creates a GrpcServerFactory using the in-process-server, if a name is specified.
GrpcServerLifecycle	inProcessGrpcServerLifecycle(InProcessGrpcServerFactory factory, GrpcServerProperties properties, ApplicationEventPublisher eventPublisher) The server lifecycle bean for the in-process-server.
NettyGrpcServerFactory	nettyGrpcServerFactory(GrpcServerProperties properties, GrpcServiceDiscoverer serviceDiscoverer, List<GrpcServerConfigurer> serverConfigurers) Creates a GrpcServerFactory using the non-shaded netty.
GrpcServerLifecycle	nettyGrpcServerLifecycle(NettyGrpcServerFactory factory, GrpcServerProperties properties, ApplicationEventPublisher eventPublisher) The server lifecycle bean for netty based server.
ShadedNettyGrpcServerFactory	shadedNettyGrpcServerFactory(GrpcServerProperties properties, GrpcServiceDiscoverer serviceDiscoverer, List<GrpcServerConfigurer> serverConfigurers) Creates a GrpcServerFactory using the shaded netty.
GrpcServerLifecycle	shadedNettyGrpcServerLifecycle(ShadedNettyGrpcServerFactory factory, GrpcServerProperties properties, ApplicationEventPublisher eventPublisher) The server lifecycle bean for a shaded netty based server.

Methods inherited from class java.lang.Object

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

Constructor Detail

GrpcServerFactoryAutoConfiguration

public GrpcServerFactoryAutoConfiguration()

Method Detail

shadedNettyGrpcServerFactory

@ConditionalOnClass(name={"io.grpc.netty.shaded.io.netty.channel.Channel","io.grpc.netty.shaded.io.grpc.netty.NettyServerBuilder"})
 @Conditional(value=ConditionalOnInterprocessServer.class)
 @Bean
public ShadedNettyGrpcServerFactory shadedNettyGrpcServerFactory(GrpcServerProperties properties,
                                                                                                                                                                                                                                                                       GrpcServiceDiscoverer serviceDiscoverer,
                                                                                                                                                                                                                                                                       List<GrpcServerConfigurer> serverConfigurers)

Creates a GrpcServerFactory using the shaded netty. This is the recommended default for gRPC.

Parameters:

properties - The properties used to configure the server.

serviceDiscoverer - The discoverer used to identify the services that should be served.

serverConfigurers - The server configurers that contain additional configuration for the server.

Returns:

The shadedNettyGrpcServerFactory bean.

shadedNettyGrpcServerLifecycle

@ConditionalOnBean(value=ShadedNettyGrpcServerFactory.class)
 @Bean
public GrpcServerLifecycle shadedNettyGrpcServerLifecycle(ShadedNettyGrpcServerFactory factory,
                                                                                                                              GrpcServerProperties properties,
                                                                                                                              ApplicationEventPublisher eventPublisher)

The server lifecycle bean for a shaded netty based server.

Parameters:

factory - The factory used to create the lifecycle.

properties - The server properties to use.

eventPublisher - The event publisher to use.

Returns:

The inter-process server lifecycle bean.

nettyGrpcServerFactory

@ConditionalOnMissingBean(value=ShadedNettyGrpcServerFactory.class)
 @Conditional(value=ConditionalOnInterprocessServer.class)
 @ConditionalOnClass(name={"io.netty.channel.Channel","io.grpc.netty.NettyServerBuilder"})
 @Bean
public NettyGrpcServerFactory nettyGrpcServerFactory(GrpcServerProperties properties,
                                                                                                                                                                                                                                                                                      GrpcServiceDiscoverer serviceDiscoverer,
                                                                                                                                                                                                                                                                                      List<GrpcServerConfigurer> serverConfigurers)

Creates a GrpcServerFactory using the non-shaded netty. This is the fallback, if the shaded one is not present.

Parameters:

properties - The properties used to configure the server.

serviceDiscoverer - The discoverer used to identify the services that should be served.

serverConfigurers - The server configurers that contain additional configuration for the server.

Returns:

The shadedNettyGrpcServerFactory bean.

nettyGrpcServerLifecycle

@ConditionalOnBean(value=NettyGrpcServerFactory.class)
 @Bean
public GrpcServerLifecycle nettyGrpcServerLifecycle(NettyGrpcServerFactory factory,
                                                                                                                  GrpcServerProperties properties,
                                                                                                                  ApplicationEventPublisher eventPublisher)

The server lifecycle bean for netty based server.

Parameters:

factory - The factory used to create the lifecycle.

properties - The server properties to use.

eventPublisher - The event publisher to use.

Returns:

The inter-process server lifecycle bean.

inProcessGrpcServerFactory

@ConditionalOnProperty(prefix="grpc.server",
                       name="in-process-name")
 @Bean
public InProcessGrpcServerFactory inProcessGrpcServerFactory(GrpcServerProperties properties,
                                                                                                                                                                GrpcServiceDiscoverer serviceDiscoverer)

Creates a GrpcServerFactory using the in-process-server, if a name is specified.

Parameters:

properties - The properties used to configure the server.

serviceDiscoverer - The discoverer used to identify the services that should be served.

Returns:

The shadedNettyGrpcServerFactory bean.

inProcessGrpcServerLifecycle

@ConditionalOnBean(value=InProcessGrpcServerFactory.class)
 @Bean
public GrpcServerLifecycle inProcessGrpcServerLifecycle(InProcessGrpcServerFactory factory,
                                                                                                                          GrpcServerProperties properties,
                                                                                                                          ApplicationEventPublisher eventPublisher)

The server lifecycle bean for the in-process-server.

Parameters:

factory - The factory used to create the lifecycle.

properties - The server properties to use.

eventPublisher - The event publisher to use.

Returns:

The in-process server lifecycle bean.