Class AutoConfiguredLoadBalancerFactory

java.lang.Object

io.grpc.internal.AutoConfiguredLoadBalancerFactory

public final class AutoConfiguredLoadBalancerFactory
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	AutoConfiguredLoadBalancerFactory.AutoConfiguredLoadBalancer
private static final class	AutoConfiguredLoadBalancerFactory.EmptyPicker
private static final class	AutoConfiguredLoadBalancerFactory.FailingPicker
private static final class	AutoConfiguredLoadBalancerFactory.NoopLoadBalancer
(package private) static final class	AutoConfiguredLoadBalancerFactory.PolicyException

Field Summary

Fields

Modifier and Type	Field	Description
private final String	defaultPolicy
private final LoadBalancerRegistry	registry

Constructor Summary

Constructors

Constructor	Description
AutoConfiguredLoadBalancerFactory(LoadBalancerRegistry registry, String defaultPolicy)
AutoConfiguredLoadBalancerFactory(String defaultPolicy)

Method Summary

Modifier and Type	Method	Description
private LoadBalancerProvider	getProviderOrThrow(String policy, String choiceReason)
AutoConfiguredLoadBalancerFactory.AutoConfiguredLoadBalancer	newLoadBalancer(LoadBalancer.Helper helper)
(package private) NameResolver.ConfigOrError	parseLoadBalancerPolicy(Map<String,?> serviceConfig)	Parses first available LoadBalancer policy from service config.

Methods inherited from class Object

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

Field Details

registry

private final LoadBalancerRegistry registry

defaultPolicy

private final String defaultPolicy

Constructor Details

AutoConfiguredLoadBalancerFactory

public AutoConfiguredLoadBalancerFactory(String defaultPolicy)

AutoConfiguredLoadBalancerFactory

AutoConfiguredLoadBalancerFactory(LoadBalancerRegistry registry,
 String defaultPolicy)

Method Details

newLoadBalancer

public AutoConfiguredLoadBalancerFactory.AutoConfiguredLoadBalancer newLoadBalancer(LoadBalancer.Helper helper)

getProviderOrThrow

private LoadBalancerProvider getProviderOrThrow(String policy,
 String choiceReason)
                                         throws AutoConfiguredLoadBalancerFactory.PolicyException

Throws:

AutoConfiguredLoadBalancerFactory.PolicyException

parseLoadBalancerPolicy

@Nullable
NameResolver.ConfigOrError parseLoadBalancerPolicy(Map<String,?> serviceConfig)

Parses first available LoadBalancer policy from service config. Available LoadBalancer should be registered to LoadBalancerRegistry. If the first available LoadBalancer policy is invalid, it doesn't fall-back to next available policy, instead it returns error. This also means, it ignores LoadBalancer policies after the first available one even if any of them are invalid.

Order of policy preference:

1. Policy from "loadBalancingConfig" if present
2. The policy from deprecated "loadBalancingPolicy" if present

Unlike a normal LoadBalancer.Factory, this accepts a full service config rather than the LoadBalancingConfig.

Returns:

the parsed ServiceConfigUtil.PolicySelection, or null if no selection could be made.