net.devh.boot.grpc.client.nameresolver

Class DiscoveryClientResolverFactory

java.lang.Object

io.grpc.NameResolver.Factory

io.grpc.NameResolverProvider

net.devh.boot.grpc.client.nameresolver.DiscoveryClientResolverFactory

public class DiscoveryClientResolverFactory
extends io.grpc.NameResolverProvider

A name resolver factory that will create a DiscoveryClientNameResolver based on the target uri.

Field Summary

Fields

Modifier and Type	Field and Description
static io.grpc.Attributes.Key<String>	DISCOVERY_INSTANCE_ID_KEY A key for the instance id.
static String	DISCOVERY_SCHEME The constant containing the scheme that will be used by this factory.
static io.grpc.Attributes.Key<String>	DISCOVERY_SERVICE_NAME_KEY A key for the service name used to related ServiceInstances from the DiscoveryClient.

Constructor Summary

Constructors

Constructor and Description
DiscoveryClientResolverFactory(org.springframework.cloud.client.discovery.DiscoveryClient client) Creates a new discovery client based name resolver factory.

Method Summary

Modifier and Type	Method and Description
void	destroy() Cleans up the name resolvers.
String	getDefaultScheme()
void	heartbeat(org.springframework.cloud.client.discovery.event.HeartbeatEvent event) Triggers a refresh of the registered name resolvers.
protected boolean	isAvailable()
protected DiscoveryClientNameResolver	newNameResolver(String serviceName, io.grpc.NameResolver.Args args) Factory method to create the resolver for the given service name.
io.grpc.NameResolver	newNameResolver(URI targetUri, io.grpc.NameResolver.Args args)
protected int	priority()
String	toString()

Methods inherited from class io.grpc.NameResolverProvider

getProducedSocketAddressTypes, getScheme

Methods inherited from class java.lang.Object

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

Field Detail

DISCOVERY_SCHEME

public static final String DISCOVERY_SCHEME

The constant containing the scheme that will be used by this factory.

See Also:

Constant Field Values

DISCOVERY_SERVICE_NAME_KEY

public static final io.grpc.Attributes.Key<String> DISCOVERY_SERVICE_NAME_KEY

A key for the service name used to related ServiceInstances from the DiscoveryClient.

DISCOVERY_INSTANCE_ID_KEY

public static final io.grpc.Attributes.Key<String> DISCOVERY_INSTANCE_ID_KEY

A key for the instance id.

Constructor Detail

DiscoveryClientResolverFactory

public DiscoveryClientResolverFactory(org.springframework.cloud.client.discovery.DiscoveryClient client)

Creates a new discovery client based name resolver factory.

Parameters:

client - The client to use for the address discovery.

Method Detail

newNameResolver

@Nullable
public io.grpc.NameResolver newNameResolver(URI targetUri,
                                                      io.grpc.NameResolver.Args args)

Specified by:

newNameResolver in class io.grpc.NameResolver.Factory

newNameResolver

protected DiscoveryClientNameResolver newNameResolver(String serviceName,
                                                      io.grpc.NameResolver.Args args)

Factory method to create the resolver for the given service name.

Parameters:

serviceName - The service name to create it for.

args - The NameResolver arguments to use.

Returns:

A newly created DiscoveryClientNameResolver.

getDefaultScheme

public String getDefaultScheme()

Specified by:

getDefaultScheme in class io.grpc.NameResolver.Factory

isAvailable

protected boolean isAvailable()

Specified by:

isAvailable in class io.grpc.NameResolverProvider

priority

protected int priority()

Specified by:

priority in class io.grpc.NameResolverProvider

heartbeat

@EventListener(value=org.springframework.cloud.client.discovery.event.HeartbeatEvent.class)
public void heartbeat(org.springframework.cloud.client.discovery.event.HeartbeatEvent event)

Triggers a refresh of the registered name resolvers.

Parameters:

event - The event that triggered the update.

destroy

@PreDestroy
public void destroy()

Cleans up the name resolvers.

toString

public String toString()

Overrides:

toString in class Object