Modifier and Type	Class and Description
private static class	LoadBalancerRegistry.LoadBalancerPriorityAccessor

Modifier and Type	Field and Description
private final LinkedHashSet<LoadBalancerProvider>	allProviders
private final LinkedHashMap<String, LoadBalancerProvider>	effectiveProviders
private static final Iterable<Class<?>>	HARDCODED_CLASSES
private static LoadBalancerRegistry	instance
private static final Logger	logger

Access	Constructor and Description
public	LoadBalancerRegistry()

Method Summary

Modifier and Type	Method and Description
private synchronized void	addProvider(LoadBalancerProvider provider)
public synchronized void	deregister(LoadBalancerProvider the provider that was added to the register via `register`. provider) Deregisters a provider.
public static synchronized LoadBalancerRegistry	getDefaultRegistry() Returns the default registry that loads providers via the Java service loader mechanism.
pack-priv static List<Class<?>>	getHardCodedClasses()
public synchronized LoadBalancerProvider	getProvider(String policy) Returns the effective provider for the given load-balancing policy, or `null` if no suitable provider can be found.
pack-priv synchronized Map<String, LoadBalancerProvider>	providers() Returns effective providers in a new map.
private synchronized void	refreshProviderMap()
public synchronized void	register(LoadBalancerProvider provider) Register a provider.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

allProviders	back to summary
private final LinkedHashSet<LoadBalancerProvider> allProviders

effectiveProviders	back to summary
private final LinkedHashMap<String, LoadBalancerProvider> effectiveProviders

HARDCODED_CLASSES	back to summary
private static final Iterable<Class<?>> HARDCODED_CLASSES

instance	back to summary
private static LoadBalancerRegistry instance

logger	back to summary
private static final Logger logger

Constructor Detail

LoadBalancerRegistry	back to summary
public LoadBalancerRegistry()

Method Detail

addProvider	back to summary
private synchronized void addProvider(LoadBalancerProvider provider)

deregister back to summary

deregister	back to summary
public synchronized void deregister(LoadBalancerProvider provider) Deregisters a provider. No-op if the provider is not in the registry. If there are more than one providers with the same policy name as the deregistered one in the registry, one of them will become the effective provider for that policy, per the rule documented in `register`. Parameters provider:LoadBalancerProvider the provider that was added to the register via `register`.

public synchronized void deregister(LoadBalancerProvider provider)

Deregisters a provider. No-op if the provider is not in the registry. If there are more than one providers with the same policy name as the deregistered one in the registry, one of them will become the effective provider for that policy, per the rule documented in register.

Parameters

provider:LoadBalancerProvider: the provider that was added to the register via register.

getDefaultRegistry	back to summary
public static synchronized LoadBalancerRegistry getDefaultRegistry() Returns the default registry that loads providers via the Java service loader mechanism.

getHardCodedClasses	back to summary
pack-priv static List<Class<?>> getHardCodedClasses() Annotations @VisibleForTesting

getProvider back to summary

getProvider	back to summary
public synchronized LoadBalancerProvider getProvider(String policy) Returns the effective provider for the given load-balancing policy, or `null` if no suitable provider can be found. Each provider declares its policy name via `LoadBalancerProvider#getPolicyName`. Annotations @Nullable

public synchronized LoadBalancerProvider getProvider(String policy)

Returns the effective provider for the given load-balancing policy, or null if no suitable provider can be found. Each provider declares its policy name via LoadBalancerProvider#getPolicyName.

Annotations

@Nullable

providers	back to summary
pack-priv synchronized Map<String, LoadBalancerProvider> providers() Returns effective providers in a new map. Annotations @VisibleForTesting

providers

back to summary

pack-priv synchronized Map<String, LoadBalancerProvider> providers()

Returns effective providers in a new map.

Annotations

@VisibleForTesting

refreshProviderMap	back to summary
private synchronized void refreshProviderMap()

register	back to summary
public synchronized void register(LoadBalancerProvider provider) Register a provider. If the provider's `isAvailable()` returns `false`, this method will throw `IllegalArgumentException`. If more than one provider with the same `policy name` are registered, the one with the highest `priority` will be effective. If there are more than one name-sake providers rank the highest priority, the one registered first will be effective.

public synchronized void register(LoadBalancerProvider provider)

If the provider's isAvailable() returns false, this method will throw IllegalArgumentException.

If more than one provider with the same policy name are registered, the one with the highest priority will be effective. If there are more than one name-sake providers rank the highest priority, the one registered first will be effective.

io.grpc back to summary

private final Class LoadBalancerRegistry.LoadBalancerPriorityAccessor

Class Inheritance

extends Object
implements ServiceProviders.PriorityAccessor<LoadBalancerProvider>

java.lang.Object
io.grpc.LoadBalancerRegistry.LoadBalancerPriorityAccessor

All Implemented Interfaces

io.grpc.ServiceProviders.PriorityAccessor

Constructor Summary

Access	Constructor and Description
pack-priv	LoadBalancerPriorityAccessor()

Method Summary

Modifier and Type	Method and Description
public int	getPriority(LoadBalancerProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority. A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.
public boolean	isAvailable(LoadBalancerProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Checks this provider is available for use, taking the current environment into consideration.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Detail

LoadBalancerPriorityAccessor	back to summary
pack-priv LoadBalancerPriorityAccessor()

Method Detail

getPriority	back to summary
public int getPriority(LoadBalancerProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority. Doc from io.grpc.ServiceProviders.PriorityAccessor.getPriority. A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration. 5 should be considered the default, and then tweaked based on environment detection. A priority of 0 does not imply that the provider wouldn't work; just that it should be last in line. Annotations @Override

getPriority

back to summary

public int getPriority(LoadBalancerProvider provider)

Implements io.grpc.ServiceProviders.PriorityAccessor.getPriority.

Doc from io.grpc.ServiceProviders.PriorityAccessor.getPriority.

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration. 5 should be considered the default, and then tweaked based on environment detection. A priority of 0 does not imply that the provider wouldn't work; just that it should be last in line.

Annotations

@Override

isAvailable back to summary

isAvailable	back to summary
public boolean isAvailable(LoadBalancerProvider provider) Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Doc from io.grpc.ServiceProviders.PriorityAccessor.isAvailable. Checks this provider is available for use, taking the current environment into consideration. If `false`, no other methods are safe to be called. Annotations @Override

public boolean isAvailable(LoadBalancerProvider provider)

Implements io.grpc.ServiceProviders.PriorityAccessor.isAvailable.

Doc from io.grpc.ServiceProviders.PriorityAccessor.isAvailable.

Checks this provider is available for use, taking the current environment into consideration. If false, no other methods are safe to be called.

Annotations