Package io.grpc

Class NameResolver.Helper

java.lang.Object

io.grpc.NameResolver.Helper

Enclosing class:

NameResolver

@Deprecated
@ExperimentalApi("https://github.com/grpc/grpc-java/issues/1770")
public abstract static class NameResolver.Helper
extends java.lang.Object

Deprecated.

use NameResolver.Args instead.

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

Since:

1.19.0

Constructor Summary

Constructors

Constructor	Description
Helper()	Deprecated.

Method Summary

Modifier and Type	Method	Description
abstract int	getDefaultPort()	Deprecated. The port number used in case the target or the underlying naming system doesn't provide a port number.
abstract ProxyDetector	getProxyDetector()	Deprecated. If the NameResolver wants to support proxy, it should inquire this ProxyDetector.
SynchronizationContext	getSynchronizationContext()	Deprecated. Returns the SynchronizationContext where NameResolver.start(Listener2), NameResolver.shutdown() and NameResolver.refresh() are run from.
NameResolver.ConfigOrError	parseServiceConfig(java.util.Map<java.lang.String,?> rawServiceConfig)	Deprecated. 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()

Deprecated.

Method Detail

getDefaultPort

public abstract int getDefaultPort()

Deprecated.

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()

Deprecated.

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()

Deprecated.

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

Since:

1.20.0

parseServiceConfig

public NameResolver.ConfigOrError parseServiceConfig(java.util.Map<java.lang.String,?> rawServiceConfig)

Deprecated.

Parses and validates the service configuration chosen by the name resolver. This will return a NameResolver.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. The value inside the NameResolver.ConfigOrError should implement equals() and hashCode().

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