org.springframework.cloud.client.discovery

Interface ReactiveDiscoveryClient

All Superinterfaces:

org.springframework.core.Ordered

All Known Implementing Classes:

ReactiveCompositeDiscoveryClient, SimpleReactiveDiscoveryClient

public interface ReactiveDiscoveryClient
extends org.springframework.core.Ordered

Represents read operations commonly available to discovery services such as Netflix Eureka or consul.io.

Author:

Tim Ysewyn, Olga Maciaszek-Sharma

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_ORDER Default order of the discovery client.
static org.apache.commons.logging.Log	LOG

Fields inherited from interface org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Method Summary

Modifier and Type	Method and Description
String	description() A human-readable description of the implementation, used in HealthIndicator.
reactor.core.publisher.Flux<ServiceInstance>	getInstances(String serviceId) Gets all ServiceInstances associated with a particular serviceId.
default int	getOrder() Default implementation for getting order of discovery clients.
reactor.core.publisher.Flux<String>	getServices()
default void	probe() Deprecated. in favour of reactiveProbe(). This method should not be used as is, as it contains a bug - the method called within returns a Flux, which is not accessible for subscription or blocking from within. We are leaving it with a deprecation in order not to bring downstream implementations.
default reactor.core.publisher.Mono<Void>	reactiveProbe() Can be used to verify the client is still valid and able to make calls.

Field Detail

LOG

static final org.apache.commons.logging.Log LOG

DEFAULT_ORDER

static final int DEFAULT_ORDER

Default order of the discovery client.

See Also:

Constant Field Values

Method Detail

description

String description()

A human-readable description of the implementation, used in HealthIndicator.

Returns:

The description.

getInstances

reactor.core.publisher.Flux<ServiceInstance> getInstances(String serviceId)

Gets all ServiceInstances associated with a particular serviceId.

Parameters:

serviceId - The serviceId to query.

Returns:

A List of ServiceInstance.

getServices

reactor.core.publisher.Flux<String> getServices()

Returns:

All known service IDs.

probe

@Deprecated
default void probe()

Deprecated. in favour of reactiveProbe(). This method should not be used as is, as it contains a bug - the method called within returns a Flux, which is not accessible for subscription or blocking from within. We are leaving it with a deprecation in order not to bring downstream implementations.

Can be used to verify the client is still valid and able to make calls.

A successful invocation with no exception thrown implies the client is able to make calls.

The default implementation simply calls getServices() - client implementations can override with a lighter weight operation if they choose to.

reactiveProbe

default reactor.core.publisher.Mono<Void> reactiveProbe()

Can be used to verify the client is still valid and able to make calls.

A successful invocation with no exception thrown implies the client is able to make calls.

The default implementation simply calls getServices() and wraps it with a Mono - client implementations can override with a lighter weight operation if they choose to.

getOrder

default int getOrder()

Default implementation for getting order of discovery clients.

Specified by:

getOrder in interface org.springframework.core.Ordered

Returns:

order