Class ServiceInstanceListSupplierBuilder

java.lang.Object

org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplierBuilder

public final class ServiceInstanceListSupplierBuilder
extends Object

A Builder for creating a ServiceInstanceListSupplier hierarchy to be used in ReactorLoadBalancer configuration.

Author:

Spencer Gibb, Olga Maciaszek-Sharma, Zhiguo Chen, Sabyasachi Bhattacharya, Zhuozhi Ji

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ServiceInstanceListSupplierBuilder.Creator	Allows creating a ServiceInstanceListSupplier instance based on provided ConfigurableApplicationContext.
static interface	ServiceInstanceListSupplierBuilder.DelegateCreator	Allows creating a ServiceInstanceListSupplier instance based on provided ConfigurableApplicationContext and another ServiceInstanceListSupplier instance that will be used as a delegate.

Method Summary

Modifier and Type	Method	Description
ServiceInstanceListSupplier	build(org.springframework.context.ConfigurableApplicationContext context)	Builds the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	with(@Nullable ServiceInstanceListSupplierBuilder.DelegateCreator delegateCreator)	Support ServiceInstanceListSupplierBuilder can be added to the expansion implementation of ServiceInstanceListSupplier by this method.
ServiceInstanceListSupplierBuilder	withBase(ServiceInstanceListSupplier supplier)	Sets a user-provided ServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
ServiceInstanceListSupplierBuilder	withBlockingApiVersioning()
ServiceInstanceListSupplierBuilder	withBlockingDiscoveryClient()	Sets a blocking DiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
ServiceInstanceListSupplierBuilder	withBlockingHealthChecks()	Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withBlockingHealthChecks(org.springframework.web.client.RestClient restClient)	Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestClient instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withBlockingHealthChecks(org.springframework.web.client.RestTemplate restTemplate)	Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withBlockingRestClientHealthChecks()	Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestClient instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withCaching()	If LoadBalancerCacheManager is available in the context, adds a CachingServiceInstanceListSupplier instance to the ServiceInstanceListSupplier hierarchy to provide a caching mechanism for service instances.
ServiceInstanceListSupplierBuilder	withDiscoveryClient()	Sets a ReactiveDiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.
ServiceInstanceListSupplierBuilder	withHealthChecks()	Adds a HealthCheckServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withHealthChecks(org.springframework.web.reactive.function.client.WebClient webClient)	Adds a HealthCheckServiceInstanceListSupplier that uses user-provided WebClient instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withHints()
ServiceInstanceListSupplierBuilder	withReactiveApiVersioning()
ServiceInstanceListSupplierBuilder	withRequestBasedStickySession()	Adds a RequestBasedStickySessionServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withRetryAwareness()
ServiceInstanceListSupplierBuilder	withSameInstancePreference()	Adds a SameInstancePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withSubset()
ServiceInstanceListSupplierBuilder	withWeighted()	Adds a WeightedServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withWeighted(WeightFunction weightFunction)	Adds a WeightedServiceInstanceListSupplier that uses user-provided WeightFunction instance to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withZonePreference()	Adds a ZonePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.
ServiceInstanceListSupplierBuilder	withZonePreference(String zoneName)	Adds a ZonePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Methods inherited from class Object

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

Method Details

withBlockingDiscoveryClient

public ServiceInstanceListSupplierBuilder withBlockingDiscoveryClient()

Sets a blocking DiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withDiscoveryClient

public ServiceInstanceListSupplierBuilder withDiscoveryClient()

Sets a ReactiveDiscoveryClient-based DiscoveryClientServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withBase

public ServiceInstanceListSupplierBuilder withBase(ServiceInstanceListSupplier supplier)

Sets a user-provided ServiceInstanceListSupplier as a base ServiceInstanceListSupplier in the hierarchy.

Parameters:

supplier - a user-provided ServiceInstanceListSupplier instance

Returns:

the ServiceInstanceListSupplierBuilder object

withWeighted

public ServiceInstanceListSupplierBuilder withWeighted()

Adds a WeightedServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withWeighted

public ServiceInstanceListSupplierBuilder withWeighted(WeightFunction weightFunction)

Adds a WeightedServiceInstanceListSupplier that uses user-provided WeightFunction instance to the ServiceInstanceListSupplier hierarchy.

Parameters:

weightFunction - a user-provided WeightFunction instance

Returns:

the ServiceInstanceListSupplierBuilder object

withHealthChecks

public ServiceInstanceListSupplierBuilder withHealthChecks()

Adds a HealthCheckServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withHealthChecks

public ServiceInstanceListSupplierBuilder withHealthChecks(org.springframework.web.reactive.function.client.WebClient webClient)

Adds a HealthCheckServiceInstanceListSupplier that uses user-provided WebClient instance to the ServiceInstanceListSupplier hierarchy.

Parameters:

webClient - a user-provided WebClient instance

Returns:

the ServiceInstanceListSupplierBuilder object

withSameInstancePreference

public ServiceInstanceListSupplierBuilder withSameInstancePreference()

Adds a SameInstancePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withBlockingHealthChecks

public ServiceInstanceListSupplierBuilder withBlockingHealthChecks()

Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withBlockingRestClientHealthChecks

public ServiceInstanceListSupplierBuilder withBlockingRestClientHealthChecks()

Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestClient instance to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withBlockingHealthChecks

public ServiceInstanceListSupplierBuilder withBlockingHealthChecks(org.springframework.web.client.RestTemplate restTemplate)

Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestTemplate instance to the ServiceInstanceListSupplier hierarchy.

Parameters:

restTemplate - a user-provided RestTemplate instance

Returns:

the ServiceInstanceListSupplierBuilder object

withBlockingHealthChecks

public ServiceInstanceListSupplierBuilder withBlockingHealthChecks(org.springframework.web.client.RestClient restClient)

Adds a HealthCheckServiceInstanceListSupplier that uses user-provided RestClient instance to the ServiceInstanceListSupplier hierarchy.

Parameters:

restClient - a user-provided RestClient instance

Returns:

the ServiceInstanceListSupplierBuilder object

withZonePreference

public ServiceInstanceListSupplierBuilder withZonePreference()

Adds a ZonePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withZonePreference

public ServiceInstanceListSupplierBuilder withZonePreference(String zoneName)

Adds a ZonePreferenceServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Parameters:

zoneName - desired zone for zone preference

Returns:

the ServiceInstanceListSupplierBuilder object

withRequestBasedStickySession

public ServiceInstanceListSupplierBuilder withRequestBasedStickySession()

Adds a RequestBasedStickySessionServiceInstanceListSupplier to the ServiceInstanceListSupplier hierarchy.

Returns:

the ServiceInstanceListSupplierBuilder object

withCaching

public ServiceInstanceListSupplierBuilder withCaching()

If LoadBalancerCacheManager is available in the context, adds a CachingServiceInstanceListSupplier instance to the ServiceInstanceListSupplier hierarchy to provide a caching mechanism for service instances. Uses ObjectProvider to lazily resolve LoadBalancerCacheManager.

Returns:

the ServiceInstanceListSupplierBuilder object

withRetryAwareness

public ServiceInstanceListSupplierBuilder withRetryAwareness()

withHints

public ServiceInstanceListSupplierBuilder withHints()

withSubset

public ServiceInstanceListSupplierBuilder withSubset()

withReactiveApiVersioning

public ServiceInstanceListSupplierBuilder withReactiveApiVersioning()

withBlockingApiVersioning

public ServiceInstanceListSupplierBuilder withBlockingApiVersioning()

with

public ServiceInstanceListSupplierBuilder with(@Nullable ServiceInstanceListSupplierBuilder.DelegateCreator delegateCreator)

Support ServiceInstanceListSupplierBuilder can be added to the expansion implementation of ServiceInstanceListSupplier by this method.

Parameters:

delegateCreator - a ServiceInstanceListSupplierBuilder.DelegateCreator object

Returns:

the ServiceInstanceListSupplierBuilder object

build

public ServiceInstanceListSupplier build(org.springframework.context.ConfigurableApplicationContext context)

Builds the ServiceInstanceListSupplier hierarchy.

Parameters:

context - application context

Returns:

a ServiceInstanceListSupplier instance on top of the delegate hierarchy