org.springframework.data.elasticsearch.client.reactive

Interface HostProvider<T extends HostProvider<T>>

public interface HostProvider<T extends HostProvider<T>>

Infrastructure helper class aware of hosts within the cluster and the health of those allowing easy selection of active ones.

Since:

3.2

Author:

Christoph Strobl, Mark Paluch, Peter-Josef Meisch

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	HostProvider.ClusterInformation Value object accumulating information about an Elasticsearch cluster.
static class	HostProvider.Verification HostProvider.Verification allows to influence the lookup strategy for active hosts.

Method Summary

Modifier and Type	Method and Description
reactor.core.publisher.Mono<HostProvider.ClusterInformation>	clusterInfo() Obtain information about known cluster nodes.
WebClient	createWebClient(InetSocketAddress endpoint) Creates a WebClient for endpoint.
default reactor.core.publisher.Mono<WebClient>	getActive() Get the WebClient connecting to an active host utilizing cached ElasticsearchHost.
default reactor.core.publisher.Mono<WebClient>	getActive(HostProvider.Verification verification) Get the WebClient connecting to an active host.
default reactor.core.publisher.Mono<WebClient>	getWebClient() Get the WebClient connecting to an active host utilizing cached ElasticsearchHost.
default reactor.core.publisher.Mono<WebClient>	getWebClient(HostProvider.Verification verification) Get the WebClient connecting to an active host.
default reactor.core.publisher.Mono<InetSocketAddress>	lookupActiveHost() Lookup an active host in lazy mode utilizing cached ElasticsearchHost.
reactor.core.publisher.Mono<InetSocketAddress>	lookupActiveHost(HostProvider.Verification verification) Lookup an active host in using the given HostProvider.Verification.
static HostProvider<?>	provider(WebClientProvider clientProvider, Supplier<HttpHeaders> headersSupplier, InetSocketAddress... endpoints) Create a new HostProvider best suited for the given WebClientProvider and number of hosts.

Method Detail

provider

static HostProvider<?> provider(WebClientProvider clientProvider,
                                Supplier<HttpHeaders> headersSupplier,
                                InetSocketAddress... endpoints)

Create a new HostProvider best suited for the given WebClientProvider and number of hosts.

Parameters:

clientProvider - must not be null .

headersSupplier - to supply custom headers, must not be null

endpoints - must not be null nor empty.

Returns:

new instance of HostProvider.

lookupActiveHost

default reactor.core.publisher.Mono<InetSocketAddress> lookupActiveHost()

Lookup an active host in lazy mode utilizing cached ElasticsearchHost.

Returns:

the Mono emitting the active host or an error if none found.

lookupActiveHost

reactor.core.publisher.Mono<InetSocketAddress> lookupActiveHost(HostProvider.Verification verification)

Lookup an active host in using the given HostProvider.Verification.

Parameters:

verification -

Returns:

the Mono emitting the active host or an error (NoReachableHostException) if none found.

getActive

default reactor.core.publisher.Mono<WebClient> getActive()

Get the WebClient connecting to an active host utilizing cached ElasticsearchHost.

Returns:

the Mono emitting the client for an active host or an error if none found.

getActive

default reactor.core.publisher.Mono<WebClient> getActive(HostProvider.Verification verification)

Get the WebClient connecting to an active host.

Parameters:

verification - must not be null.

Returns:

the Mono emitting the client for an active host or an error if none found.

getWebClient

default reactor.core.publisher.Mono<WebClient> getWebClient()

Get the WebClient connecting to an active host utilizing cached ElasticsearchHost.

Returns:

the Mono emitting the client for an active host or an error if none found.

Since:

4.4

getWebClient

default reactor.core.publisher.Mono<WebClient> getWebClient(HostProvider.Verification verification)

Get the WebClient connecting to an active host.

Parameters:

verification - must not be null.

Returns:

the Mono emitting the client for an active host or an error if none found.

Since:

4.4

createWebClient

WebClient createWebClient(InetSocketAddress endpoint)

Creates a WebClient for endpoint.

Parameters:

endpoint - must not be null.

Returns:

a WebClient using the the given endpoint as transport url.

clusterInfo

reactor.core.publisher.Mono<HostProvider.ClusterInformation> clusterInfo()

Obtain information about known cluster nodes.

Returns:

the Mono emitting HostProvider.ClusterInformation when available.