io.grpc

Class NameResolver.Helper

java.lang.Object

io.grpc.NameResolver.Helper

Enclosing class:

NameResolver

public abstract static class NameResolver.Helper
extends Object

A utility object passed to NameResolver.Factory.newNameResolver(URI, NameResolver.Helper).

Since:

1.19.0

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NameResolver.Helper.ConfigOrError Represents either a successfully parsed service config, containing all necessary parts to be later applied by the channel, or a Status containing the error encountered while parsing.

Constructor Summary

Constructors

Constructor and Description
Helper()

Method Summary

Modifier and Type	Method and Description
abstract int	getDefaultPort() The port number used in case the target or the underlying naming system doesn't provide a port number.
abstract ProxyDetector	getProxyDetector() If the NameResolver wants to support proxy, it should inquire this ProxyDetector.
SynchronizationContext	getSynchronizationContext() Returns the SynchronizationContext where NameResolver.start(io.grpc.NameResolver.Listener), NameResolver.shutdown() and NameResolver.refresh() are run from.
NameResolver.Helper.ConfigOrError	parseServiceConfig(Map<String,?> rawServiceConfig) Parses and validates the service configuration chosen by the name resolver.

Methods inherited from class java.lang.Object

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

Constructor Detail

Helper

public Helper()

Method Detail

getDefaultPort

public abstract int getDefaultPort()

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

Since:

1.19.0

getProxyDetector

public abstract ProxyDetector getProxyDetector()

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

Since:

1.19.0

getSynchronizationContext

public SynchronizationContext getSynchronizationContext()

Returns the SynchronizationContext where NameResolver.start(io.grpc.NameResolver.Listener), NameResolver.shutdown() and NameResolver.refresh() are run from.

Since:

1.20.0

parseServiceConfig

public NameResolver.Helper.ConfigOrError parseServiceConfig(Map<String,?> rawServiceConfig)

Parses and validates the service configuration chosen by the name resolver. This will return a NameResolver.Helper.ConfigOrError which contains either the successfully parsed config, or the Status representing the failure to parse. Implementations are expected to not throw exceptions but return a Status representing the failure.

Parameters:

rawServiceConfig - The Map representation of the service config

Returns:

a tuple of the fully parsed and validated channel configuration, else the Status.

Since:

1.20.0