Package io.grpc.xds

Class XdsCredentialsRegistry

java.lang.Object

io.grpc.xds.XdsCredentialsRegistry

@ThreadSafe
final class XdsCredentialsRegistry
extends Object

Registry of XdsCredentialsProviders. The default instance loads providers at runtime through the Java service provider mechanism.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	XdsCredentialsRegistry.XdsCredentialsProviderPriorityAccessor

Field Summary

Fields

Modifier and Type	Field	Description
private final LinkedHashSet<XdsCredentialsProvider>	allProviders
private com.google.common.collect.ImmutableMap<String,XdsCredentialsProvider>	effectiveProviders	Generated from allProviders.
private static XdsCredentialsRegistry	instance
private static final Logger	logger

Constructor Summary

Constructors

Constructor	Description
XdsCredentialsRegistry()

Method Summary

Modifier and Type	Method	Description
private void	addProvider(XdsCredentialsProvider provider)
void	deregister(XdsCredentialsProvider provider)	Deregisters a provider.
static XdsCredentialsRegistry	getDefaultRegistry()	Returns the default registry that loads providers via the Java service loader mechanism.
(package private) static List<Class<?>>	getHardCodedClasses()
XdsCredentialsProvider	getProvider(String name)	Returns the effective provider for the given xds credential name, or null if no suitable provider can be found.
(package private) Map<String,XdsCredentialsProvider>	providers()	Returns effective providers map from scheme to the highest priority XdsCredsProvider of that scheme.
private void	refreshProviders()
void	register(XdsCredentialsProvider provider)	Register a provider.

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final Logger logger

instance

private static XdsCredentialsRegistry instance

allProviders

private final LinkedHashSet<XdsCredentialsProvider> allProviders

effectiveProviders

private com.google.common.collect.ImmutableMap<String,XdsCredentialsProvider> effectiveProviders

Generated from allProviders. Is mapping from scheme key to the highest priority XdsCredentialsProvider. Is replaced instead of mutating.

Constructor Details

XdsCredentialsRegistry

XdsCredentialsRegistry()

Method Details

register

public void register(XdsCredentialsProvider provider)

Register a provider.

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

Providers will be used in priority order. In case of ties, providers are used in registration order.

addProvider

private void addProvider(XdsCredentialsProvider provider)

deregister

public void deregister(XdsCredentialsProvider provider)

Deregisters a provider. No-op if the provider is not in the registry.

Parameters:

provider - the provider that was added to the register via register(io.grpc.xds.XdsCredentialsProvider).

refreshProviders

private void refreshProviders()

getDefaultRegistry

public static XdsCredentialsRegistry getDefaultRegistry()

Returns the default registry that loads providers via the Java service loader mechanism.

providers

Map<String,XdsCredentialsProvider> providers()

Returns effective providers map from scheme to the highest priority XdsCredsProvider of that scheme.

getProvider

@Nullable
public XdsCredentialsProvider getProvider(String name)

Returns the effective provider for the given xds credential name, or null if no suitable provider can be found. Each provider declares its name via XdsCredentialsProvider.getName().

getHardCodedClasses

static List<Class<?>> getHardCodedClasses()