Top Description Constructors Methods
io.grpc

public abstract Class NameResolverProvider

extends Factory
Class Inheritance
Annotations
@ExperimentalApi:https://github.com/grpc/grpc-java/issues/4159
Imports
io.grpc.NameResolver.Factory, java.net.InetSocketAddress, .SocketAddress, java.util.Collection, .Collections
Provider of name resolvers for name agnostic consumption.

Implementations can be automatically discovered by gRPC via Java's SPI mechanism. For automatic discovery, the implementation must have a zero-argument constructor and include a resource named META-INF/services/io.grpc.NameResolverProvider in their JAR. The file's contents should be the implementation's class name. Implementations that need arguments in their constructor can be manually registered by NameResolverRegistry#register.

Implementations should not throw. If they do, it may interrupt class loading. If exceptions may reasonably occur for implementation-specific reasons, implementations should generally handle the exception gracefully and return false from isAvailable().

Constructor Summary

AccessConstructor and Description
public
NameResolverProvider()

Method Summary

Modifier and TypeMethod and Description
public Collection<Class<? extends SocketAddress>>

Returns:

the SocketAddress types this provider's name-resolver is capable of producing.
getProducedSocketAddressTypes()

Returns the SocketAddress types this provider's name-resolver is capable of producing.

protected String
getScheme()

Returns the scheme associated with the provider.

protected abstract boolean
isAvailable()

Whether this provider is available for use, taking the current environment into consideration.

protected abstract int
priority()

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration.

Inherited from io.grpc.NameResolver.Factory:
getDefaultSchemenewNameResolver

Constructor Detail

NameResolverProviderback to summary
public NameResolverProvider()

Method Detail

getProducedSocketAddressTypesback to summary
public Collection<Class<? extends SocketAddress>> getProducedSocketAddressTypes()

Returns the SocketAddress types this provider's name-resolver is capable of producing. This enables selection of the appropriate ManagedChannelProvider for a channel.

Returns:Collection<Class<? extends SocketAddress>>

the SocketAddress types this provider's name-resolver is capable of producing.

getSchemeback to summary
protected String getScheme()

Returns the scheme associated with the provider. The provider normally should only create a NameResolver when target URI scheme matches the provider scheme. It temporarily delegates to Factory#getDefaultScheme() before NameResolver.Factory is deprecated in https://github.com/grpc/grpc-java/issues/7133.

The scheme should be lower-case.

Since
1.40.0
isAvailableback to summary
protected abstract boolean isAvailable()

Whether this provider is available for use, taking the current environment into consideration. If false, no other methods are safe to be called.

Since
1.0.0
priorityback to summary
protected abstract int priority()

A priority, from 0 to 10 that this provider should be used, taking the current environment into consideration. 5 should be considered the default, and then tweaked based on environment detection. A priority of 0 does not imply that the provider wouldn't work; just that it should be last in line.

Since
1.0.0