Package io.grpc

Class NameResolverRegistry

java.lang.Object

io.grpc.NameResolverRegistry

@ExperimentalApi("https://github.com/grpc/grpc-java/issues/4159")
@ThreadSafe
public final class NameResolverRegistry
extends Object

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

Since:

1.21.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private final class	NameResolverRegistry.NameResolverFactory
private static final class	NameResolverRegistry.NameResolverPriorityAccessor

Field Summary

Fields

Modifier and Type	Field	Description
private final LinkedHashSet<NameResolverProvider>	allProviders
private String	defaultScheme
private com.google.common.collect.ImmutableMap<String,NameResolverProvider>	effectiveProviders	Generated from allProviders.
private final NameResolver.Factory	factory
private static NameResolverRegistry	instance
private static final Logger	logger
private static final String	UNKNOWN_SCHEME

Constructor Summary

Constructors

Constructor	Description
NameResolverRegistry()

Method Summary

Modifier and Type	Method	Description
private void	addProvider(NameResolverProvider provider)
NameResolver.Factory	asFactory()
void	deregister(NameResolverProvider provider)	Deregisters a provider.
static NameResolverRegistry	getDefaultRegistry()	Returns the default registry that loads providers via the Java service loader mechanism.
String	getDefaultScheme()
(package private) static List<Class<?>>	getHardCodedClasses()
NameResolverProvider	getProviderForScheme(String scheme)
(package private) Map<String,NameResolverProvider>	providers()	Returns effective providers map from scheme to the highest priority NameResolverProvider of that scheme.
private void	refreshProviders()
void	register(NameResolverProvider 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 NameResolverRegistry instance

factory

private final NameResolver.Factory factory

UNKNOWN_SCHEME

private static final String UNKNOWN_SCHEME

See Also:

• Constant Field Values

defaultScheme

private String defaultScheme

allProviders

private final LinkedHashSet<NameResolverProvider> allProviders

effectiveProviders

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

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

Constructor Details

NameResolverRegistry

public NameResolverRegistry()

Method Details

getDefaultScheme

public String getDefaultScheme()

getProviderForScheme

public NameResolverProvider getProviderForScheme(String scheme)

register

public void register(NameResolverProvider 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(NameResolverProvider provider)

deregister

public void deregister(NameResolverProvider 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.NameResolverProvider).

refreshProviders

private void refreshProviders()

getDefaultRegistry

public static NameResolverRegistry getDefaultRegistry()

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

providers

Map<String,NameResolverProvider> providers()

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

asFactory

public NameResolver.Factory asFactory()

getHardCodedClasses

static List<Class<?>> getHardCodedClasses()