io.grpc

Class NameResolver.Factory

java.lang.Object

io.grpc.NameResolver.Factory

Direct Known Subclasses:

NameResolverProvider

Enclosing class:

NameResolver

public abstract static class NameResolver.Factory
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static Attributes.Key<Integer>	PARAMS_DEFAULT_PORT The port number used in case the target or the underlying naming system doesn't provide a port number.

Constructor Summary

Constructors

Constructor and Description
Factory()

Method Summary

Modifier and Type	Method and Description
abstract String	getDefaultScheme() Returns the default scheme, which will be used to construct a URI when ManagedChannelBuilder.forTarget(String) is given an authority string instead of a compliant URI.
abstract NameResolver	newNameResolver(URI targetUri, Attributes params) Creates a NameResolver for the given target URI, or null if the given URI cannot be resolved by this factory.

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS_DEFAULT_PORT

public static final Attributes.Key<Integer> PARAMS_DEFAULT_PORT

The port number used in case the target or the underlying naming system doesn't provide a port number.

Constructor Detail

Factory

public Factory()

Method Detail

newNameResolver

@Nullable
public abstract NameResolver newNameResolver(URI targetUri,
                                                       Attributes params)

Creates a NameResolver for the given target URI, or null if the given URI cannot be resolved by this factory. The decision should be solely based on the scheme of the URI.

Parameters:

targetUri - the target URI to be resolved, whose scheme must not be null

params - optional parameters. Canonical keys are defined as PARAMS_* fields in NameResolver.Factory.

getDefaultScheme

public abstract String getDefaultScheme()

Returns the default scheme, which will be used to construct a URI when ManagedChannelBuilder.forTarget(String) is given an authority string instead of a compliant URI.