Package io.servicetalk.dns.discovery.netty

Class DelegatingDnsServiceDiscovererBuilder

java.lang.Object

io.servicetalk.dns.discovery.netty.DelegatingDnsServiceDiscovererBuilder

All Implemented Interfaces:

DnsServiceDiscovererBuilder

public class DelegatingDnsServiceDiscovererBuilder
extends Object
implements DnsServiceDiscovererBuilder

A DnsServiceDiscovererBuilder that delegates all methods to another DnsServiceDiscovererBuilder.

Constructor Summary

Constructors

Constructor	Description
DelegatingDnsServiceDiscovererBuilder(DnsServiceDiscovererBuilder delegate)	Creates a new builder which delegates to the provided DnsServiceDiscovererBuilder.

Method Summary

Modifier and Type	Method	Description
ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>>	buildARecordDiscoverer()	Build a new ServiceDiscoverer which targets host addresses (e.g.
ServiceDiscoverer<String,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>>	buildSrvDiscoverer()	Build a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName.
DnsServiceDiscovererBuilder	consolidateCacheSize(int consolidateCacheSize)	Set the maximum size of the cache that is used to consolidate concurrent lookups for different hostnames.
protected final DnsServiceDiscovererBuilder	delegate()	Returns the DnsServiceDiscovererBuilder delegate.
DnsServiceDiscovererBuilder	dnsResolverAddressTypes(DnsResolverAddressTypes dnsResolverAddressTypes)	Sets the list of the protocol families of the address resolved.
DnsServiceDiscovererBuilder	dnsServerAddressStreamProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider)	Set the DnsServerAddressStreamProvider which determines which DNS server should be used per query.
DnsServiceDiscovererBuilder	ioExecutor(IoExecutor ioExecutor)	Sets the IoExecutor.
DnsServiceDiscovererBuilder	localAddress(SocketAddress localAddress)	Set the local SocketAddress to bind to.
DnsServiceDiscovererBuilder	maxUdpPayloadSize(int maxUdpPayloadSize)	Set the maximum size of the receiving UDP datagram (in bytes).
DnsServiceDiscovererBuilder	missingRecordStatus(ServiceDiscovererEvent.Status status)	Sets which ServiceDiscovererEvent.Status to use in ServiceDiscovererEvent.status() when a record for a previously seen address is missing in the response.
DnsServiceDiscovererBuilder	ndots(int ndots)	Set the number of dots which must appear in a name before an initial absolute query is made.
DnsServiceDiscovererBuilder	observer(DnsServiceDiscovererObserver observer)	Sets a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder.
DnsServiceDiscovererBuilder	optResourceEnabled(boolean optResourceEnabled)	Enable the automatic inclusion of a optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response.
DnsServiceDiscovererBuilder	queryTimeout(Duration queryTimeout)	Sets the timeout of each DNS query performed by this service discoverer.
DnsServiceDiscovererBuilder	ttl(int minSeconds, int maxSeconds)	Controls min/max TTL values that will influence polling intervals.
DnsServiceDiscovererBuilder	ttl(int minSeconds, int maxSeconds, int minCacheSeconds, int maxCacheSeconds)	Controls min/max TTL values that will affect polling intervals and local caching.
DnsServiceDiscovererBuilder	ttl(int minSeconds, int maxSeconds, int minCacheSeconds, int maxCacheSeconds, int negativeCacheSeconds)	Controls min/max TTL values that will affect polling intervals, local caching, and caching negative results.
DnsServiceDiscovererBuilder	ttlJitter(Duration ttlJitter)	The jitter to apply for scheduling the next query after TTL to help spread out subsequent DNS queries.

Methods inherited from class java.lang.Object

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

Constructor Details

DelegatingDnsServiceDiscovererBuilder

public DelegatingDnsServiceDiscovererBuilder(DnsServiceDiscovererBuilder delegate)

Creates a new builder which delegates to the provided DnsServiceDiscovererBuilder.

Parameters:

delegate - the delegate builder.

Method Details

delegate

protected final DnsServiceDiscovererBuilder delegate()

Returns the DnsServiceDiscovererBuilder delegate.

Returns:

Delegate DnsServiceDiscovererBuilder.

consolidateCacheSize

public DnsServiceDiscovererBuilder consolidateCacheSize(int consolidateCacheSize)

Description copied from interface: DnsServiceDiscovererBuilder

Set the maximum size of the cache that is used to consolidate concurrent lookups for different hostnames.

This means if multiple lookups are done for the same hostname and still in-flight, only one actual query will be made and the result will be cascaded to the others.

Specified by:

consolidateCacheSize in interface DnsServiceDiscovererBuilder

Parameters:

consolidateCacheSize - The maximum number of different hostnames for consolidation of concurrent lookups, or 0 if no consolidation should be performed.

Returns:

this.

ttl

public DnsServiceDiscovererBuilder ttl(int minSeconds,
 int maxSeconds)

Description copied from interface: DnsServiceDiscovererBuilder

Controls min/max TTL values that will influence polling intervals.

The created ServiceDiscoverer polls DNS server based on TTL value of the resolved records. Min/max values help to make sure polling stays within reasonable boundaries. Too frequent DNS queries may generate too much load for the DNS server, too rare DNS queries may lead to incorrect state if the remote servers changed IPs before original TTL expired.

With this overload, there will be no local caching for resolved records.

Specified by:

ttl in interface DnsServiceDiscovererBuilder

Parameters:

minSeconds - The minimum about of time the result will be considered valid (in seconds), must be greater than 0.

maxSeconds - The maximum about of time the result will be considered valid (in seconds), must be greater than or equal to minSeconds.

Returns:

this.

See Also:

• DnsServiceDiscovererBuilder.ttl(int, int, int, int)
• DnsServiceDiscovererBuilder.ttl(int, int, int, int, int)

ttl

public DnsServiceDiscovererBuilder ttl(int minSeconds,
 int maxSeconds,
 int minCacheSeconds,
 int maxCacheSeconds)

Description copied from interface: DnsServiceDiscovererBuilder

Controls min/max TTL values that will affect polling intervals and local caching.

The created ServiceDiscoverer polls DNS server based on TTL value of the resolved records. Min/max values help to make sure polling stays within reasonable boundaries. Too frequent DNS queries may generate too much load for the DNS server, too rare DNS queries may lead to incorrect state if the remote servers changed IPs before original TTL expired.

The second min/max pair controls for how long the resolved records should be cached locally. Cache is helpful in scenarios when multiple concurrent resolutions are possible for the same address: either an application runs multiple client instances for the same hostname or clients perform DNS resolutions per new connection instead of background polling.

Specified by:

ttl in interface DnsServiceDiscovererBuilder

Parameters:

minSeconds - The minimum about of time the result will be considered valid (in seconds), must be greater than 0.

maxSeconds - The maximum about of time the result will be considered valid (in seconds), must be greater than or equal to minSeconds.

minCacheSeconds - The minimum about of time the result will be cached locally (in seconds), must be greater than or equal to 0, and less than or equal to minSeconds.

maxCacheSeconds - The maximum about of time the result will be cached locally (in seconds), must be greater than or equal to minCacheSeconds, and less than or equal to maxSeconds.

Returns:

this.

See Also:

• DnsServiceDiscovererBuilder.ttl(int, int)
• DnsServiceDiscovererBuilder.ttl(int, int, int, int, int)

ttl

public DnsServiceDiscovererBuilder ttl(int minSeconds,
 int maxSeconds,
 int minCacheSeconds,
 int maxCacheSeconds,
 int negativeCacheSeconds)

Description copied from interface: DnsServiceDiscovererBuilder

Controls min/max TTL values that will affect polling intervals, local caching, and caching negative results.

The created ServiceDiscoverer polls DNS server based on TTL value of the resolved records. Min/max values help to make sure polling stays within reasonable boundaries. Too frequent DNS queries may generate too much load for the DNS server, too rare DNS queries may lead to incorrect state if the remote servers changed IPs before original TTL expired.

The second min/max pair controls for how long the resolved records should be cached locally. Cache is helpful in scenarios when multiple concurrent resolutions are possible for the same address: either an application runs multiple client instances for the same hostname or clients perform DNS resolutions per new connection instead of background polling.

Specified by:

ttl in interface DnsServiceDiscovererBuilder

Parameters:

minSeconds - The minimum about of time the result will be considered valid (in seconds), must be greater than 0.

maxSeconds - The maximum about of time the result will be considered valid (in seconds), must be greater than or equal to minSeconds.

minCacheSeconds - The minimum about of time the result will be cached locally (in seconds), must be greater than or equal to 0, and less than or equal to minSeconds.

maxCacheSeconds - The maximum about of time the result will be cached locally (in seconds), must be greater than or equal to minCacheSeconds, and less than or equal to maxSeconds.

negativeCacheSeconds - The amount of time an unsuccessful (failed) result will be cached locally (in seconds), must be greater than or equal to 0. If other overloads are used, the default value will recognize the standard Java system property networkaddress.cache.negative.ttl, like InetAddress does.

Returns:

this.

See Also:

• DnsServiceDiscovererBuilder.ttl(int, int)
• DnsServiceDiscovererBuilder.ttl(int, int, int, int)

ttlJitter

public DnsServiceDiscovererBuilder ttlJitter(Duration ttlJitter)

Description copied from interface: DnsServiceDiscovererBuilder

The jitter to apply for scheduling the next query after TTL to help spread out subsequent DNS queries.

The jitter value will be added on top of the TTL value returned from the DNS server to avoid hitting the cache.

Specified by:

ttlJitter in interface DnsServiceDiscovererBuilder

Parameters:

ttlJitter - The jitter to apply to schedule the next query after TTL.

Returns:

this.

localAddress

public DnsServiceDiscovererBuilder localAddress(@Nullable
 SocketAddress localAddress)

Description copied from interface: DnsServiceDiscovererBuilder

Set the local SocketAddress to bind to.

Specified by:

localAddress in interface DnsServiceDiscovererBuilder

Parameters:

localAddress - the local SocketAddress to bind to or null to skip binding. When specified, all DNS queries will be sent from the specified address. When skipped, OS will automatically bind before sending frames but address won't be available in logs.

Returns:

this.

dnsServerAddressStreamProvider

public DnsServiceDiscovererBuilder dnsServerAddressStreamProvider(@Nullable
 DnsServerAddressStreamProvider dnsServerAddressStreamProvider)

Description copied from interface: DnsServiceDiscovererBuilder

Set the DnsServerAddressStreamProvider which determines which DNS server should be used per query.

Specified by:

dnsServerAddressStreamProvider in interface DnsServiceDiscovererBuilder

Parameters:

dnsServerAddressStreamProvider - the DnsServerAddressStreamProvider which determines which DNS server should be used per query.

Returns:

this.

optResourceEnabled

public DnsServiceDiscovererBuilder optResourceEnabled(boolean optResourceEnabled)

Description copied from interface: DnsServiceDiscovererBuilder

Enable the automatic inclusion of a optional records that tries to give the remote DNS server a hint about how much data the resolver can read per response. Some DNSServer may not support this and so fail to answer queries. If you find problems you may want to disable this.

Specified by:

optResourceEnabled in interface DnsServiceDiscovererBuilder

Parameters:

optResourceEnabled - if optional records inclusion is enabled.

Returns:

this.

maxUdpPayloadSize

public DnsServiceDiscovererBuilder maxUdpPayloadSize(int maxUdpPayloadSize)

Description copied from interface: DnsServiceDiscovererBuilder

Set the maximum size of the receiving UDP datagram (in bytes).

If the DNS response exceeds this amount the request will be automatically retried via TCP.

Specified by:

maxUdpPayloadSize in interface DnsServiceDiscovererBuilder

Parameters:

maxUdpPayloadSize - the maximum size of the receiving UDP datagram (in bytes)

Returns:

this.

ndots

public DnsServiceDiscovererBuilder ndots(int ndots)

Description copied from interface: DnsServiceDiscovererBuilder

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

Specified by:

ndots in interface DnsServiceDiscovererBuilder

Parameters:

ndots - the ndots value.

Returns:

this.

queryTimeout

public DnsServiceDiscovererBuilder queryTimeout(Duration queryTimeout)

Description copied from interface: DnsServiceDiscovererBuilder

Sets the timeout of each DNS query performed by this service discoverer.

Specified by:

queryTimeout in interface DnsServiceDiscovererBuilder

Parameters:

queryTimeout - the query timeout value

Returns:

this.

dnsResolverAddressTypes

public DnsServiceDiscovererBuilder dnsResolverAddressTypes(@Nullable
 DnsResolverAddressTypes dnsResolverAddressTypes)

Description copied from interface: DnsServiceDiscovererBuilder

Sets the list of the protocol families of the address resolved.

Specified by:

dnsResolverAddressTypes in interface DnsServiceDiscovererBuilder

Parameters:

dnsResolverAddressTypes - the address types or null to use the default value, based on "java.net" system properties: java.net.preferIPv4Stack and java.net.preferIPv6Stack.

Returns:

this.

ioExecutor

public DnsServiceDiscovererBuilder ioExecutor(IoExecutor ioExecutor)

Description copied from interface: DnsServiceDiscovererBuilder

Sets the IoExecutor.

Specified by:

ioExecutor in interface DnsServiceDiscovererBuilder

Parameters:

ioExecutor - IoExecutor to use.

Returns:

this.

observer

public DnsServiceDiscovererBuilder observer(DnsServiceDiscovererObserver observer)

Description copied from interface: DnsServiceDiscovererBuilder

Sets a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder.

Specified by:

observer in interface DnsServiceDiscovererBuilder

Parameters:

observer - a DnsServiceDiscovererObserver that provides visibility into DNS ServiceDiscoverer built by this builder

Returns:

this.

missingRecordStatus

public DnsServiceDiscovererBuilder missingRecordStatus(ServiceDiscovererEvent.Status status)

Description copied from interface: DnsServiceDiscovererBuilder

Sets which ServiceDiscovererEvent.Status to use in ServiceDiscovererEvent.status() when a record for a previously seen address is missing in the response.

Specified by:

missingRecordStatus in interface DnsServiceDiscovererBuilder

Parameters:

status - a ServiceDiscovererEvent.Status for missing records.

Returns:

this.

buildSrvDiscoverer

public ServiceDiscoverer<String,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> buildSrvDiscoverer()

Description copied from interface: DnsServiceDiscovererBuilder

Build a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName. For each SRV answer capture the Port and resolve the Target.

Specified by:

buildSrvDiscoverer in interface DnsServiceDiscovererBuilder

Returns:

a new ServiceDiscoverer which queries SRV Resource Records corresponding to serviceName. For each SRV answer capture the Port and resolve the Target.

buildARecordDiscoverer

public ServiceDiscoverer<HostAndPort,InetSocketAddress,ServiceDiscovererEvent<InetSocketAddress>> buildARecordDiscoverer()

Description copied from interface: DnsServiceDiscovererBuilder

Build a new ServiceDiscoverer which targets host addresses (e.g. A or AAAA records) and uses a fixed port derived from the HostAndPort.

Specified by:

buildARecordDiscoverer in interface DnsServiceDiscovererBuilder

Returns:

a new ServiceDiscoverer which targets host addresses (e.g. A or AAAA records) and uses a fixed port derived from the HostAndPort.