io.grpc

Class NameResolver.Factory

java.lang.Object

io.grpc.NameResolver.Factory

Direct Known Subclasses:

NameResolverProvider

Enclosing class:

NameResolver

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/1770")
public abstract static class NameResolver.Factory
extends Object

Factory that creates NameResolver instances.

Since:

1.0.0

Field Summary

Fields

Modifier and Type	Field and Description
static Attributes.Key<Integer>	PARAMS_DEFAULT_PORT Deprecated. this will be deleted along with newNameResolver(URI, Attributes) in a future release.
static Attributes.Key<ProxyDetector>	PARAMS_PROXY_DETECTOR Deprecated. this will be deleted along with newNameResolver(URI, Attributes) in a future release

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.
NameResolver	newNameResolver(URI targetUri, Attributes params) Deprecated. Implement newNameResolver(URI, NameResolver.Helper) instead. This is going to be deleted in a future release.
NameResolver	newNameResolver(URI targetUri, NameResolver.Args args) Creates a NameResolver for the given target URI, or null if the given URI cannot be resolved by this factory.
NameResolver	newNameResolver(URI targetUri, NameResolver.Helper helper) Deprecated. implement newNameResolver(URI, NameResolver.Args) instead

Methods inherited from class java.lang.Object

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

Field Detail

PARAMS_DEFAULT_PORT

@Deprecated
public static final Attributes.Key<Integer> PARAMS_DEFAULT_PORT

Deprecated. this will be deleted along with newNameResolver(URI, Attributes) in a future release.

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

Since:

1.0.0

PARAMS_PROXY_DETECTOR

@ExperimentalApi(value="https://github.com/grpc/grpc-java/issues/5113")
 @Deprecated
public static final Attributes.Key<ProxyDetector> PARAMS_PROXY_DETECTOR

Deprecated. this will be deleted along with newNameResolver(URI, Attributes) in a future release

If the NameResolver wants to support proxy, it should inquire this ProxyDetector. See documentation on ProxyDetector about how proxies work in gRPC.

Constructor Detail

Factory

public Factory()

Method Detail

newNameResolver

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

Deprecated. Implement newNameResolver(URI, NameResolver.Helper) instead. This is going to be deleted in a future release.

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.

Since:

1.0.0

newNameResolver

@Deprecated
 @Nullable
public NameResolver newNameResolver(URI targetUri,
                                                           NameResolver.Helper helper)

Deprecated. implement newNameResolver(URI, NameResolver.Args) instead

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

helper - utility that may be used by the NameResolver implementation

Since:

1.19.0

newNameResolver

public NameResolver newNameResolver(URI targetUri,
                                    NameResolver.Args args)

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

args - other information that may be useful

Since:

1.21.0

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.

Since:

1.0.0