DnsNameResolverBuilder (Netty API Reference (4.1.33.Final))

java.lang.Object
- io.netty.resolver.dns.DnsNameResolverBuilder

@UnstableApi
public final class DnsNameResolverBuilder
extends java.lang.Object

A DnsNameResolver builder.

Constructor Summary

Constructors
Constructor and Description

DnsNameResolverBuilder()
Creates a new builder.

DnsNameResolverBuilder(EventLoop eventLoop)
Creates a new builder.

Constructors
Constructor and Description
`DnsNameResolverBuilder()` Creates a new builder.
`DnsNameResolverBuilder(EventLoop eventLoop)` Creates a new builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DnsNameResolverBuilder`	`authoritativeDnsServerCache(AuthoritativeDnsServerCache authoritativeDnsServerCache)` Sets the cache for authoritative NS servers
`DnsNameResolverBuilder`	`authoritativeDnsServerCache(DnsCache authoritativeDnsServerCache)` Deprecated. Use `authoritativeDnsServerCache(AuthoritativeDnsServerCache)`
`DnsNameResolver`	`build()` Returns a new `DnsNameResolver` instance.
`protected ChannelFactory<? extends DatagramChannel>`	`channelFactory()`
`DnsNameResolverBuilder`	`channelFactory(ChannelFactory<? extends DatagramChannel> channelFactory)` Sets the `ChannelFactory` that will create a `DatagramChannel`.
`DnsNameResolverBuilder`	`channelType(java.lang.Class<? extends DatagramChannel> channelType)` Sets the `ChannelFactory` as a `ReflectiveChannelFactory` of this type.
`DnsNameResolverBuilder`	`cnameCache(DnsCnameCache cnameCache)` Sets the cache for `CNAME` mappings.
`static ResolvedAddressTypes`	`computeResolvedAddressTypes(InternetProtocolFamily... internetProtocolFamilies)` Compute a `ResolvedAddressTypes` from some `InternetProtocolFamily`s.
`DnsNameResolverBuilder`	`copy()` Creates a copy of this `DnsNameResolverBuilder`
`DnsNameResolverBuilder`	`decodeIdn(boolean decodeIdn)` Set if domain / host names should be decoded to unicode when received.
`DnsNameResolverBuilder`	`dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory lifecycleObserverFactory)` Set the factory used to generate objects which can observe individual DNS queries.
`DnsNameResolverBuilder`	`eventLoop(EventLoop eventLoop)` Sets the `EventLoop` which will perform the communication with the DNS servers.
`DnsNameResolverBuilder`	`hostsFileEntriesResolver(HostsFileEntriesResolver hostsFileEntriesResolver)`
`DnsNameResolverBuilder`	`maxPayloadSize(int maxPayloadSize)` Sets the capacity of the datagram packet buffer (in bytes).
`DnsNameResolverBuilder`	`maxQueriesPerResolve(int maxQueriesPerResolve)` Sets the maximum allowed number of DNS queries to send when resolving a host name.
`protected DnsServerAddressStreamProvider`	`nameServerProvider()`
`DnsNameResolverBuilder`	`nameServerProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider)` Set the `DnsServerAddressStreamProvider` which is used to determine which DNS server is used to resolve each hostname.
`DnsNameResolverBuilder`	`ndots(int ndots)` Set the number of dots which must appear in a name before an initial absolute query is made.
`DnsNameResolverBuilder`	`negativeTtl(int negativeTtl)` Sets the TTL of the cache for the failed DNS queries (in seconds).
`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.
`DnsNameResolverBuilder`	`queryTimeoutMillis(long queryTimeoutMillis)` Sets the timeout of each DNS query performed by this resolver (in milliseconds).
`DnsNameResolverBuilder`	`recursionDesired(boolean recursionDesired)` Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set.
`DnsNameResolverBuilder`	`resolveCache(DnsCache resolveCache)` Sets the cache for resolution results.
`DnsNameResolverBuilder`	`resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes)` Sets the list of the protocol families of the address resolved.
`DnsNameResolverBuilder`	`searchDomains(java.lang.Iterable<java.lang.String> searchDomains)` Set the list of search domains of the resolver.
`DnsNameResolverBuilder`	`traceEnabled(boolean traceEnabled)` 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.
`DnsNameResolverBuilder`	`ttl(int minTtl, int maxTtl)` Sets the minimum and maximum TTL of the cached DNS resource records (in seconds).

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DnsNameResolverBuilder
```
public DnsNameResolverBuilder()
```
    Creates a new builder.
  - DnsNameResolverBuilder
```
public DnsNameResolverBuilder(EventLoop eventLoop)
```
    Creates a new builder.
    
    Parameters:
    
    eventLoop - the EventLoop which will perform the communication with the DNS servers.
- Method Detail
  - eventLoop
```
public DnsNameResolverBuilder eventLoop(EventLoop eventLoop)
```
    Sets the EventLoop which will perform the communication with the DNS servers.
    
    Parameters:
    
    eventLoop - the EventLoop
    
    Returns:
    
    this
  - channelFactory
```
protected ChannelFactory<? extends DatagramChannel> channelFactory()
```
  - channelFactory
```
public DnsNameResolverBuilder channelFactory(ChannelFactory<? extends DatagramChannel> channelFactory)
```
    Sets the ChannelFactory that will create a DatagramChannel.
    
    Parameters:
    
    channelFactory - the ChannelFactory
    
    Returns:
    
    this
  - channelType
```
public DnsNameResolverBuilder channelType(java.lang.Class<? extends DatagramChannel> channelType)
```
    Sets the ChannelFactory as a ReflectiveChannelFactory of this type. Use as an alternative to channelFactory(ChannelFactory).
    
    Parameters:
    
    channelType - the type
    
    Returns:
    
    this
  - resolveCache
```
public DnsNameResolverBuilder resolveCache(DnsCache resolveCache)
```
    Sets the cache for resolution results.
    
    Parameters:
    
    resolveCache - the DNS resolution results cache
    
    Returns:
    
    this
  - cnameCache
```
public DnsNameResolverBuilder cnameCache(DnsCnameCache cnameCache)
```
    Sets the cache for CNAME mappings.
    
    Parameters:
    
    cnameCache - the cache used to cache CNAME mappings for a domain.
    
    Returns:
    
    this
  - dnsQueryLifecycleObserverFactory
```
public DnsNameResolverBuilder dnsQueryLifecycleObserverFactory(DnsQueryLifecycleObserverFactory lifecycleObserverFactory)
```
    Set the factory used to generate objects which can observe individual DNS queries.
    
    Parameters:
    
    lifecycleObserverFactory - the factory used to generate objects which can observe individual DNS queries.
    
    Returns:
    
    this
  - authoritativeDnsServerCache
```
@Deprecated
public DnsNameResolverBuilder authoritativeDnsServerCache(DnsCache authoritativeDnsServerCache)
```
    Deprecated. Use authoritativeDnsServerCache(AuthoritativeDnsServerCache)
    
    Sets the cache for authoritative NS servers
    
    Parameters:
    
    authoritativeDnsServerCache - the authoritative NS servers cache
    
    Returns:
    
    this
  - authoritativeDnsServerCache
```
public DnsNameResolverBuilder authoritativeDnsServerCache(AuthoritativeDnsServerCache authoritativeDnsServerCache)
```
    Sets the cache for authoritative NS servers
    
    Parameters:
    
    authoritativeDnsServerCache - the authoritative NS servers cache
    
    Returns:
    
    this
  - ttl
```
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 - the minimum TTL
    
    maxTtl - the maximum TTL
    
    Returns:
    
    this
  - negativeTtl
```
public DnsNameResolverBuilder negativeTtl(int negativeTtl)
```
    Sets the TTL of the cache for the failed DNS queries (in seconds).
    
    Parameters:
    
    negativeTtl - the TTL for failed cached queries
    
    Returns:
    
    this
  - queryTimeoutMillis
```
public DnsNameResolverBuilder queryTimeoutMillis(long queryTimeoutMillis)
```
    Sets the timeout of each DNS query performed by this resolver (in milliseconds).
    
    Parameters:
    
    queryTimeoutMillis - the query timeout
    
    Returns:
    
    this
  - computeResolvedAddressTypes
```
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 - a valid sequence of InternetProtocolFamilys
    
    Returns:
    
    a ResolvedAddressTypes
  - resolvedAddressTypes
```
public DnsNameResolverBuilder resolvedAddressTypes(ResolvedAddressTypes resolvedAddressTypes)
```
    Sets the list of the protocol families of the address resolved. You can use computeResolvedAddressTypes(InternetProtocolFamily...) to get a ResolvedAddressTypes out of some InternetProtocolFamilys.
    
    Parameters:
    
    resolvedAddressTypes - the address types
    
    Returns:
    
    this
  - recursionDesired
```
public DnsNameResolverBuilder recursionDesired(boolean recursionDesired)
```
    Sets if this resolver has to send a DNS query with the RD (recursion desired) flag set.
    
    Parameters:
    
    recursionDesired - true if recursion is desired
    
    Returns:
    
    this
  - maxQueriesPerResolve
```
public DnsNameResolverBuilder maxQueriesPerResolve(int maxQueriesPerResolve)
```
    Sets the maximum allowed number of DNS queries to send when resolving a host name.
    
    Parameters:
    
    maxQueriesPerResolve - the max number of queries
    
    Returns:
    
    this
  - traceEnabled
```
public DnsNameResolverBuilder traceEnabled(boolean traceEnabled)
```
    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 - true if trace is enabled
    
    Returns:
    
    this
  - maxPayloadSize
```
public DnsNameResolverBuilder maxPayloadSize(int maxPayloadSize)
```
    Sets the capacity of the datagram packet buffer (in bytes). The default value is 4096 bytes.
    
    Parameters:
    
    maxPayloadSize - the capacity of the datagram packet buffer
    
    Returns:
    
    this
  - optResourceEnabled
```
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 - if optional records inclusion is enabled
    
    Returns:
    
    this
  - hostsFileEntriesResolver
```
public DnsNameResolverBuilder hostsFileEntriesResolver(HostsFileEntriesResolver hostsFileEntriesResolver)
```
    Parameters:
    
    hostsFileEntriesResolver - the HostsFileEntriesResolver used to first check if the hostname is locally aliased.
    
    Returns:
    
    this
  - nameServerProvider
```
protected DnsServerAddressStreamProvider nameServerProvider()
```
  - nameServerProvider
```
public DnsNameResolverBuilder nameServerProvider(DnsServerAddressStreamProvider dnsServerAddressStreamProvider)
```
    Set the DnsServerAddressStreamProvider which is used to determine which DNS server is used to resolve each hostname.
    
    Returns:
    
    this.
  - searchDomains
```
public DnsNameResolverBuilder searchDomains(java.lang.Iterable<java.lang.String> searchDomains)
```
    Set the list of search domains of the resolver.
    
    Parameters:
    
    searchDomains - the search domains
    
    Returns:
    
    this
  - ndots
```
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 - the ndots value
    
    Returns:
    
    this
  - decodeIdn
```
public DnsNameResolverBuilder decodeIdn(boolean decodeIdn)
```
    Set if domain / host names should be decoded to unicode when received. See rfc3492.
    
    Parameters:
    
    decodeIdn - if should get decoded
    
    Returns:
    
    this
  - build
```
public DnsNameResolver build()
```
    Returns a new DnsNameResolver instance.
    
    Returns:
    
    a DnsNameResolver
  - copy
```
public DnsNameResolverBuilder copy()
```
    Creates a copy of this DnsNameResolverBuilder
    
    Returns:
    
    DnsNameResolverBuilder

Class DnsNameResolverBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DnsNameResolverBuilder

DnsNameResolverBuilder

Method Detail

eventLoop

channelFactory

channelFactory

channelType

resolveCache

cnameCache

dnsQueryLifecycleObserverFactory

authoritativeDnsServerCache

authoritativeDnsServerCache

ttl

negativeTtl

queryTimeoutMillis

computeResolvedAddressTypes

resolvedAddressTypes

recursionDesired

maxQueriesPerResolve

traceEnabled

maxPayloadSize

optResourceEnabled

hostsFileEntriesResolver

nameServerProvider

nameServerProvider

searchDomains

ndots

decodeIdn

build

copy