Package com.linecorp.armeria.client.endpoint.dns

Class DnsAddressEndpointGroupBuilder

java.lang.Object

com.linecorp.armeria.client.AbstractDnsResolverBuilder

com.linecorp.armeria.client.endpoint.dns.DnsAddressEndpointGroupBuilder

All Implemented Interfaces:

DynamicEndpointGroupSetters

public final class DnsAddressEndpointGroupBuilder
extends AbstractDnsResolverBuilder

Builds a new DnsAddressEndpointGroup that sources its Endpoint list from the A or AAAA DNS records of a certain hostname.

Method Summary

Modifier and Type	Method	Description
DnsAddressEndpointGroupBuilder	addDnsQueryListeners(DnsQueryListener... dnsQueryListeners)	Adds the DnsQueryListener that listens to the result of DnsRecord queries.
DnsAddressEndpointGroupBuilder	addDnsQueryListeners(Iterable<? extends DnsQueryListener> dnsQueryListeners)	Adds the DnsQueryListeners which listens to the result of DnsRecord queries.
DnsAddressEndpointGroupBuilder	allowEmptyEndpoints(boolean allowEmptyEndpoints)	Sets whether to allow an empty Endpoint list.
DnsAddressEndpointGroupBuilder	backoff(Backoff backoff)	Sets the Backoff that determines how much delay should be inserted between queries when a DNS server sent an error response.
DnsAddressEndpointGroup	build()	Returns a newly created DnsAddressEndpointGroup.
DnsAddressEndpointGroupBuilder	cacheSpec(String cacheSpec)	Sets the Caffeine specification string of the cache that stores the domain names and their resolved addresses.
DnsAddressEndpointGroupBuilder	decodeIdn(boolean decodeIdn)	Sets if the domain and host names should be decoded to unicode when received.
DnsAddressEndpointGroupBuilder	disableDnsQueryMetrics()	Deprecated.
DnsAddressEndpointGroupBuilder	dnsCache(DnsCache dnsCache)	Sets the DnsCache that caches the resolved DnsRecords and the cause of a failure if negative cache is activated.
DnsAddressEndpointGroupBuilder	dnsQueryLifecycleObserverFactory(io.netty.resolver.dns.DnsQueryLifecycleObserverFactory observerFactory)	Sets the DnsQueryLifecycleObserverFactory that is used to generate objects which can observe individual DNS queries.
DnsAddressEndpointGroupBuilder	dnsServerAddressStreamProvider(io.netty.resolver.dns.DnsServerAddressStreamProvider dnsServerAddressStreamProvider)	Sets the DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.
DnsAddressEndpointGroupBuilder	enableDnsQueryMetrics(boolean enable)	Enables the default DnsQueryLifecycleObserverFactory that collects DNS query metrics through MeterRegistry.
DnsAddressEndpointGroupBuilder	eventLoop(io.netty.channel.EventLoop eventLoop)	Sets the EventLoop to use for sending DNS queries.
DnsAddressEndpointGroupBuilder	hostsFileEntriesResolver(io.netty.resolver.HostsFileEntriesResolver hostsFileEntriesResolver)	Sets the HostsFileEntriesResolver which is used to first check if the hostname is locally aliased.
DnsAddressEndpointGroupBuilder	maxPayloadSize(int maxPayloadSize)	Sets the capacity of the datagram packet buffer in bytes.
DnsAddressEndpointGroupBuilder	maxQueriesPerResolve(int maxQueriesPerResolve)	Sets the base value of maximum allowed number of DNS queries to send when resolving a host name.
DnsAddressEndpointGroupBuilder	meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)	Sets MeterRegistry to collect the DNS query metrics.
DnsAddressEndpointGroupBuilder	ndots(int ndots)	Sets the number of dots which must appear in a name before an initial absolute query is made.
DnsAddressEndpointGroupBuilder	negativeTtl(int negativeTtl)	Sets the TTL of the cache for the failed DNS queries in seconds.
DnsAddressEndpointGroupBuilder	optResourceEnabled(boolean optResourceEnabled)	Enables the automatic inclusion of an optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response.
DnsAddressEndpointGroupBuilder	port(int port)	Sets the port number of the Endpoints created by DnsAddressEndpointGroup.
DnsAddressEndpointGroupBuilder	queryTimeout(Duration queryTimeout)	Sets the timeout of the DNS query performed by this resolver.
DnsAddressEndpointGroupBuilder	queryTimeoutForEachAttempt(Duration queryTimeoutForEachAttempt)	Sets the timeout of each DNS query performed by this endpoint group.
DnsAddressEndpointGroupBuilder	queryTimeoutMillis(long queryTimeoutMillis)	Sets the timeout of the DNS query performed by this resolver in milliseconds.
DnsAddressEndpointGroupBuilder	queryTimeoutMillisForEachAttempt(long queryTimeoutMillisForEachAttempt)	Sets the timeout of each DNS query performed by this endpoint group in milliseconds.
DnsAddressEndpointGroupBuilder	recursionDesired(boolean recursionDesired)	Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set.
DnsAddressEndpointGroupBuilder	searchDomains(Iterable<String> searchDomains)	Sets the list of search domains of the resolver.
DnsAddressEndpointGroupBuilder	searchDomains(String... searchDomains)	Sets the search domains of the resolver.
DnsAddressEndpointGroupBuilder	selectionStrategy(EndpointSelectionStrategy selectionStrategy)	Sets the EndpointSelectionStrategy that determines the enumeration order of Endpoints.
DnsAddressEndpointGroupBuilder	selectionTimeout(Duration selectionTimeout)	Sets the timeout to wait until a successful Endpoint selection.
DnsAddressEndpointGroupBuilder	selectionTimeoutMillis(long selectionTimeoutMillis)	Sets the timeout to wait until a successful Endpoint selection.
DnsAddressEndpointGroupBuilder	serverAddresses(Iterable<InetSocketAddress> serverAddresses)	Sets the DNS server addresses to send queries to.
DnsAddressEndpointGroupBuilder	serverAddresses(InetSocketAddress... serverAddresses)	Sets the DNS server addresses to send queries to.
DnsAddressEndpointGroupBuilder	serverAddressStreamProvider(io.netty.resolver.dns.DnsServerAddressStreamProvider serverAddressStreamProvider)	Sets the DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.
DnsAddressEndpointGroupBuilder	traceEnabled(boolean traceEnabled)	Sets if this resolver should generate detailed trace information in exception messages so that it is easier to understand the cause of resolution failure.
DnsAddressEndpointGroupBuilder	ttl(int minTtl, int maxTtl)	Sets the minimum and maximum TTL of the cached DNS resource records in seconds.

Methods inherited from class com.linecorp.armeria.client.AbstractDnsResolverBuilder

buildConfigurator, cacheSpec, hostsFileEntriesResolver, maxTtl, maybeCreateDnsCache, meterRegistry, minTtl, ndots, negativeTtl, queryTimeoutMillis, searchDomains, serverAddressStreamProvider

Methods inherited from class java.lang.Object

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

Method Details

port

public DnsAddressEndpointGroupBuilder port(int port)

Sets the port number of the Endpoints created by DnsAddressEndpointGroup. By default, the port number of the Endpoints will remain unspecified and the protocol-dependent default port number will be chosen automatically, e.g. 80 or 443.

build

public DnsAddressEndpointGroup build()

Returns a newly created DnsAddressEndpointGroup.

eventLoop

public DnsAddressEndpointGroupBuilder eventLoop(io.netty.channel.EventLoop eventLoop)

Sets the EventLoop to use for sending DNS queries.

backoff

public DnsAddressEndpointGroupBuilder backoff(Backoff backoff)

Sets the Backoff that determines how much delay should be inserted between queries when a DNS server sent an error response. Backoff.exponential(1000, 32000).withJitter(0.2) is used by default.

selectionStrategy

public DnsAddressEndpointGroupBuilder selectionStrategy(EndpointSelectionStrategy selectionStrategy)

Sets the EndpointSelectionStrategy that determines the enumeration order of Endpoints.

traceEnabled

public DnsAddressEndpointGroupBuilder traceEnabled(boolean traceEnabled)

Description copied from class: AbstractDnsResolverBuilder

Sets if this resolver should generate detailed trace information in exception messages so that it is easier to understand the cause of resolution failure. This flag is enabled by default.

Overrides:

traceEnabled in class AbstractDnsResolverBuilder

queryTimeout

public DnsAddressEndpointGroupBuilder queryTimeout(Duration queryTimeout)

Description copied from class: AbstractDnsResolverBuilder

Sets the timeout of the DNS query performed by this resolver. 0 disables the timeout. If unspecified, 5000 ms will be used.

Overrides:

queryTimeout in class AbstractDnsResolverBuilder

queryTimeoutMillis

public DnsAddressEndpointGroupBuilder queryTimeoutMillis(long queryTimeoutMillis)

Description copied from class: AbstractDnsResolverBuilder

Sets the timeout of the DNS query performed by this resolver in milliseconds. 0 disables the timeout. If unspecified, 5000 ms will be used.

Overrides:

queryTimeoutMillis in class AbstractDnsResolverBuilder

queryTimeoutForEachAttempt

public DnsAddressEndpointGroupBuilder queryTimeoutForEachAttempt(Duration queryTimeoutForEachAttempt)

Description copied from class: AbstractDnsResolverBuilder

Sets the timeout of each DNS query performed by this endpoint group. This option is useful if you want to set a timeout for each search domain resolution. If unspecified, the value of AbstractDnsResolverBuilder.queryTimeout(Duration) is used.

Overrides:

queryTimeoutForEachAttempt in class AbstractDnsResolverBuilder

queryTimeoutMillisForEachAttempt

public DnsAddressEndpointGroupBuilder queryTimeoutMillisForEachAttempt(long queryTimeoutMillisForEachAttempt)

Description copied from class: AbstractDnsResolverBuilder

Sets the timeout of each DNS query performed by this endpoint group in milliseconds. This option is useful if you want to set a timeout for each search domain resolution. If unspecified, the value of AbstractDnsResolverBuilder.queryTimeoutMillis(long) is used.

Overrides:

queryTimeoutMillisForEachAttempt in class AbstractDnsResolverBuilder

recursionDesired

public DnsAddressEndpointGroupBuilder recursionDesired(boolean recursionDesired)

Description copied from class: AbstractDnsResolverBuilder

Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set. This flag is enabled by default.

Overrides:

recursionDesired in class AbstractDnsResolverBuilder

maxQueriesPerResolve

public DnsAddressEndpointGroupBuilder maxQueriesPerResolve(int maxQueriesPerResolve)

Description copied from class: AbstractDnsResolverBuilder

Sets the base value of maximum allowed number of DNS queries to send when resolving a host name. The actual maximum allowed number of queries will be multiplied by the DnsServerAddressStream.size(). For example, if maxQueriesPerResolve is 5 and DnsServerAddressStream.size() is 2, DNS queries can be executed up to 10 times. The DnsServerAddressStream is provided by DnsServerAddressStreamProvider.

Overrides:

maxQueriesPerResolve in class AbstractDnsResolverBuilder

See Also:

• AbstractDnsResolverBuilder.serverAddressStreamProvider(DnsServerAddressStreamProvider)

serverAddresses

public DnsAddressEndpointGroupBuilder serverAddresses(InetSocketAddress... serverAddresses)

Description copied from class: AbstractDnsResolverBuilder

Sets the DNS server addresses to send queries to. Operating system default is used by default.

Overrides:

serverAddresses in class AbstractDnsResolverBuilder

serverAddresses

public DnsAddressEndpointGroupBuilder serverAddresses(Iterable<InetSocketAddress> serverAddresses)

Description copied from class: AbstractDnsResolverBuilder

Sets the DNS server addresses to send queries to. Operating system default is used by default.

Overrides:

serverAddresses in class AbstractDnsResolverBuilder

serverAddressStreamProvider

public DnsAddressEndpointGroupBuilder serverAddressStreamProvider(io.netty.resolver.dns.DnsServerAddressStreamProvider serverAddressStreamProvider)

Description copied from class: AbstractDnsResolverBuilder

Sets the DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.

Overrides:

serverAddressStreamProvider in class AbstractDnsResolverBuilder

dnsServerAddressStreamProvider

public DnsAddressEndpointGroupBuilder dnsServerAddressStreamProvider(io.netty.resolver.dns.DnsServerAddressStreamProvider dnsServerAddressStreamProvider)

Description copied from class: AbstractDnsResolverBuilder

Sets the DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.

Overrides:

dnsServerAddressStreamProvider in class AbstractDnsResolverBuilder

maxPayloadSize

public DnsAddressEndpointGroupBuilder maxPayloadSize(int maxPayloadSize)

Description copied from class: AbstractDnsResolverBuilder

Sets the capacity of the datagram packet buffer in bytes.

Overrides:

maxPayloadSize in class AbstractDnsResolverBuilder

optResourceEnabled

public DnsAddressEndpointGroupBuilder optResourceEnabled(boolean optResourceEnabled)

Description copied from class: AbstractDnsResolverBuilder

Enables the automatic inclusion of an optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response. Some DNS Server may not support this and so fail to answer queries.

Overrides:

optResourceEnabled in class AbstractDnsResolverBuilder

hostsFileEntriesResolver

public DnsAddressEndpointGroupBuilder hostsFileEntriesResolver(io.netty.resolver.HostsFileEntriesResolver hostsFileEntriesResolver)

Description copied from class: AbstractDnsResolverBuilder

Sets the HostsFileEntriesResolver which is used to first check if the hostname is locally aliased.

Overrides:

hostsFileEntriesResolver in class AbstractDnsResolverBuilder

dnsQueryLifecycleObserverFactory

public DnsAddressEndpointGroupBuilder dnsQueryLifecycleObserverFactory(io.netty.resolver.dns.DnsQueryLifecycleObserverFactory observerFactory)

Description copied from class: AbstractDnsResolverBuilder

Sets the DnsQueryLifecycleObserverFactory that is used to generate objects which can observe individual DNS queries.

Overrides:

dnsQueryLifecycleObserverFactory in class AbstractDnsResolverBuilder

disableDnsQueryMetrics

@Deprecated
public DnsAddressEndpointGroupBuilder disableDnsQueryMetrics()

Deprecated.

Description copied from class: AbstractDnsResolverBuilder

Disables the default DnsQueryLifecycleObserverFactory that collects DNS query metrics through MeterRegistry.

Overrides:

disableDnsQueryMetrics in class AbstractDnsResolverBuilder

enableDnsQueryMetrics

public DnsAddressEndpointGroupBuilder enableDnsQueryMetrics(boolean enable)

Description copied from class: AbstractDnsResolverBuilder

Enables the default DnsQueryLifecycleObserverFactory that collects DNS query metrics through MeterRegistry. This option is enabled by default.

Overrides:

enableDnsQueryMetrics in class AbstractDnsResolverBuilder

searchDomains

public DnsAddressEndpointGroupBuilder searchDomains(String... searchDomains)

Description copied from class: AbstractDnsResolverBuilder

Sets the search domains of the resolver.

Overrides:

searchDomains in class AbstractDnsResolverBuilder

searchDomains

public DnsAddressEndpointGroupBuilder searchDomains(Iterable<String> searchDomains)

Description copied from class: AbstractDnsResolverBuilder

Sets the list of search domains of the resolver.

Overrides:

searchDomains in class AbstractDnsResolverBuilder

ndots

public DnsAddressEndpointGroupBuilder ndots(int ndots)

Description copied from class: AbstractDnsResolverBuilder

Sets the number of dots which must appear in a name before an initial absolute query is made.

Overrides:

ndots in class AbstractDnsResolverBuilder

decodeIdn

public DnsAddressEndpointGroupBuilder decodeIdn(boolean decodeIdn)

Description copied from class: AbstractDnsResolverBuilder

Sets if the domain and host names should be decoded to unicode when received. See rfc3492. This flag is enabled by default.

Overrides:

decodeIdn in class AbstractDnsResolverBuilder

meterRegistry

public DnsAddressEndpointGroupBuilder meterRegistry(io.micrometer.core.instrument.MeterRegistry meterRegistry)

Description copied from class: AbstractDnsResolverBuilder

Sets MeterRegistry to collect the DNS query metrics.

Overrides:

meterRegistry in class AbstractDnsResolverBuilder

cacheSpec

public DnsAddressEndpointGroupBuilder cacheSpec(String cacheSpec)

Description copied from class: AbstractDnsResolverBuilder

Sets the Caffeine specification string of the cache that stores the domain names and their resolved addresses. If not set, Flags.dnsCacheSpec() is used by default.

Note that AbstractDnsResolverBuilder.cacheSpec(String) and AbstractDnsResolverBuilder.dnsCache(DnsCache) are mutually exclusive.

Overrides:

cacheSpec in class AbstractDnsResolverBuilder

ttl

public DnsAddressEndpointGroupBuilder ttl(int minTtl,
 int maxTtl)

Description copied from class: AbstractDnsResolverBuilder

Sets the minimum and maximum TTL of the cached DNS resource records in seconds. If the TTL of the DNS resource record returned by the DNS server is less than the minimum TTL or greater than the maximum TTL, this resolver will ignore the TTL from the DNS server and use the minimum TTL or the maximum TTL instead respectively. The default value is 1 and Integer.MAX_VALUE, which practically tells this resolver to respect the TTL from the DNS server.

Note that AbstractDnsResolverBuilder.ttl(int, int) and AbstractDnsResolverBuilder.dnsCache(DnsCache) are mutually exclusive.

Overrides:

ttl in class AbstractDnsResolverBuilder

negativeTtl

public DnsAddressEndpointGroupBuilder negativeTtl(int negativeTtl)

Description copied from class: AbstractDnsResolverBuilder

Sets the TTL of the cache for the failed DNS queries in seconds. The default value is 0 which means that the DNS resolver does not cache when DNS queries are failed.

Note that AbstractDnsResolverBuilder.negativeTtl(int) and AbstractDnsResolverBuilder.dnsCache(DnsCache) are mutually exclusive.

Overrides:

negativeTtl in class AbstractDnsResolverBuilder

dnsCache

public DnsAddressEndpointGroupBuilder dnsCache(DnsCache dnsCache)

Description copied from class: AbstractDnsResolverBuilder

Sets the DnsCache that caches the resolved DnsRecords and the cause of a failure if negative cache is activated. This option is useful if you want to share a DnsCache with multiple DNS resolvers. If unspecified, the default DnsCache is used.

Note that if AbstractDnsResolverBuilder.cacheSpec(String), AbstractDnsResolverBuilder.ttl(int, int), or AbstractDnsResolverBuilder.negativeTtl(int) is set, the DNS resolver will create its own DnsCache using the properties. Therefore, AbstractDnsResolverBuilder.cacheSpec(String), AbstractDnsResolverBuilder.ttl(int, int), and AbstractDnsResolverBuilder.negativeTtl(int) are mutually exclusive with AbstractDnsResolverBuilder.dnsCache(DnsCache).

Overrides:

dnsCache in class AbstractDnsResolverBuilder

allowEmptyEndpoints

public DnsAddressEndpointGroupBuilder allowEmptyEndpoints(boolean allowEmptyEndpoints)

Description copied from interface: DynamicEndpointGroupSetters

Sets whether to allow an empty Endpoint list. If unspecified, an empty Endpoint list is allowed.

Specified by:

allowEmptyEndpoints in interface DynamicEndpointGroupSetters

selectionTimeout

public DnsAddressEndpointGroupBuilder selectionTimeout(Duration selectionTimeout)

Description copied from interface: DynamicEndpointGroupSetters

Sets the timeout to wait until a successful Endpoint selection. Duration.ZERO disables the timeout. If unspecified, Flags.defaultConnectTimeoutMillis() is used by default.

Specified by:

selectionTimeout in interface DynamicEndpointGroupSetters

selectionTimeoutMillis

public DnsAddressEndpointGroupBuilder selectionTimeoutMillis(long selectionTimeoutMillis)

Sets the timeout to wait until a successful Endpoint selection. 0 disables the timeout. If unspecified, the default DNS query timeout (DnsUtil.DEFAULT_DNS_QUERY_TIMEOUT_MILLIS ms) is used by default.

Specified by:

selectionTimeoutMillis in interface DynamicEndpointGroupSetters

addDnsQueryListeners

public DnsAddressEndpointGroupBuilder addDnsQueryListeners(Iterable<? extends DnsQueryListener> dnsQueryListeners)

Adds the DnsQueryListeners which listens to the result of DnsRecord queries. If no DnsQueryListener is configured, DnsQueryListener.of() is used by default.

addDnsQueryListeners

public DnsAddressEndpointGroupBuilder addDnsQueryListeners(DnsQueryListener... dnsQueryListeners)

Adds the DnsQueryListener that listens to the result of DnsRecord queries. If no DnsQueryListener is configured, DnsQueryListener.of() is used by default.