Package io.netty.resolver.dns
Class DnsNameResolver
- java.lang.Object
-
- io.netty.resolver.SimpleNameResolver<java.net.InetAddress>
-
- io.netty.resolver.InetNameResolver
-
- io.netty.resolver.dns.DnsNameResolver
-
- All Implemented Interfaces:
NameResolver<java.net.InetAddress>
,java.io.Closeable
,java.lang.AutoCloseable
public class DnsNameResolver extends InetNameResolver
A DNS-basedInetNameResolver
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
DnsNameResolver.DnsResolveChannelPerResolutionProvider
private static class
DnsNameResolver.DnsResolveChannelPerResolverProvider
private static interface
DnsNameResolver.DnsResolveChannelProvider
private static class
DnsNameResolver.DnsResponseHandler
-
Field Summary
-
Constructor Summary
Constructors Constructor Description DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, ChannelFactory<? extends SocketChannel> socketChannelFactory, boolean retryWithTcpOnTimeout, DnsCache resolveCache, DnsCnameCache cnameCache, AuthoritativeDnsServerCache authoritativeDnsServerCache, java.net.SocketAddress localAddress, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, DnsServerAddressStream queryDnsServerAddressStream, java.lang.String[] searchDomains, int ndots, boolean decodeIdn, boolean completeOncePreferredResolved, int maxNumConsolidation, DnsNameResolverChannelStrategy datagramChannelStrategy)
DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, DnsCache resolveCache, AuthoritativeDnsServerCache authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, java.lang.String[] searchDomains, int ndots, boolean decodeIdn)
Deprecated.DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, DnsCache resolveCache, DnsCache authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, java.lang.String[] searchDomains, int ndots, boolean decodeIdn)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description private static boolean
anyInterfaceSupportsIpV6()
Returnstrue
if anyNetworkInterface
supportsIPv6
,false
otherwise.AuthoritativeDnsServerCache
authoritativeDnsServerCache()
Returns the cache used for authoritative DNS servers for a domain.private static Promise<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
cast(Promise<?> promise)
void
close()
Closes the internal datagram channel used for sending and receiving DNS messages, and clears all DNS resource records from the cache.DnsCnameCache
cnameCache()
Returns theDnsCnameCache
.(package private) DnsQueryLifecycleObserverFactory
dnsQueryLifecycleObserverFactory()
(package private) Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
doQuery(Channel channel, java.net.InetSocketAddress nameServerAddr, DnsQuestion question, DnsQueryLifecycleObserver queryLifecycleObserver, DnsRecord[] additionals, boolean flush, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
protected void
doResolve(java.lang.String inetHost, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache)
Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.protected void
doResolve(java.lang.String inetHost, Promise<java.net.InetAddress> promise)
Invoked bySimpleNameResolver.resolve(String)
to perform the actual name resolution.protected void
doResolveAll(java.lang.String inetHost, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache)
Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.protected void
doResolveAll(java.lang.String inetHost, Promise<java.util.List<java.net.InetAddress>> promise)
Invoked bySimpleNameResolver.resolveAll(String)
to perform the actual name resolution.(package private) static boolean
doResolveAllCached(java.lang.String hostname, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, java.lang.String[] searchDomains, int ndots, InternetProtocolFamily[] resolvedInternetProtocolFamilies)
private void
doResolveAllNow(ChannelFuture f, java.lang.String hostname, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache)
private void
doResolveAllUncached(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
private void
doResolveAllUncached0(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
private boolean
doResolveCached(java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache)
private void
doResolveNow(ChannelFuture f, java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache)
private void
doResolveUncached(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
protected EventLoop
executor()
Returns theEventExecutor
which is used to notify the listeners of theFuture
returned bySimpleNameResolver.resolve(String)
.private static java.util.List<java.lang.String>
getSearchDomainsHack()
private static boolean
hasEntries(java.util.List<? extends DnsCacheEntry> cachedEntries)
private static java.lang.String
hostname(java.lang.String inetHost)
HostsFileEntriesResolver
hostsFileEntriesResolver()
Returns the component that tries to resolve hostnames against the hosts file prior to asking to remotes DNS servers.(package private) boolean
isDecodeIdn()
private static boolean
isLocalWindowsHost(java.lang.String hostname)
Checks whether the given hostname is the localhost/host (computer) name on Windows OS.boolean
isOptResourceEnabled()
Returns 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 is enabled.boolean
isRecursionDesired()
Returnstrue
if and only if this resolver sends a DNS query with the RD (recursion desired) flag set.static boolean
isTimeoutError(java.lang.Throwable cause)
Returnstrue
if theThrowable
was caused by an timeout.static boolean
isTransportOrTimeoutError(java.lang.Throwable cause)
Returnstrue
if theThrowable
was caused by an timeout or transport error.private java.net.InetAddress
loopbackAddress()
int
maxPayloadSize()
Returns the capacity of the datagram packet buffer (in bytes).int
maxQueriesPerResolve()
Returns the maximum allowed number of DNS queries to send when resolving a host name.(package private) int
ndots()
(package private) DnsServerAddressStream
newNameServerAddressStream(java.lang.String hostname)
private static DnsNameResolver.DnsResolveChannelProvider
newProvider(DnsNameResolverChannelStrategy channelStrategy, Bootstrap bootstrap, java.net.SocketAddress localAddress)
protected DnsServerAddressStream
newRedirectDnsServerStream(java.lang.String hostname, java.util.List<java.net.InetSocketAddress> nameservers)
Creates a newDnsServerAddressStream
to following a redirected DNS query.(package private) java.net.InetSocketAddress
newRedirectServerAddress(java.net.InetAddress server)
private java.net.InetSocketAddress
nextNameServerAddress()
(package private) InternetProtocolFamily
preferredAddressType()
(package private) static InternetProtocolFamily
preferredAddressType(ResolvedAddressTypes resolvedAddressTypes)
Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(DnsQuestion question)
Sends a DNS query with the specified question.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Sends a DNS query with the specified question with additional records.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question)
Sends a DNS query with the specified question using the specified name server list.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question using the specified name server list.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Sends a DNS query with the specified question with additional records using the specified name server list.Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>>
query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, java.lang.Iterable<DnsRecord> additionals, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question with additional records using the specified name server list.DnsServerAddressStream
queryDnsServerAddressStream()
Returns the dns server address stream used for DNS queries (not resolve).long
queryTimeoutMillis()
Returns the timeout of each DNS query performed by this resolver (in milliseconds).private static ChannelFuture
registerOrBind(Bootstrap bootstrap, java.net.SocketAddress localAddress)
Future<java.net.InetAddress>
resolve(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals)
Resolves the specified name into an address.Future<java.net.InetAddress>
resolve(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals, Promise<java.net.InetAddress> promise)
Resolves the specified name into an address.Future<java.util.List<DnsRecord>>
resolveAll(DnsQuestion question)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
.private Future<java.util.List<DnsRecord>>
resolveAll(DnsQuestion question, DnsRecord[] additionals, Promise<java.util.List<DnsRecord>> promise)
Future<java.util.List<DnsRecord>>
resolveAll(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
.Future<java.util.List<DnsRecord>>
resolveAll(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals, Promise<java.util.List<DnsRecord>> promise)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
.Future<java.util.List<java.net.InetAddress>>
resolveAll(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals)
Resolves the specified host name and port into a list of address.Future<java.util.List<java.net.InetAddress>>
resolveAll(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals, Promise<java.util.List<java.net.InetAddress>> promise)
Resolves the specified host name and port into a list of address.private void
resolveAllNow(ChannelFuture f, java.lang.String hostname, DnsQuestion question, DnsRecord[] additionals, Promise<java.util.List<DnsRecord>> promise)
DnsCache
resolveCache()
Returns the resolution cache.ResolvedAddressTypes
resolvedAddressTypes()
Returns theResolvedAddressTypes
resolved bySimpleNameResolver.resolve(String)
.(package private) InternetProtocolFamily[]
resolvedInternetProtocolFamiliesUnsafe()
private java.util.List<java.net.InetAddress>
resolveHostsFileEntries(java.lang.String hostname)
private java.net.InetAddress
resolveHostsFileEntry(java.lang.String hostname)
private void
resolveNow(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
(package private) DnsRecordType[]
resolveRecordTypes()
(package private) java.lang.String[]
searchDomains()
(package private) boolean
supportsAAAARecords()
(package private) boolean
supportsARecords()
private static DnsRecord[]
toArray(java.lang.Iterable<DnsRecord> additionals, boolean validateType)
private static java.net.UnknownHostException
toException(ChannelFuture f, java.lang.String hostname, DnsQuestion question, DnsRecord[] additionals)
private static void
tryFailure(Promise<?> promise, java.lang.Throwable cause)
(package private) static <T> boolean
trySuccess(Promise<T> promise, T result)
private static void
validateAdditional(DnsRecord record, boolean validateType)
-
Methods inherited from class io.netty.resolver.InetNameResolver
asAddressResolver
-
Methods inherited from class io.netty.resolver.SimpleNameResolver
resolve, resolve, resolveAll, resolveAll
-
-
-
-
Field Detail
-
DNS_PIPELINE_ATTRIBUTE
public static final AttributeKey<java.lang.Boolean> DNS_PIPELINE_ATTRIBUTE
An attribute used to mark all channels created by theDnsNameResolver
.
-
logger
private static final InternalLogger logger
-
LOCALHOST
private static final java.lang.String LOCALHOST
- See Also:
- Constant Field Values
-
WINDOWS_HOST_NAME
private static final java.lang.String WINDOWS_HOST_NAME
-
LOCALHOST_ADDRESS
private static final java.net.InetAddress LOCALHOST_ADDRESS
-
EMPTY_ADDITIONALS
private static final DnsRecord[] EMPTY_ADDITIONALS
-
IPV4_ONLY_RESOLVED_RECORD_TYPES
private static final DnsRecordType[] IPV4_ONLY_RESOLVED_RECORD_TYPES
-
IPV4_ONLY_RESOLVED_PROTOCOL_FAMILIES
private static final InternetProtocolFamily[] IPV4_ONLY_RESOLVED_PROTOCOL_FAMILIES
-
IPV4_PREFERRED_RESOLVED_RECORD_TYPES
private static final DnsRecordType[] IPV4_PREFERRED_RESOLVED_RECORD_TYPES
-
IPV4_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
private static final InternetProtocolFamily[] IPV4_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
-
IPV6_ONLY_RESOLVED_RECORD_TYPES
private static final DnsRecordType[] IPV6_ONLY_RESOLVED_RECORD_TYPES
-
IPV6_ONLY_RESOLVED_PROTOCOL_FAMILIES
private static final InternetProtocolFamily[] IPV6_ONLY_RESOLVED_PROTOCOL_FAMILIES
-
IPV6_PREFERRED_RESOLVED_RECORD_TYPES
private static final DnsRecordType[] IPV6_PREFERRED_RESOLVED_RECORD_TYPES
-
IPV6_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
private static final InternetProtocolFamily[] IPV6_PREFERRED_RESOLVED_PROTOCOL_FAMILIES
-
NOOP_HANDLER
private static final ChannelHandler NOOP_HANDLER
-
DEFAULT_RESOLVE_ADDRESS_TYPES
static final ResolvedAddressTypes DEFAULT_RESOLVE_ADDRESS_TYPES
-
DEFAULT_SEARCH_DOMAINS
static final java.lang.String[] DEFAULT_SEARCH_DOMAINS
-
DEFAULT_OPTIONS
private static final UnixResolverOptions DEFAULT_OPTIONS
-
DATAGRAM_DECODER
private static final DatagramDnsResponseDecoder DATAGRAM_DECODER
-
DATAGRAM_ENCODER
private static final DatagramDnsQueryEncoder DATAGRAM_ENCODER
-
nameServerComparator
private final java.util.Comparator<java.net.InetSocketAddress> nameServerComparator
-
queryContextManager
private final DnsQueryContextManager queryContextManager
Manages theDnsQueryContext
s in progress and their query IDs.
-
resolveCache
private final DnsCache resolveCache
Cache fordoResolve(String, Promise)
anddoResolveAll(String, Promise)
.
-
authoritativeDnsServerCache
private final AuthoritativeDnsServerCache authoritativeDnsServerCache
-
cnameCache
private final DnsCnameCache cnameCache
-
queryDnsServerAddressStream
private final DnsServerAddressStream queryDnsServerAddressStream
-
queryTimeoutMillis
private final long queryTimeoutMillis
-
maxQueriesPerResolve
private final int maxQueriesPerResolve
-
resolvedAddressTypes
private final ResolvedAddressTypes resolvedAddressTypes
-
resolvedInternetProtocolFamilies
private final InternetProtocolFamily[] resolvedInternetProtocolFamilies
-
recursionDesired
private final boolean recursionDesired
-
maxPayloadSize
private final int maxPayloadSize
-
optResourceEnabled
private final boolean optResourceEnabled
-
hostsFileEntriesResolver
private final HostsFileEntriesResolver hostsFileEntriesResolver
-
dnsServerAddressStreamProvider
private final DnsServerAddressStreamProvider dnsServerAddressStreamProvider
-
searchDomains
private final java.lang.String[] searchDomains
-
ndots
private final int ndots
-
supportsAAAARecords
private final boolean supportsAAAARecords
-
supportsARecords
private final boolean supportsARecords
-
preferredAddressType
private final InternetProtocolFamily preferredAddressType
-
resolveRecordTypes
private final DnsRecordType[] resolveRecordTypes
-
decodeIdn
private final boolean decodeIdn
-
dnsQueryLifecycleObserverFactory
private final DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory
-
completeOncePreferredResolved
private final boolean completeOncePreferredResolved
-
resolveChannelProvider
private final DnsNameResolver.DnsResolveChannelProvider resolveChannelProvider
-
socketBootstrap
private final Bootstrap socketBootstrap
-
retryWithTcpOnTimeout
private final boolean retryWithTcpOnTimeout
-
maxNumConsolidation
private final int maxNumConsolidation
-
inflightLookups
private final java.util.Map<java.lang.String,Future<java.util.List<java.net.InetAddress>>> inflightLookups
-
-
Constructor Detail
-
DnsNameResolver
@Deprecated public DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, DnsCache resolveCache, DnsCache authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, java.lang.String[] searchDomains, int ndots, boolean decodeIdn)
Deprecated.Creates a new DNS-based name resolver that communicates with the specified list of DNS servers.- Parameters:
eventLoop
- theEventLoop
which will perform the communication with the DNS serverschannelFactory
- theChannelFactory
that will create aDatagramChannel
resolveCache
- the DNS resolved entries cacheauthoritativeDnsServerCache
- the cache used to find the authoritative DNS server for a domaindnsQueryLifecycleObserverFactory
- used to generate new instances ofDnsQueryLifecycleObserver
which can be used to track metrics for DNS servers.queryTimeoutMillis
- timeout of each DNS query in millis.0
disables the timeout. If not set or a negative number is set, the default timeout is used.resolvedAddressTypes
- the preferred address typesrecursionDesired
- if recursion desired flag must be setmaxQueriesPerResolve
- the maximum allowed number of DNS queries for a given name resolutiontraceEnabled
- if trace is enabledmaxPayloadSize
- the capacity of the datagram packet bufferoptResourceEnabled
- if automatic inclusion of a optional records is enabledhostsFileEntriesResolver
- theHostsFileEntriesResolver
used to check for local aliasesdnsServerAddressStreamProvider
- TheDnsServerAddressStreamProvider
used to determine the name servers for each hostname lookup.searchDomains
- the list of search domain (can be null, if so, will try to default to the underlying platform ones)ndots
- the ndots valuedecodeIdn
-true
if domain / host names should be decoded to unicode when received. See rfc3492.
-
DnsNameResolver
@Deprecated public DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, DnsCache resolveCache, AuthoritativeDnsServerCache authoritativeDnsServerCache, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, java.lang.String[] searchDomains, int ndots, boolean decodeIdn)
Deprecated.Creates a new DNS-based name resolver that communicates with the specified list of DNS servers.- Parameters:
eventLoop
- theEventLoop
which will perform the communication with the DNS serverschannelFactory
- theChannelFactory
that will create aDatagramChannel
resolveCache
- the DNS resolved entries cacheauthoritativeDnsServerCache
- the cache used to find the authoritative DNS server for a domaindnsQueryLifecycleObserverFactory
- used to generate new instances ofDnsQueryLifecycleObserver
which can be used to track metrics for DNS servers.queryTimeoutMillis
- timeout of each DNS query in millis.0
disables the timeout. If not set or a negative number is set, the default timeout is used.resolvedAddressTypes
- the preferred address typesrecursionDesired
- if recursion desired flag must be setmaxQueriesPerResolve
- the maximum allowed number of DNS queries for a given name resolutiontraceEnabled
- if trace is enabledmaxPayloadSize
- the capacity of the datagram packet bufferoptResourceEnabled
- if automatic inclusion of a optional records is enabledhostsFileEntriesResolver
- theHostsFileEntriesResolver
used to check for local aliasesdnsServerAddressStreamProvider
- TheDnsServerAddressStreamProvider
used to determine the name servers for each hostname lookup.searchDomains
- the list of search domain (can be null, if so, will try to default to the underlying platform ones)ndots
- the ndots valuedecodeIdn
-true
if domain / host names should be decoded to unicode when received. See rfc3492.
-
DnsNameResolver
DnsNameResolver(EventLoop eventLoop, ChannelFactory<? extends DatagramChannel> channelFactory, ChannelFactory<? extends SocketChannel> socketChannelFactory, boolean retryWithTcpOnTimeout, DnsCache resolveCache, DnsCnameCache cnameCache, AuthoritativeDnsServerCache authoritativeDnsServerCache, java.net.SocketAddress localAddress, DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory, long queryTimeoutMillis, ResolvedAddressTypes resolvedAddressTypes, boolean recursionDesired, int maxQueriesPerResolve, boolean traceEnabled, int maxPayloadSize, boolean optResourceEnabled, HostsFileEntriesResolver hostsFileEntriesResolver, DnsServerAddressStreamProvider dnsServerAddressStreamProvider, DnsServerAddressStream queryDnsServerAddressStream, java.lang.String[] searchDomains, int ndots, boolean decodeIdn, boolean completeOncePreferredResolved, int maxNumConsolidation, DnsNameResolverChannelStrategy datagramChannelStrategy)
-
-
Method Detail
-
anyInterfaceSupportsIpV6
private static boolean anyInterfaceSupportsIpV6()
Returnstrue
if anyNetworkInterface
supportsIPv6
,false
otherwise.
-
getSearchDomainsHack
private static java.util.List<java.lang.String> getSearchDomainsHack() throws java.lang.Exception
- Throws:
java.lang.Exception
-
newProvider
private static DnsNameResolver.DnsResolveChannelProvider newProvider(DnsNameResolverChannelStrategy channelStrategy, Bootstrap bootstrap, java.net.SocketAddress localAddress)
-
preferredAddressType
static InternetProtocolFamily preferredAddressType(ResolvedAddressTypes resolvedAddressTypes)
-
newRedirectServerAddress
java.net.InetSocketAddress newRedirectServerAddress(java.net.InetAddress server)
-
dnsQueryLifecycleObserverFactory
final DnsQueryLifecycleObserverFactory dnsQueryLifecycleObserverFactory()
-
newRedirectDnsServerStream
protected DnsServerAddressStream newRedirectDnsServerStream(java.lang.String hostname, java.util.List<java.net.InetSocketAddress> nameservers)
Creates a newDnsServerAddressStream
to following a redirected DNS query. By overriding this it provides the opportunity to sort the name servers before following a redirected DNS query.- Parameters:
hostname
- the hostname.nameservers
- The addresses of the DNS servers which are used in the event of a redirect. This may contain resolved and unresolved addresses so the usedDnsServerAddressStream
must allow unresolved addresses if you want to include these as well.- Returns:
- A
DnsServerAddressStream
which will be used to follow the DNS redirect ornull
if none should be followed.
-
resolveCache
public DnsCache resolveCache()
Returns the resolution cache.
-
cnameCache
public DnsCnameCache cnameCache()
Returns theDnsCnameCache
.
-
authoritativeDnsServerCache
public AuthoritativeDnsServerCache authoritativeDnsServerCache()
Returns the cache used for authoritative DNS servers for a domain.
-
queryTimeoutMillis
public long queryTimeoutMillis()
Returns the timeout of each DNS query performed by this resolver (in milliseconds). The default value is 5 seconds.
-
queryDnsServerAddressStream
public DnsServerAddressStream queryDnsServerAddressStream()
Returns the dns server address stream used for DNS queries (not resolve).
-
resolvedAddressTypes
public ResolvedAddressTypes resolvedAddressTypes()
Returns theResolvedAddressTypes
resolved bySimpleNameResolver.resolve(String)
. The default value depends on the value of the system property"java.net.preferIPv6Addresses"
.
-
resolvedInternetProtocolFamiliesUnsafe
InternetProtocolFamily[] resolvedInternetProtocolFamiliesUnsafe()
-
searchDomains
final java.lang.String[] searchDomains()
-
ndots
final int ndots()
-
supportsAAAARecords
final boolean supportsAAAARecords()
-
supportsARecords
final boolean supportsARecords()
-
preferredAddressType
final InternetProtocolFamily preferredAddressType()
-
resolveRecordTypes
final DnsRecordType[] resolveRecordTypes()
-
isDecodeIdn
final boolean isDecodeIdn()
-
isRecursionDesired
public boolean isRecursionDesired()
Returnstrue
if and only if this resolver sends a DNS query with the RD (recursion desired) flag set. The default value istrue
.
-
maxQueriesPerResolve
public int maxQueriesPerResolve()
Returns the maximum allowed number of DNS queries to send when resolving a host name. The default value is8
.
-
maxPayloadSize
public int maxPayloadSize()
Returns the capacity of the datagram packet buffer (in bytes). The default value is4096
bytes.
-
isOptResourceEnabled
public boolean isOptResourceEnabled()
Returns 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 is enabled.
-
hostsFileEntriesResolver
public HostsFileEntriesResolver hostsFileEntriesResolver()
Returns the component that tries to resolve hostnames against the hosts file prior to asking to remotes DNS servers.
-
close
public void close()
Closes the internal datagram channel used for sending and receiving DNS messages, and clears all DNS resource records from the cache. Attempting to send a DNS query or to resolve a domain name will fail once this method has been called.- Specified by:
close
in interfacejava.lang.AutoCloseable
- Specified by:
close
in interfacejava.io.Closeable
- Specified by:
close
in interfaceNameResolver<java.net.InetAddress>
- Overrides:
close
in classSimpleNameResolver<java.net.InetAddress>
-
executor
protected EventLoop executor()
Description copied from class:SimpleNameResolver
Returns theEventExecutor
which is used to notify the listeners of theFuture
returned bySimpleNameResolver.resolve(String)
.- Overrides:
executor
in classSimpleNameResolver<java.net.InetAddress>
-
resolveHostsFileEntry
private java.net.InetAddress resolveHostsFileEntry(java.lang.String hostname)
-
resolveHostsFileEntries
private java.util.List<java.net.InetAddress> resolveHostsFileEntries(java.lang.String hostname)
-
isLocalWindowsHost
private static boolean isLocalWindowsHost(java.lang.String hostname)
Checks whether the given hostname is the localhost/host (computer) name on Windows OS. Windows OS removed the localhost/host (computer) name information from the hosts file in the later versions and such hostname cannot be resolved from hosts file. See https://github.com/netty/netty/issues/5386 See https://github.com/netty/netty/issues/11142
-
resolve
public final Future<java.net.InetAddress> resolve(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals)
Resolves the specified name into an address.- Parameters:
inetHost
- the name to resolveadditionals
- additional records (OPT
)- Returns:
- the address as the result of the resolution
-
resolve
public final Future<java.net.InetAddress> resolve(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals, Promise<java.net.InetAddress> promise)
Resolves the specified name into an address.- Parameters:
inetHost
- the name to resolveadditionals
- additional records (OPT
)promise
- thePromise
which will be fulfilled when the name resolution is finished- Returns:
- the address as the result of the resolution
-
resolveAll
public final Future<java.util.List<java.net.InetAddress>> resolveAll(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals)
Resolves the specified host name and port into a list of address.- Parameters:
inetHost
- the name to resolveadditionals
- additional records (OPT
)- Returns:
- the list of the address as the result of the resolution
-
resolveAll
public final Future<java.util.List<java.net.InetAddress>> resolveAll(java.lang.String inetHost, java.lang.Iterable<DnsRecord> additionals, Promise<java.util.List<java.net.InetAddress>> promise)
Resolves the specified host name and port into a list of address.- Parameters:
inetHost
- the name to resolveadditionals
- additional records (OPT
)promise
- thePromise
which will be fulfilled when the name resolution is finished- Returns:
- the list of the address as the result of the resolution
-
doResolve
protected void doResolve(java.lang.String inetHost, Promise<java.net.InetAddress> promise) throws java.lang.Exception
Description copied from class:SimpleNameResolver
Invoked bySimpleNameResolver.resolve(String)
to perform the actual name resolution.- Specified by:
doResolve
in classSimpleNameResolver<java.net.InetAddress>
- Throws:
java.lang.Exception
-
resolveAll
public final Future<java.util.List<DnsRecord>> resolveAll(DnsQuestion question)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
. Unlikequery(DnsQuestion)
, this method handles redirection, CNAMEs and multiple name servers. If the specifiedDnsQuestion
isA
orAAAA
, this method looks up the configuredHostsFileEntries
before sending a query to the name servers. If a match is found in theHostsFileEntries
, a syntheticA
orAAAA
record will be returned.- Parameters:
question
- the question- Returns:
- the list of the
DnsRecord
s as the result of the resolution
-
resolveAll
public final Future<java.util.List<DnsRecord>> resolveAll(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
. Unlikequery(DnsQuestion)
, this method handles redirection, CNAMEs and multiple name servers. If the specifiedDnsQuestion
isA
orAAAA
, this method looks up the configuredHostsFileEntries
before sending a query to the name servers. If a match is found in theHostsFileEntries
, a syntheticA
orAAAA
record will be returned.- Parameters:
question
- the questionadditionals
- additional records (OPT
)- Returns:
- the list of the
DnsRecord
s as the result of the resolution
-
resolveAll
public final Future<java.util.List<DnsRecord>> resolveAll(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals, Promise<java.util.List<DnsRecord>> promise)
Resolves theDnsRecord
s that are matched by the specifiedDnsQuestion
. Unlikequery(DnsQuestion)
, this method handles redirection, CNAMEs and multiple name servers. If the specifiedDnsQuestion
isA
orAAAA
, this method looks up the configuredHostsFileEntries
before sending a query to the name servers. If a match is found in theHostsFileEntries
, a syntheticA
orAAAA
record will be returned.
-
resolveAll
private Future<java.util.List<DnsRecord>> resolveAll(DnsQuestion question, DnsRecord[] additionals, Promise<java.util.List<DnsRecord>> promise)
-
resolveAllNow
private void resolveAllNow(ChannelFuture f, java.lang.String hostname, DnsQuestion question, DnsRecord[] additionals, Promise<java.util.List<DnsRecord>> promise)
-
toException
private static java.net.UnknownHostException toException(ChannelFuture f, java.lang.String hostname, DnsQuestion question, DnsRecord[] additionals)
-
toArray
private static DnsRecord[] toArray(java.lang.Iterable<DnsRecord> additionals, boolean validateType)
-
validateAdditional
private static void validateAdditional(DnsRecord record, boolean validateType)
-
loopbackAddress
private java.net.InetAddress loopbackAddress()
-
doResolve
protected void doResolve(java.lang.String inetHost, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache) throws java.lang.Exception
Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.- Throws:
java.lang.Exception
-
doResolveNow
private void doResolveNow(ChannelFuture f, java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache)
-
doResolveCached
private boolean doResolveCached(java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache)
-
trySuccess
static <T> boolean trySuccess(Promise<T> promise, T result)
-
tryFailure
private static void tryFailure(Promise<?> promise, java.lang.Throwable cause)
-
doResolveUncached
private void doResolveUncached(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<java.net.InetAddress> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
-
doResolveAll
protected void doResolveAll(java.lang.String inetHost, Promise<java.util.List<java.net.InetAddress>> promise) throws java.lang.Exception
Description copied from class:SimpleNameResolver
Invoked bySimpleNameResolver.resolveAll(String)
to perform the actual name resolution.- Specified by:
doResolveAll
in classSimpleNameResolver<java.net.InetAddress>
- Throws:
java.lang.Exception
-
doResolveAll
protected void doResolveAll(java.lang.String inetHost, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache) throws java.lang.Exception
Hook designed for extensibility so one can pass a different cache on each resolution attempt instead of using the global one.- Throws:
java.lang.Exception
-
doResolveAllNow
private void doResolveAllNow(ChannelFuture f, java.lang.String hostname, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache)
-
hasEntries
private static boolean hasEntries(java.util.List<? extends DnsCacheEntry> cachedEntries)
-
doResolveAllCached
static boolean doResolveAllCached(java.lang.String hostname, DnsRecord[] additionals, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, java.lang.String[] searchDomains, int ndots, InternetProtocolFamily[] resolvedInternetProtocolFamilies)
-
doResolveAllUncached
private void doResolveAllUncached(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
-
doResolveAllUncached0
private void doResolveAllUncached0(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
-
resolveNow
private void resolveNow(Channel channel, java.lang.String hostname, DnsRecord[] additionals, Promise<?> originalPromise, Promise<java.util.List<java.net.InetAddress>> promise, DnsCache resolveCache, boolean completeEarlyIfPossible)
-
hostname
private static java.lang.String hostname(java.lang.String inetHost)
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(DnsQuestion question)
Sends a DNS query with the specified question.
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Sends a DNS query with the specified question with additional records.
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question.
-
nextNameServerAddress
private java.net.InetSocketAddress nextNameServerAddress()
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question)
Sends a DNS query with the specified question using the specified name server list.
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, java.lang.Iterable<DnsRecord> additionals)
Sends a DNS query with the specified question with additional records using the specified name server list.
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question using the specified name server list.
-
query
public Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> query(java.net.InetSocketAddress nameServerAddr, DnsQuestion question, java.lang.Iterable<DnsRecord> additionals, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
Sends a DNS query with the specified question with additional records using the specified name server list.
-
isTransportOrTimeoutError
public static boolean isTransportOrTimeoutError(java.lang.Throwable cause)
Returnstrue
if theThrowable
was caused by an timeout or transport error. These methods can be used on theFuture.cause()
that is returned by the various methods exposed by thisDnsNameResolver
.
-
isTimeoutError
public static boolean isTimeoutError(java.lang.Throwable cause)
Returnstrue
if theThrowable
was caused by an timeout. These methods can be used on theFuture.cause()
that is returned by the various methods exposed by thisDnsNameResolver
.
-
doQuery
final Future<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> doQuery(Channel channel, java.net.InetSocketAddress nameServerAddr, DnsQuestion question, DnsQueryLifecycleObserver queryLifecycleObserver, DnsRecord[] additionals, boolean flush, Promise<AddressedEnvelope<? extends DnsResponse,java.net.InetSocketAddress>> promise)
-
cast
private static Promise<AddressedEnvelope<DnsResponse,java.net.InetSocketAddress>> cast(Promise<?> promise)
-
newNameServerAddressStream
final DnsServerAddressStream newNameServerAddressStream(java.lang.String hostname)
-
registerOrBind
private static ChannelFuture registerOrBind(Bootstrap bootstrap, java.net.SocketAddress localAddress)
-
-