Package io.grpc.xds

Class XdsNameResolverProvider

java.lang.Object

io.grpc.NameResolver.Factory

io.grpc.NameResolverProvider

io.grpc.xds.XdsNameResolverProvider

@Internal
public final class XdsNameResolverProvider
extends io.grpc.NameResolverProvider

A provider for XdsNameResolver.

It resolves a target URI whose scheme is "xds". The authority of the target URI is never used for current release. The path of the target URI, excluding the leading slash '/', will indicate the name to use in the VHDS query.

This class should not be directly referenced in code. The resolver should be accessed through NameResolverRegistry with the URI scheme "xds".

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	XdsNameResolverProvider.CallCounterProvider	Provides the counter for aggregating outstanding requests per cluster:eds_service_name.

Field Summary

Fields

Modifier and Type	Field	Description
private final Map<String,?>	bootstrapOverride
private final String	scheme
private static final String	SCHEME

Constructor Summary

Constructors

Modifier	Constructor	Description
	XdsNameResolverProvider()
private	XdsNameResolverProvider(String scheme, Map<String,?> bootstrapOverride)

Method Summary

Modifier and Type	Method	Description
static XdsNameResolverProvider	createForTest(String scheme, Map<String,?> bootstrapOverride)	A convenient method to allow creating a XdsNameResolverProvider with custom scheme and bootstrap.
String	getDefaultScheme()
Collection<Class<? extends SocketAddress>>	getProducedSocketAddressTypes()
protected boolean	isAvailable()
XdsNameResolver	newNameResolver(URI targetUri, io.grpc.NameResolver.Args args)
protected int	priority()

Methods inherited from class io.grpc.NameResolverProvider

getScheme

Methods inherited from class java.lang.Object

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

Field Details

SCHEME

private static final String SCHEME

See Also:

• Constant Field Values

scheme

private final String scheme

bootstrapOverride

private final Map<String,?> bootstrapOverride

Constructor Details

XdsNameResolverProvider

public XdsNameResolverProvider()

XdsNameResolverProvider

private XdsNameResolverProvider(String scheme,
 @Nullable
 Map<String,?> bootstrapOverride)

Method Details

createForTest

public static XdsNameResolverProvider createForTest(String scheme,
 @Nullable
 Map<String,?> bootstrapOverride)

A convenient method to allow creating a XdsNameResolverProvider with custom scheme and bootstrap.

newNameResolver

public XdsNameResolver newNameResolver(URI targetUri,
 io.grpc.NameResolver.Args args)

Specified by:

newNameResolver in class io.grpc.NameResolver.Factory

getDefaultScheme

public String getDefaultScheme()

Specified by:

getDefaultScheme in class io.grpc.NameResolver.Factory

isAvailable

protected boolean isAvailable()

Specified by:

isAvailable in class io.grpc.NameResolverProvider

priority

protected int priority()

Specified by:

priority in class io.grpc.NameResolverProvider

getProducedSocketAddressTypes

public Collection<Class<? extends SocketAddress>> getProducedSocketAddressTypes()

Overrides:

getProducedSocketAddressTypes in class io.grpc.NameResolverProvider