Netty 4.1.107.Final · io.netty.resolver.dns.DnsNameResolverBuilder

Modifier and Type	Field and Description
private AuthoritativeDnsServerCache	authoritativeDnsServerCache
private ChannelFactory<? extends DatagramChannel>	channelFactory Deprecated as a consequence of `ChannelFactory` being deprecated.
private DnsCnameCache	cnameCache
private boolean	completeOncePreferredResolved
private boolean	decodeIdn
private DnsQueryLifecycleObserverFactory	dnsQueryLifecycleObserverFactory
private DnsServerAddressStreamProvider	dnsServerAddressStreamProvider
pack-priv volatile EventLoop	eventLoop
private HostsFileEntriesResolver	hostsFileEntriesResolver
private SocketAddress	localAddress
private static final InternalLogger	logger
private int	maxNumConsolidation
private int	maxPayloadSize
private int	maxQueriesPerResolve
private Integer	maxTtl
private Integer	minTtl
private int	ndots
private Integer	negativeTtl
private boolean	optResourceEnabled
private long	queryTimeoutMillis
private boolean	recursionDesired
private DnsCache	resolveCache
private ResolvedAddressTypes	resolvedAddressTypes
private boolean	retryOnTimeout
private String[]	searchDomains
private ChannelFactory<? extends SocketChannel>	socketChannelFactory Deprecated as a consequence of `ChannelFactory` being deprecated.
private boolean	traceEnabled

Access	Constructor and Description
public	DnsNameResolverBuilder() Creates a new builder.
public	DnsNameResolverBuilder(EventLoop the `EventLoop` which will perform the communication with the DNS servers. eventLoop) Creates a new builder.

Method Summary

Modifier and Type	Method and Description
public DnsNameResolverBuilder	Returns: `this` authoritativeDnsServerCache(DnsCache the authoritative NS servers cache authoritativeDnsServerCache) Deprecated Use `authoritativeDnsServerCache(AuthoritativeDnsServerCache)` Sets the cache for authoritative NS servers
public DnsNameResolverBuilder	Returns: `this` authoritativeDnsServerCache(AuthoritativeDnsServerCache the authoritative NS servers cache authoritativeDnsServerCache) Sets the cache for authoritative NS servers
public DnsNameResolver	Returns: a `DnsNameResolver` build() Returns a new `DnsNameResolver` instance.
protected ChannelFactory<? extends DatagramChannel>	channelFactory() Deprecated as a consequence of `ChannelFactory` being deprecated.
public DnsNameResolverBuilder	Returns: `this` channelFactory(ChannelFactory<? extends DatagramChannel> the `ChannelFactory` channelFactory) Deprecated as a consequence of `ChannelFactory` being deprecated. Sets the `ChannelFactory` that will create a `DatagramChannel`.
public DnsNameResolverBuilder	Returns: `this` channelType(Class<? extends DatagramChannel> the type channelType) Sets the `ChannelFactory` as a `ReflectiveChannelFactory` of this type.
public DnsNameResolverBuilder	Returns: `this` cnameCache(DnsCnameCache the cache used to cache `CNAME` mappings for a domain. cnameCache) Sets the cache for `CNAME` mappings.
public DnsNameResolverBuilder	Returns: `this` completeOncePreferredResolved(boolean `true` to enable, `false` to disable. completeOncePreferredResolved) If `true` `DnsNameResolver#resolveAll(String)` will notify the returned `Future` as soon as all queries for the preferred address-type are complete.
public static ResolvedAddressTypes	Returns: a `ResolvedAddressTypes` computeResolvedAddressTypes(InternetProtocolFamily... a valid sequence of `InternetProtocolFamily`s internetProtocolFamilies) Compute a `ResolvedAddressTypes` from some `InternetProtocolFamily`s.
public DnsNameResolverBuilder	Returns: `this` consolidateCacheSize(int the maximum lookups to consolidate (different hostnames), or `0` if no consolidation should be performed. maxNumConsolidation) Set the maximum size of the cache that is used to consolidate lookups for different hostnames when in-flight.
public DnsNameResolverBuilder	Returns: `DnsNameResolverBuilder` copy() Creates a copy of this `DnsNameResolverBuilder`
public DnsNameResolverBuilder	Returns: `this` decodeIdn(boolean if should get decoded decodeIdn) Set if domain / host names should be decoded to unicode when received.
public DnsNameResolverBuilder	Returns: `this` dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory the factory used to generate objects which can observe individual DNS queries. lifecycleObserverFactory) Set the factory used to generate objects which can observe individual DNS queries.
public DnsNameResolverBuilder	Returns: `this` eventLoop(EventLoop the `EventLoop` eventLoop) Sets the `EventLoop` which will perform the communication with the DNS servers.
public DnsNameResolverBuilder	Returns: `this` hostsFileEntriesResolver(HostsFileEntriesResolver the `HostsFileEntriesResolver` used to first check if the hostname is locally aliased. hostsFileEntriesResolver)
public DnsNameResolverBuilder	Returns: `this` localAddress(SocketAddress the bind address localAddress) Configure the address that will be used to bind too.
public DnsNameResolverBuilder	Returns: `this` maxPayloadSize(int the capacity of the datagram packet buffer maxPayloadSize) Sets the capacity of the datagram packet buffer (in bytes).
public DnsNameResolverBuilder	Returns: `this` maxQueriesPerResolve(int the max number of queries maxQueriesPerResolve) Sets the maximum allowed number of DNS queries to send when resolving a host name.
protected DnsServerAddressStreamProvider	nameServerProvider()
public DnsNameResolverBuilder	Returns: `this`. nameServerProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider) Set the `DnsServerAddressStreamProvider` which is used to determine which DNS server is used to resolve each hostname.
public DnsNameResolverBuilder	Returns: `this` ndots(int the ndots value ndots) Set the number of dots which must appear in a name before an initial absolute query is made.
public DnsNameResolverBuilder	Returns: `this` negativeTtl(int the TTL for failed cached queries negativeTtl) Sets the TTL of the cache for the failed DNS queries (in seconds).
private AuthoritativeDnsServerCache	newAuthoritativeDnsServerCache()
private DnsCache	newCache()
private DnsCnameCache	newCnameCache()
public DnsNameResolverBuilder	Returns: `this` optResourceEnabled(boolean if optional records inclusion is enabled 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.
public DnsNameResolverBuilder	Returns: `this` queryTimeoutMillis(long the query timeout queryTimeoutMillis) Sets the timeout of each DNS query performed by this resolver (in milliseconds).
public DnsNameResolverBuilder	Returns: `this` recursionDesired(boolean true if recursion is desired recursionDesired) Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set.
public DnsNameResolverBuilder	Returns: `this` resolveCache(DnsCache the DNS resolution results cache resolveCache) Sets the cache for resolution results.
public DnsNameResolverBuilder	Returns: `this` resolvedAddressTypes(ResolvedAddressTypes the address types resolvedAddressTypes) Sets the list of the protocol families of the address resolved.
public DnsNameResolverBuilder	Returns: `this` searchDomains(Iterable<String> the search domains searchDomains) Set the list of search domains of the resolver.
public DnsNameResolverBuilder	Returns: `this` socketChannelFactory(ChannelFactory<? extends SocketChannel> the `ChannelFactory` or `null` if TCP fallback should not be supported. By default, TCP fallback is not enabled. channelFactory) Deprecated as a consequence of `ChannelFactory` being deprecated. Sets the `ChannelFactory` that will create a `SocketChannel` for TCP fallback if needed.
public DnsNameResolverBuilder	Returns: `this` socketChannelFactory(ChannelFactory<? extends SocketChannel> the `ChannelFactory` or `null` if TCP fallback should not be supported. By default, TCP fallback is not enabled. channelFactory, boolean if `true` the `DnsNameResolver` will also fallback to TCP if a timeout was detected, if `false` it will only try to use TCP if the response was marked as truncated. retryOnTimeout) Deprecated as a consequence of `ChannelFactory` being deprecated. Sets the `ChannelFactory` that will create a `SocketChannel` for TCP fallback if needed.
public DnsNameResolverBuilder	Returns: `this` socketChannelType(Class<? extends SocketChannel> the type or `null` if TCP fallback should not be supported. By default, TCP fallback is not enabled. channelType) Sets the `ChannelFactory` as a `ReflectiveChannelFactory` of this type for TCP fallback if needed.
public DnsNameResolverBuilder	Returns: `this` socketChannelType(Class<? extends SocketChannel> the type or `null` if TCP fallback should not be supported. By default, TCP fallback is not enabled. channelType, boolean if `true` the `DnsNameResolver` will also fallback to TCP if a timeout was detected, if `false` it will only try to use TCP if the response was marked as truncated. retryOnTimeout) Sets the `ChannelFactory` as a `ReflectiveChannelFactory` of this type for TCP fallback if needed.
public DnsNameResolverBuilder	Returns: `this` traceEnabled(boolean true if trace is enabled traceEnabled) Deprecated Prefer to configure a `LoggingDnsQueryLifeCycleObserverFactory` instead. Sets if this resolver should generate the detailed trace information in an exception message so that it is easier to understand the cause of resolution failure.
public DnsNameResolverBuilder	Returns: `this` ttl(int the minimum TTL minTtl, int the maximum TTL maxTtl) Sets the minimum and maximum TTL of the cached DNS resource records (in seconds).

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

authoritativeDnsServerCache	back to summary
private AuthoritativeDnsServerCache authoritativeDnsServerCache

channelFactory	back to summary
private ChannelFactory<? extends DatagramChannel> channelFactory Deprecated as a consequence of `ChannelFactory` being deprecated. See corresponding docs for further information.

cnameCache	back to summary
private DnsCnameCache cnameCache

completeOncePreferredResolved	back to summary
private boolean completeOncePreferredResolved

decodeIdn	back to summary
private boolean decodeIdn

dnsQueryLifecycleObserverFactory	back to summary
private DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory

dnsServerAddressStreamProvider	back to summary
private DnsServerAddressStreamProvider dnsServerAddressStreamProvider

eventLoop	back to summary
pack-priv volatile EventLoop eventLoop

hostsFileEntriesResolver	back to summary
private HostsFileEntriesResolver hostsFileEntriesResolver

localAddress	back to summary
private SocketAddress localAddress

logger	back to summary
private static final InternalLogger logger

maxNumConsolidation	back to summary
private int maxNumConsolidation

maxPayloadSize	back to summary
private int maxPayloadSize

maxQueriesPerResolve	back to summary
private int maxQueriesPerResolve

maxTtl	back to summary
private Integer maxTtl

minTtl	back to summary
private Integer minTtl

ndots	back to summary
private int ndots

negativeTtl	back to summary
private Integer negativeTtl

optResourceEnabled	back to summary
private boolean optResourceEnabled

queryTimeoutMillis	back to summary
private long queryTimeoutMillis

recursionDesired	back to summary
private boolean recursionDesired

resolveCache	back to summary
private DnsCache resolveCache

resolvedAddressTypes	back to summary
private ResolvedAddressTypes resolvedAddressTypes

retryOnTimeout	back to summary
private boolean retryOnTimeout

searchDomains	back to summary
private String[] searchDomains

socketChannelFactory	back to summary
private ChannelFactory<? extends SocketChannel> socketChannelFactory Deprecated as a consequence of `ChannelFactory` being deprecated. See corresponding docs for further information.

traceEnabled	back to summary
private boolean traceEnabled

DnsNameResolverBuilder	back to summary
public DnsNameResolverBuilder() Creates a new builder.

DnsNameResolverBuilder	back to summary
public DnsNameResolverBuilder(EventLoop eventLoop) Creates a new builder. Parameters eventLoop:EventLoop the `EventLoop` which will perform the communication with the DNS servers.

Method Detail

authoritativeDnsServerCache back to summary

authoritativeDnsServerCache	back to summary
public DnsNameResolverBuilder authoritativeDnsServerCache(DnsCache authoritativeDnsServerCache) Deprecated Use `authoritativeDnsServerCache(AuthoritativeDnsServerCache)` Sets the cache for authoritative NS servers Parameters authoritativeDnsServerCache:DnsCache the authoritative NS servers cache Returns:DnsNameResolverBuilder `this` Annotations @Deprecated

public DnsNameResolverBuilder authoritativeDnsServerCache(DnsCache authoritativeDnsServerCache)

Deprecated

Use authoritativeDnsServerCache(AuthoritativeDnsServerCache)

Sets the cache for authoritative NS servers

Parameters

authoritativeDnsServerCache:DnsCache: the authoritative NS servers cache

Returns:DnsNameResolverBuilder

this

Annotations

@Deprecated

authoritativeDnsServerCache back to summary

authoritativeDnsServerCache	back to summary
public DnsNameResolverBuilder authoritativeDnsServerCache(AuthoritativeDnsServerCache authoritativeDnsServerCache) Sets the cache for authoritative NS servers Parameters authoritativeDnsServerCache:AuthoritativeDnsServerCache the authoritative NS servers cache Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder authoritativeDnsServerCache(AuthoritativeDnsServerCache authoritativeDnsServerCache)

Sets the cache for authoritative NS servers

Parameters

authoritativeDnsServerCache:AuthoritativeDnsServerCache: the authoritative NS servers cache

Returns:DnsNameResolverBuilder

this

build back to summary

build	back to summary
public DnsNameResolver build() Returns a new `DnsNameResolver` instance. Returns:DnsNameResolver a `DnsNameResolver`

public DnsNameResolver build()

Returns a new DnsNameResolver instance.

Returns:DnsNameResolver: a DnsNameResolver

channelFactory	back to summary
protected ChannelFactory<? extends DatagramChannel> channelFactory() Deprecated as a consequence of `ChannelFactory` being deprecated. See corresponding docs for further information.

channelFactory back to summary

channelFactory	back to summary
public DnsNameResolverBuilder channelFactory(ChannelFactory<? extends DatagramChannel> channelFactory) Deprecated as a consequence of `ChannelFactory` being deprecated. See corresponding docs for further information. Sets the `ChannelFactory` that will create a `DatagramChannel`. If TCP fallback should be supported as well it is required to call the `or` `socketChannelType(Class)` method. Parameters channelFactory:ChannelFactory<? extends DatagramChannel> the `ChannelFactory` Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder channelFactory(ChannelFactory<? extends DatagramChannel> channelFactory)

Deprecated

as a consequence of ChannelFactory being deprecated. See corresponding docs for further information.

Sets the ChannelFactory that will create a DatagramChannel. If TCP fallback should be supported as well it is required to call the or socketChannelType(Class) method.

Parameters

channelFactory:ChannelFactory<? extends DatagramChannel>: the ChannelFactory

Returns:DnsNameResolverBuilder

this

channelType back to summary

channelType	back to summary
public DnsNameResolverBuilder channelType(Class<? extends DatagramChannel> channelType) Sets the `ChannelFactory` as a `ReflectiveChannelFactory` of this type. Use as an alternative to `channelFactory(ChannelFactory)`. If TCP fallback should be supported as well it is required to call the `or` `socketChannelType(Class)` method. Parameters channelType:Class<? extends DatagramChannel> the type Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder channelType(Class<? extends DatagramChannel> channelType)

Sets the ChannelFactory as a ReflectiveChannelFactory of this type. Use as an alternative to channelFactory(ChannelFactory). If TCP fallback should be supported as well it is required to call the or socketChannelType(Class) method.

Parameters

channelType:Class<? extends DatagramChannel>: the type

Returns:DnsNameResolverBuilder

this

cnameCache back to summary

cnameCache	back to summary
public DnsNameResolverBuilder cnameCache(DnsCnameCache cnameCache) Sets the cache for `CNAME` mappings. Parameters cnameCache:DnsCnameCache the cache used to cache `CNAME` mappings for a domain. Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder cnameCache(DnsCnameCache cnameCache)

Sets the cache for CNAME mappings.

Parameters

cnameCache:DnsCnameCache: the cache used to cache CNAME mappings for a domain.

Returns:DnsNameResolverBuilder

this

completeOncePreferredResolved back to summary

completeOncePreferredResolved	back to summary
public DnsNameResolverBuilder completeOncePreferredResolved(boolean completeOncePreferredResolved) If `true` `DnsNameResolver#resolveAll(String)` will notify the returned `Future` as soon as all queries for the preferred address-type are complete. Parameters completeOncePreferredResolved:boolean `true` to enable, `false` to disable. Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder completeOncePreferredResolved(boolean completeOncePreferredResolved)

If true DnsNameResolver#resolveAll(String) will notify the returned Future as soon as all queries for the preferred address-type are complete.

Parameters

completeOncePreferredResolved:boolean: true to enable, false to disable.

Returns:DnsNameResolverBuilder

this

computeResolvedAddressTypes back to summary

computeResolvedAddressTypes	back to summary
public static ResolvedAddressTypes computeResolvedAddressTypes(InternetProtocolFamily... internetProtocolFamilies) Compute a `ResolvedAddressTypes` from some `InternetProtocolFamily`s. An empty input will return the default value, based on "java.net" System properties. Valid inputs are (), (IPv4), (IPv6), (Ipv4, IPv6) and (IPv6, IPv4). Parameters internetProtocolFamilies:InternetProtocolFamily[] a valid sequence of `InternetProtocolFamily`s Returns:ResolvedAddressTypes a `ResolvedAddressTypes`

public static ResolvedAddressTypes computeResolvedAddressTypes(InternetProtocolFamily... internetProtocolFamilies)

Compute a ResolvedAddressTypes from some InternetProtocolFamilys. An empty input will return the default value, based on "java.net" System properties. Valid inputs are (), (IPv4), (IPv6), (Ipv4, IPv6) and (IPv6, IPv4).

Parameters

internetProtocolFamilies:InternetProtocolFamily[]: a valid sequence of InternetProtocolFamilys

Returns:ResolvedAddressTypes

a ResolvedAddressTypes

consolidateCacheSize back to summary

consolidateCacheSize	back to summary
public DnsNameResolverBuilder consolidateCacheSize(int maxNumConsolidation) Set the maximum size of the cache that is used to consolidate lookups for different hostnames when in-flight. 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. Parameters maxNumConsolidation:int the maximum lookups to consolidate (different hostnames), or `0` if no consolidation should be performed. Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder consolidateCacheSize(int maxNumConsolidation)

Set the maximum size of the cache that is used to consolidate lookups for different hostnames when in-flight. 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.

Parameters

maxNumConsolidation:int: the maximum lookups to consolidate (different hostnames), or 0 if no consolidation should be performed.

Returns:DnsNameResolverBuilder

this

copy back to summary

copy	back to summary
public DnsNameResolverBuilder copy() Creates a copy of this `DnsNameResolverBuilder` Returns:DnsNameResolverBuilder `DnsNameResolverBuilder`

public DnsNameResolverBuilder copy()

Creates a copy of this DnsNameResolverBuilder

Returns:DnsNameResolverBuilder: DnsNameResolverBuilder

decodeIdn back to summary

decodeIdn	back to summary
public DnsNameResolverBuilder decodeIdn(boolean decodeIdn) Set if domain / host names should be decoded to unicode when received. See rfc3492. Parameters decodeIdn:boolean if should get decoded Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder decodeIdn(boolean decodeIdn)

Set if domain / host names should be decoded to unicode when received. See rfc3492.

Parameters

decodeIdn:boolean: if should get decoded

Returns:DnsNameResolverBuilder

this

dnsQueryLifecycleObserverFactory back to summary

dnsQueryLifecycleObserverFactory	back to summary
public DnsNameResolverBuilder dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory lifecycleObserverFactory) Set the factory used to generate objects which can observe individual DNS queries. Parameters lifecycleObserverFactory:DnsQueryLifecycleObserverFactory the factory used to generate objects which can observe individual DNS queries. Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory lifecycleObserverFactory)

Set the factory used to generate objects which can observe individual DNS queries.

Parameters

lifecycleObserverFactory:DnsQueryLifecycleObserverFactory: the factory used to generate objects which can observe individual DNS queries.

Returns:DnsNameResolverBuilder

this

eventLoop back to summary

eventLoop	back to summary
public DnsNameResolverBuilder eventLoop(EventLoop eventLoop) Sets the `EventLoop` which will perform the communication with the DNS servers. Parameters eventLoop:EventLoop the `EventLoop` Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder eventLoop(EventLoop eventLoop)

Sets the EventLoop which will perform the communication with the DNS servers.

Parameters

eventLoop:EventLoop: the EventLoop

Returns:DnsNameResolverBuilder

this

hostsFileEntriesResolver	back to summary
public DnsNameResolverBuilder hostsFileEntriesResolver(HostsFileEntriesResolver hostsFileEntriesResolver) Parameters hostsFileEntriesResolver:HostsFileEntriesResolver the `HostsFileEntriesResolver` used to first check if the hostname is locally aliased. Returns:DnsNameResolverBuilder `this`

localAddress back to summary

localAddress	back to summary
public DnsNameResolverBuilder localAddress(SocketAddress localAddress) Configure the address that will be used to bind too. If `null` the default will be used. Parameters localAddress:SocketAddress the bind address Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder localAddress(SocketAddress localAddress)

Configure the address that will be used to bind too. If null the default will be used.

Parameters

localAddress:SocketAddress: the bind address

Returns:DnsNameResolverBuilder

this

maxPayloadSize back to summary

maxPayloadSize	back to summary
public DnsNameResolverBuilder maxPayloadSize(int maxPayloadSize) Sets the capacity of the datagram packet buffer (in bytes). The default value is `4096` bytes. Parameters maxPayloadSize:int the capacity of the datagram packet buffer Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder maxPayloadSize(int maxPayloadSize)

Sets the capacity of the datagram packet buffer (in bytes). The default value is 4096 bytes.

Parameters

maxPayloadSize:int: the capacity of the datagram packet buffer

Returns:DnsNameResolverBuilder

this

maxQueriesPerResolve back to summary

maxQueriesPerResolve	back to summary
public DnsNameResolverBuilder maxQueriesPerResolve(int maxQueriesPerResolve) Sets the maximum allowed number of DNS queries to send when resolving a host name. Parameters maxQueriesPerResolve:int the max number of queries Returns:DnsNameResolverBuilder `this`

public DnsNameResolverBuilder maxQueriesPerResolve(int maxQueriesPerResolve)

Sets the maximum allowed number of DNS queries to send when resolving a host name.

Parameters

maxQueriesPerResolve:int: the max number of queries

Returns:DnsNameResolverBuilder

this

nameServerProvider	back to summary
protected DnsServerAddressStreamProvider nameServerProvider()

nameServerProvider back to summary

public DnsNameResolverBuilder nameServerProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider)

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

Returns:DnsNameResolverBuilder: this.

ndots back to summary

public DnsNameResolverBuilder ndots(int ndots)

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

Parameters

ndots:int: the ndots value

Returns:DnsNameResolverBuilder

this

negativeTtl back to summary

public DnsNameResolverBuilder negativeTtl(int negativeTtl)

Sets the TTL of the cache for the failed DNS queries (in seconds).

Parameters

negativeTtl:int: the TTL for failed cached queries

Returns:DnsNameResolverBuilder

this

newAuthoritativeDnsServerCache	back to summary
private AuthoritativeDnsServerCache newAuthoritativeDnsServerCache()

newCache	back to summary
private DnsCache newCache()

newCnameCache	back to summary
private DnsCnameCache newCnameCache()

optResourceEnabled back to summary

public DnsNameResolverBuilder 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. Some DNSServer may not support this and so fail to answer queries. If you find problems you may want to disable this.

Parameters

optResourceEnabled:boolean: if optional records inclusion is enabled

Returns:DnsNameResolverBuilder

this

queryTimeoutMillis back to summary

public DnsNameResolverBuilder queryTimeoutMillis(long queryTimeoutMillis)

Sets the timeout of each DNS query performed by this resolver (in milliseconds). 0 disables the timeout. If not set or a negative number is set, the default timeout is used.

Parameters

queryTimeoutMillis:long: the query timeout

Returns:DnsNameResolverBuilder

this

recursionDesired back to summary

public DnsNameResolverBuilder recursionDesired(boolean recursionDesired)

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

Parameters

recursionDesired:boolean: true if recursion is desired

Returns:DnsNameResolverBuilder

this

resolveCache back to summary

public DnsNameResolverBuilder resolveCache(DnsCache resolveCache)

Sets the cache for resolution results.

Parameters

resolveCache:DnsCache: the DNS resolution results cache

Returns:DnsNameResolverBuilder

this

resolvedAddressTypes back to summary

public DnsNameResolverBuilder resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes)

Sets the list of the protocol families of the address resolved. You can use DnsNameResolverBuilder#computeResolvedAddressTypes(InternetProtocolFamily...) to get a ResolvedAddressTypes out of some InternetProtocolFamilys.

Parameters

resolvedAddressTypes:ResolvedAddressTypes: the address types

Returns:DnsNameResolverBuilder

this

searchDomains back to summary

public DnsNameResolverBuilder searchDomains(Iterable<String> searchDomains)

Set the list of search domains of the resolver.

Parameters

searchDomains:Iterable<String>: the search domains

Returns:DnsNameResolverBuilder

this

socketChannelFactory back to summary

public DnsNameResolverBuilder socketChannelFactory(ChannelFactory<? extends SocketChannel> channelFactory)

Deprecated

as a consequence of ChannelFactory being deprecated. See corresponding docs for further information.

Sets the ChannelFactory that will create a SocketChannel for TCP fallback if needed. TCP fallback is not enabled by default and must be enabled by providing a non-null ChannelFactory for this method.

Parameters

channelFactory:ChannelFactory<? extends SocketChannel>: the ChannelFactory or null if TCP fallback should not be supported. By default, TCP fallback is not enabled.

Returns:DnsNameResolverBuilder

this

socketChannelFactory back to summary

public DnsNameResolverBuilder socketChannelFactory(ChannelFactory<? extends SocketChannel> channelFactory, boolean retryOnTimeout)

Deprecated

as a consequence of ChannelFactory being deprecated. See corresponding docs for further information.

Parameters

channelFactory:ChannelFactory<? extends SocketChannel>: the ChannelFactory or null if TCP fallback should not be supported. By default, TCP fallback is not enabled.
retryOnTimeout:boolean: if true the DnsNameResolver will also fallback to TCP if a timeout was detected, if false it will only try to use TCP if the response was marked as truncated.

Returns:DnsNameResolverBuilder

this

socketChannelType back to summary

public DnsNameResolverBuilder socketChannelType(Class<? extends SocketChannel> channelType)

Sets the ChannelFactory as a ReflectiveChannelFactory of this type for TCP fallback if needed. Use as an alternative to socketChannelFactory(ChannelFactory). TCP fallback is not enabled by default and must be enabled by providing a non-null channelType for this method.

Parameters

channelType:Class<? extends SocketChannel>: the type or null if TCP fallback should not be supported. By default, TCP fallback is not enabled.

Returns:DnsNameResolverBuilder

this

socketChannelType back to summary

public DnsNameResolverBuilder socketChannelType(Class<? extends SocketChannel> channelType, boolean retryOnTimeout)

Parameters

channelType:Class<? extends SocketChannel>: the type or null if TCP fallback should not be supported. By default, TCP fallback is not enabled.
retryOnTimeout:boolean: if true the DnsNameResolver will also fallback to TCP if a timeout was detected, if false it will only try to use TCP if the response was marked as truncated.

Returns:DnsNameResolverBuilder

this

traceEnabled back to summary

public DnsNameResolverBuilder traceEnabled(boolean traceEnabled)

Deprecated

Prefer to configure a LoggingDnsQueryLifeCycleObserverFactory instead.

Sets if this resolver should generate the detailed trace information in an exception message so that it is easier to understand the cause of resolution failure.

Parameters

traceEnabled:boolean: true if trace is enabled

Returns:DnsNameResolverBuilder

this

Annotations

@Deprecated

ttl back to summary

public DnsNameResolverBuilder ttl(int minTtl, int maxTtl)

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 0 and Integer#MAX_VALUE, which practically tells this resolver to respect the TTL from the DNS server.

Parameters

minTtl:int: the minimum TTL
maxTtl:int: the maximum TTL

Returns:DnsNameResolverBuilder

this

public final Class DnsNameResolverBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail