Class XdsRouteConfigureResource

java.lang.Object

io.grpc.xds.client.XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

io.grpc.xds.XdsRouteConfigureResource

class XdsRouteConfigureResource
extends XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	XdsRouteConfigureResource.RdsUpdate

Nested classes/interfaces inherited from class XdsResourceType

XdsResourceType.Args, XdsResourceType.ResourceInvalidException, XdsResourceType.StructOrError<T>

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final String	ADS_TYPE_URL_RDS
(package private) static boolean	enableRouteLookup
private static final XdsRouteConfigureResource	instance
private static final Set<io.grpc.Status.Code>	SUPPORTED_RETRYABLE_CODES
private static final String	TYPE_URL_FILTER_CONFIG

Fields inherited from class XdsResourceType

HASH_POLICY_FILTER_STATE_KEY, TRANSPORT_SOCKET_NAME_TLS, TYPE_URL_CLUSTER_CONFIG, TYPE_URL_TYPED_STRUCT, TYPE_URL_TYPED_STRUCT_UDPA

Constructor Summary

Constructors

Constructor	Description
XdsRouteConfigureResource()

Method Summary

Modifier and Type	Method	Description
protected XdsRouteConfigureResource.RdsUpdate	doParse(XdsResourceType.Args args, com.google.protobuf.Message unpackedMessage)
protected String	extractResourceName(com.google.protobuf.Message unpackedResource)	Extract the resource name from an older resource type that included the name within the resource contents itself.
(package private) static List<VirtualHost>	extractVirtualHosts(RouteConfiguration routeConfig, FilterRegistry filterRegistry)
(package private) static XdsRouteConfigureResource	getInstance()
protected boolean	isFullStateOfTheWorld()
private static ClusterSpecifierPlugin.PluginConfig	parseClusterSpecifierPlugin(ClusterSpecifierPlugin pluginProto)
(package private) static ClusterSpecifierPlugin.PluginConfig	parseClusterSpecifierPlugin(ClusterSpecifierPlugin pluginProto, ClusterSpecifierPluginRegistry registry)
(package private) static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction.ClusterWeight>	parseClusterWeight(WeightedCluster.ClusterWeight proto, FilterRegistry filterRegistry)
private static XdsResourceType.StructOrError<Matchers.FractionMatcher>	parseFractionMatcher(FractionalPercent proto)
(package private) static XdsResourceType.StructOrError<Matchers.HeaderMatcher>	parseHeaderMatcher(HeaderMatcher proto)
(package private) static XdsResourceType.StructOrError<Map<String, Filter.FilterConfig>>	parseOverrideFilterConfigs(Map<String, com.google.protobuf.Any> rawFilterConfigMap, FilterRegistry filterRegistry)
(package private) static XdsResourceType.StructOrError<VirtualHost.Route.RouteMatch.PathMatcher>	parsePathMatcher(RouteMatch proto)
private static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction.RetryPolicy>	parseRetryPolicy(RetryPolicy retryPolicyProto)
(package private) static XdsResourceType.StructOrError<VirtualHost.Route>	parseRoute(Route proto, FilterRegistry filterRegistry, Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap, Set<String> optionalPlugins)
(package private) static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction>	parseRouteAction(RouteAction proto, FilterRegistry filterRegistry, Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap, Set<String> optionalPlugins)	Parses the RouteAction config.
(package private) static XdsResourceType.StructOrError<VirtualHost.Route.RouteMatch>	parseRouteMatch(RouteMatch proto)
private static XdsResourceType.StructOrError<VirtualHost>	parseVirtualHost(VirtualHost proto, FilterRegistry filterRegistry, Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap, Set<String> optionalPlugins)
private static XdsRouteConfigureResource.RdsUpdate	processRouteConfiguration(RouteConfiguration routeConfig, FilterRegistry filterRegistry)
boolean	shouldRetrieveResourceKeysForArgs()
String	typeName()
String	typeUrl()
protected Class<RouteConfiguration>	unpackedClassName()

Methods inherited from class XdsResourceType

unpackCompatibleType

Methods inherited from class Object

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

Field Details

enableRouteLookup

static boolean enableRouteLookup

ADS_TYPE_URL_RDS

static final String ADS_TYPE_URL_RDS

See Also:

• Constant Field Values

TYPE_URL_FILTER_CONFIG

private static final String TYPE_URL_FILTER_CONFIG

See Also:

• Constant Field Values

SUPPORTED_RETRYABLE_CODES

private static final Set<io.grpc.Status.Code> SUPPORTED_RETRYABLE_CODES

instance

private static final XdsRouteConfigureResource instance

Constructor Details

XdsRouteConfigureResource

XdsRouteConfigureResource()

Method Details

getInstance

static XdsRouteConfigureResource getInstance()

extractResourceName

@Nullable
protected String extractResourceName(com.google.protobuf.Message unpackedResource)

Description copied from class: XdsResourceType

Extract the resource name from an older resource type that included the name within the resource contents itself. The newer approach has resources wrapped with envoy.service.discovery.v3.Resource which then provides the name. This method is only called for the old approach.

Overrides:

extractResourceName in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

Returns:

the resource's name, or null if name is not stored within the resource contents

typeName

public String typeName()

Specified by:

typeName in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

typeUrl

public String typeUrl()

Specified by:

typeUrl in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

shouldRetrieveResourceKeysForArgs

public boolean shouldRetrieveResourceKeysForArgs()

Specified by:

shouldRetrieveResourceKeysForArgs in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

isFullStateOfTheWorld

protected boolean isFullStateOfTheWorld()

Specified by:

isFullStateOfTheWorld in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

unpackedClassName

protected Class<RouteConfiguration> unpackedClassName()

Specified by:

unpackedClassName in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

doParse

protected XdsRouteConfigureResource.RdsUpdate doParse(XdsResourceType.Args args,
 com.google.protobuf.Message unpackedMessage)
                                               throws XdsResourceType.ResourceInvalidException

Specified by:

doParse in class XdsResourceType<XdsRouteConfigureResource.RdsUpdate>

Throws:

XdsResourceType.ResourceInvalidException

processRouteConfiguration

private static XdsRouteConfigureResource.RdsUpdate processRouteConfiguration(RouteConfiguration routeConfig,
 FilterRegistry filterRegistry)
                                                                      throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

extractVirtualHosts

static List<VirtualHost> extractVirtualHosts(RouteConfiguration routeConfig,
 FilterRegistry filterRegistry)
                                      throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

parseVirtualHost

private static XdsResourceType.StructOrError<VirtualHost> parseVirtualHost(VirtualHost proto,
 FilterRegistry filterRegistry,
 Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap,
 Set<String> optionalPlugins)

parseOverrideFilterConfigs

static XdsResourceType.StructOrError<Map<String, Filter.FilterConfig>> parseOverrideFilterConfigs(Map<String, com.google.protobuf.Any> rawFilterConfigMap,
 FilterRegistry filterRegistry)

parseRoute

@Nullable
static XdsResourceType.StructOrError<VirtualHost.Route> parseRoute(Route proto,
 FilterRegistry filterRegistry,
 Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap,
 Set<String> optionalPlugins)

parseRouteMatch

@Nullable
static XdsResourceType.StructOrError<VirtualHost.Route.RouteMatch> parseRouteMatch(RouteMatch proto)

parsePathMatcher

static XdsResourceType.StructOrError<VirtualHost.Route.RouteMatch.PathMatcher> parsePathMatcher(RouteMatch proto)

parseFractionMatcher

private static XdsResourceType.StructOrError<Matchers.FractionMatcher> parseFractionMatcher(FractionalPercent proto)

parseHeaderMatcher

static XdsResourceType.StructOrError<Matchers.HeaderMatcher> parseHeaderMatcher(HeaderMatcher proto)

parseRouteAction

@Nullable
static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction> parseRouteAction(RouteAction proto,
 FilterRegistry filterRegistry,
 Map<String, ClusterSpecifierPlugin.PluginConfig> pluginConfigMap,
 Set<String> optionalPlugins)

Parses the RouteAction config. The returned result may contain a (parsed form) VirtualHost.Route.RouteAction or an error message. Returns null if the RouteAction should be ignored.

parseRetryPolicy

@Nullable
private static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction.RetryPolicy> parseRetryPolicy(RetryPolicy retryPolicyProto)

parseClusterWeight

static XdsResourceType.StructOrError<VirtualHost.Route.RouteAction.ClusterWeight> parseClusterWeight(WeightedCluster.ClusterWeight proto,
 FilterRegistry filterRegistry)

parseClusterSpecifierPlugin

@Nullable
private static ClusterSpecifierPlugin.PluginConfig parseClusterSpecifierPlugin(ClusterSpecifierPlugin pluginProto)
                                                                        throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

parseClusterSpecifierPlugin

@Nullable
static ClusterSpecifierPlugin.PluginConfig parseClusterSpecifierPlugin(ClusterSpecifierPlugin pluginProto,
 ClusterSpecifierPluginRegistry registry)
                                                                throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException