Package io.grpc.xds

Class XdsNameResolver

java.lang.Object

io.grpc.NameResolver

io.grpc.xds.XdsNameResolver

final class XdsNameResolver
extends io.grpc.NameResolver

A NameResolver for resolving gRPC target names with "xds:" scheme.

Resolving a gRPC target involves contacting the control plane management server via xDS protocol to retrieve service information and produce a service config to the caller.

See Also:

• XdsNameResolverProvider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static class	XdsNameResolver.ClusterRefState
private final class	XdsNameResolver.ConfigSelector
private static final class	XdsNameResolver.FailingConfigSelector
private class	XdsNameResolver.ResolveState
private static class	XdsNameResolver.RoutingConfig	VirtualHost-level configuration for request routing.

Nested classes/interfaces inherited from class io.grpc.NameResolver

io.grpc.NameResolver.Args, io.grpc.NameResolver.ConfigOrError, io.grpc.NameResolver.Factory, io.grpc.NameResolver.Listener, io.grpc.NameResolver.Listener2, io.grpc.NameResolver.ResolutionResult, io.grpc.NameResolver.ResolutionResultAttr, io.grpc.NameResolver.ServiceConfigParser

Field Summary

Fields

Modifier and Type	Field	Description
private XdsNameResolverProvider.CallCounterProvider	callCounterProvider
(package private) static final io.grpc.CallOptions.Key<String>	CLUSTER_SELECTION_KEY
private final ConcurrentMap<String,XdsNameResolver.ClusterRefState>	clusterRefs
private final XdsNameResolver.ConfigSelector	configSelector
(package private) static boolean	enableTimeout
private final String	encodedServiceAuthority
private final FilterRegistry	filterRegistry
private final XxHash64	hashFunc
private io.grpc.NameResolver.Listener2	listener
private final XdsLogger	logger
private final io.grpc.InternalLogId	logId
private final String	overrideAuthority
private final ThreadSafeRandom	random
private final long	randomChannelId
private boolean	receivedConfig
private XdsNameResolver.ResolveState	resolveState
private XdsNameResolver.RoutingConfig	routingConfig
(package private) static final io.grpc.CallOptions.Key<Long>	RPC_HASH_KEY
private final ScheduledExecutorService	scheduler
private final String	serviceAuthority
private final io.grpc.NameResolver.ServiceConfigParser	serviceConfigParser
private final io.grpc.SynchronizationContext	syncContext
private final String	target
private final String	targetAuthority
private XdsClient	xdsClient
private io.grpc.internal.ObjectPool<XdsClient>	xdsClientPool
private final XdsClientPoolFactory	xdsClientPoolFactory

Constructor Summary

Constructors

Constructor	Description
XdsNameResolver(URI targetUri, String name, String overrideAuthority, io.grpc.NameResolver.ServiceConfigParser serviceConfigParser, io.grpc.SynchronizationContext syncContext, ScheduledExecutorService scheduler, Map<String,?> bootstrapOverride)
XdsNameResolver(URI targetUri, String targetAuthority, String name, String overrideAuthority, io.grpc.NameResolver.ServiceConfigParser serviceConfigParser, io.grpc.SynchronizationContext syncContext, ScheduledExecutorService scheduler, XdsClientPoolFactory xdsClientPoolFactory, ThreadSafeRandom random, FilterRegistry filterRegistry, Map<String,?> bootstrapOverride)

Method Summary

Modifier and Type	Method	Description
private static io.grpc.ClientInterceptor	combineInterceptors(List<io.grpc.ClientInterceptor> interceptors)
private static String	expandPercentS(String template, String replacement)
(package private) static Map<String,?>	generateServiceConfigWithMethodConfig(Long timeoutNano, VirtualHost.Route.RouteAction.RetryPolicy retryPolicy)
private static String	getHeaderValue(io.grpc.Metadata headers, String headerName)
String	getServiceAuthority()
(package private) XdsClient	getXdsClient()
(package private) static boolean	matchHostName(String hostName, String pattern)	Returns true iff hostName matches the domain name pattern with case-insensitive.
private static String	prefixedClusterName(String name)
private static String	prefixedClusterSpecifierPluginName(String pluginName)
void	shutdown()
void	start(io.grpc.NameResolver.Listener2 listener)
private void	updateResolutionResult()

Methods inherited from class io.grpc.NameResolver

refresh, start

Methods inherited from class java.lang.Object

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

Field Details

CLUSTER_SELECTION_KEY

static final io.grpc.CallOptions.Key<String> CLUSTER_SELECTION_KEY

RPC_HASH_KEY

static final io.grpc.CallOptions.Key<Long> RPC_HASH_KEY

enableTimeout

static boolean enableTimeout

logId

private final io.grpc.InternalLogId logId

logger

private final XdsLogger logger

targetAuthority

@Nullable
private final String targetAuthority

target

private final String target

serviceAuthority

private final String serviceAuthority

encodedServiceAuthority

private final String encodedServiceAuthority

overrideAuthority

private final String overrideAuthority

serviceConfigParser

private final io.grpc.NameResolver.ServiceConfigParser serviceConfigParser

syncContext

private final io.grpc.SynchronizationContext syncContext

scheduler

private final ScheduledExecutorService scheduler

xdsClientPoolFactory

private final XdsClientPoolFactory xdsClientPoolFactory

random

private final ThreadSafeRandom random

filterRegistry

private final FilterRegistry filterRegistry

hashFunc

private final XxHash64 hashFunc

clusterRefs

private final ConcurrentMap<String,XdsNameResolver.ClusterRefState> clusterRefs

configSelector

private final XdsNameResolver.ConfigSelector configSelector

randomChannelId

private final long randomChannelId

routingConfig

private volatile XdsNameResolver.RoutingConfig routingConfig

listener

private io.grpc.NameResolver.Listener2 listener

xdsClientPool

private io.grpc.internal.ObjectPool<XdsClient> xdsClientPool

xdsClient

private XdsClient xdsClient

callCounterProvider

private XdsNameResolverProvider.CallCounterProvider callCounterProvider

resolveState

private XdsNameResolver.ResolveState resolveState

receivedConfig

private boolean receivedConfig

Constructor Details

XdsNameResolver

XdsNameResolver(URI targetUri,
 String name,
 @Nullable
 String overrideAuthority,
 io.grpc.NameResolver.ServiceConfigParser serviceConfigParser,
 io.grpc.SynchronizationContext syncContext,
 ScheduledExecutorService scheduler,
 @Nullable
 Map<String,?> bootstrapOverride)

XdsNameResolver

XdsNameResolver(URI targetUri,
 @Nullable
 String targetAuthority,
 String name,
 @Nullable
 String overrideAuthority,
 io.grpc.NameResolver.ServiceConfigParser serviceConfigParser,
 io.grpc.SynchronizationContext syncContext,
 ScheduledExecutorService scheduler,
 XdsClientPoolFactory xdsClientPoolFactory,
 ThreadSafeRandom random,
 FilterRegistry filterRegistry,
 @Nullable
 Map<String,?> bootstrapOverride)

Method Details

getServiceAuthority

public String getServiceAuthority()

Specified by:

getServiceAuthority in class io.grpc.NameResolver

start

public void start(io.grpc.NameResolver.Listener2 listener)

Overrides:

start in class io.grpc.NameResolver

expandPercentS

private static String expandPercentS(String template,
 String replacement)

shutdown

public void shutdown()

Specified by:

shutdown in class io.grpc.NameResolver

generateServiceConfigWithMethodConfig

static Map<String,?> generateServiceConfigWithMethodConfig(@Nullable
 Long timeoutNano,
 @Nullable
 VirtualHost.Route.RouteAction.RetryPolicy retryPolicy)

getXdsClient

XdsClient getXdsClient()

updateResolutionResult

private void updateResolutionResult()

matchHostName

static boolean matchHostName(String hostName,
 String pattern)

Returns true iff hostName matches the domain name pattern with case-insensitive.

Wildcard pattern rules:

1. A single asterisk (*) matches any domain.
2. Asterisk (*) is only permitted in the left-most or the right-most part of the pattern, but not both.

combineInterceptors

private static io.grpc.ClientInterceptor combineInterceptors(List<io.grpc.ClientInterceptor> interceptors)

getHeaderValue

@Nullable
private static String getHeaderValue(io.grpc.Metadata headers,
 String headerName)

prefixedClusterName

private static String prefixedClusterName(String name)

prefixedClusterSpecifierPluginName

private static String prefixedClusterSpecifierPluginName(String pluginName)