Class XdsClusterResource

java.lang.Object

io.grpc.xds.client.XdsResourceType<XdsClusterResource.CdsUpdate>

io.grpc.xds.XdsClusterResource

class XdsClusterResource
extends XdsResourceType<XdsClusterResource.CdsUpdate>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	XdsClusterResource.CdsUpdate	xDS resource update for cluster-level configuration.

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_CDS
(package private) static final String	AGGREGATE_CLUSTER_TYPE_NAME
(package private) static boolean	enableLeastRequest
private static final XdsClusterResource	instance
private final io.grpc.LoadBalancerRegistry	loadBalancerRegistry
private static final String	TYPE_URL_UPSTREAM_TLS_CONTEXT
private static final String	TYPE_URL_UPSTREAM_TLS_CONTEXT_V2

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
XdsClusterResource()

Method Summary

Modifier and Type	Method	Description
protected XdsClusterResource.CdsUpdate	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.
private static String	getIdentityCertInstanceName(CommonTlsContext commonTlsContext)
static XdsClusterResource	getInstance()
private static String	getRootCertInstanceName(CommonTlsContext commonTlsContext)
(package private) static boolean	hasNegativeValues(com.google.protobuf.Duration duration)
protected boolean	isFullStateOfTheWorld()
private static XdsResourceType.StructOrError<XdsClusterResource.CdsUpdate.Builder>	parseAggregateCluster(Cluster cluster)
private static XdsResourceType.StructOrError<XdsClusterResource.CdsUpdate.Builder>	parseNonAggregateCluster(Cluster cluster, Set<String> certProviderInstances, Bootstrapper.ServerInfo serverInfo)
(package private) static XdsClusterResource.CdsUpdate	processCluster(Cluster cluster, Set<String> certProviderInstances, Bootstrapper.ServerInfo serverInfo, io.grpc.LoadBalancerRegistry loadBalancerRegistry)
boolean	shouldRetrieveResourceKeysForArgs()
String	typeName()
String	typeUrl()
protected Class<Cluster>	unpackedClassName()
(package private) static void	validateCommonTlsContext(CommonTlsContext commonTlsContext, Set<String> certProviderInstances, boolean server)
(package private) static OutlierDetection	validateOutlierDetection(OutlierDetection outlierDetection)
(package private) static UpstreamTlsContext	validateUpstreamTlsContext(UpstreamTlsContext upstreamTlsContext, Set<String> certProviderInstances)

Methods inherited from class XdsResourceType

unpackCompatibleType

Methods inherited from class Object

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

Field Details

enableLeastRequest

static boolean enableLeastRequest

AGGREGATE_CLUSTER_TYPE_NAME

static final String AGGREGATE_CLUSTER_TYPE_NAME

See Also:

• Constant Field Values

ADS_TYPE_URL_CDS

static final String ADS_TYPE_URL_CDS

See Also:

• Constant Field Values

TYPE_URL_UPSTREAM_TLS_CONTEXT

private static final String TYPE_URL_UPSTREAM_TLS_CONTEXT

See Also:

• Constant Field Values

TYPE_URL_UPSTREAM_TLS_CONTEXT_V2

private static final String TYPE_URL_UPSTREAM_TLS_CONTEXT_V2

See Also:

• Constant Field Values

loadBalancerRegistry

private final io.grpc.LoadBalancerRegistry loadBalancerRegistry

instance

private static final XdsClusterResource instance

Constructor Details

XdsClusterResource

XdsClusterResource()

Method Details

getInstance

public static XdsClusterResource 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<XdsClusterResource.CdsUpdate>

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<XdsClusterResource.CdsUpdate>

typeUrl

public String typeUrl()

Specified by:

typeUrl in class XdsResourceType<XdsClusterResource.CdsUpdate>

shouldRetrieveResourceKeysForArgs

public boolean shouldRetrieveResourceKeysForArgs()

Specified by:

shouldRetrieveResourceKeysForArgs in class XdsResourceType<XdsClusterResource.CdsUpdate>

isFullStateOfTheWorld

protected boolean isFullStateOfTheWorld()

Specified by:

isFullStateOfTheWorld in class XdsResourceType<XdsClusterResource.CdsUpdate>

unpackedClassName

protected Class<Cluster> unpackedClassName()

Specified by:

unpackedClassName in class XdsResourceType<XdsClusterResource.CdsUpdate>

doParse

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

Specified by:

doParse in class XdsResourceType<XdsClusterResource.CdsUpdate>

Throws:

XdsResourceType.ResourceInvalidException

processCluster

static XdsClusterResource.CdsUpdate processCluster(Cluster cluster,
 Set<String> certProviderInstances,
 Bootstrapper.ServerInfo serverInfo,
 io.grpc.LoadBalancerRegistry loadBalancerRegistry)
                                            throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

parseAggregateCluster

private static XdsResourceType.StructOrError<XdsClusterResource.CdsUpdate.Builder> parseAggregateCluster(Cluster cluster)

parseNonAggregateCluster

private static XdsResourceType.StructOrError<XdsClusterResource.CdsUpdate.Builder> parseNonAggregateCluster(Cluster cluster,
 Set<String> certProviderInstances,
 Bootstrapper.ServerInfo serverInfo)

validateOutlierDetection

static OutlierDetection validateOutlierDetection(OutlierDetection outlierDetection)
                                          throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

hasNegativeValues

static boolean hasNegativeValues(com.google.protobuf.Duration duration)

validateUpstreamTlsContext

static UpstreamTlsContext validateUpstreamTlsContext(UpstreamTlsContext upstreamTlsContext,
 Set<String> certProviderInstances)
                                              throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

validateCommonTlsContext

static void validateCommonTlsContext(CommonTlsContext commonTlsContext,
 Set<String> certProviderInstances,
 boolean server)
                              throws XdsResourceType.ResourceInvalidException

Throws:

XdsResourceType.ResourceInvalidException

getIdentityCertInstanceName

private static String getIdentityCertInstanceName(CommonTlsContext commonTlsContext)

getRootCertInstanceName

private static String getRootCertInstanceName(CommonTlsContext commonTlsContext)