Package io.quarkus.vertx.core.runtime.config

Interface AddressResolverConfiguration

public interface AddressResolverConfiguration

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    cacheMaxTimeToLive()
    The maximum amount of time in seconds that a successfully resolved address will be cached.
    int
    cacheMinTimeToLive()
    The minimum amount of time in seconds that a successfully resolved address will be cached.
    int
    cacheNegativeTimeToLive()
    The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached.
    int
    hostRefreshPeriod()
    Set the hosts configuration refresh period in millis, 0 (default) disables it.
    Optional<String>
    hostsPath()
    Set the path of an alternate hosts configuration file to use instead of the one provided by the os.
    int
    maxQueries()
    The maximum number of queries to be sent during a resolution.
    int
    ndots()
    Set the ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.
    boolean
    optResourceEnabled()
    Set to true to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.
    Duration
    queryTimeout()
    The duration after which a DNS query is considered to be failed.
    boolean
    rdFlag()
    Set the DNS queries Recursion Desired flag value.
    Optional<Boolean>
    rotateServers()
    Set to true to enable round-robin selection of the dns server to use.
    boolean
    roundRobinInetAddress()
    Set to true to enable round-robin inet address selection of the ip address to use.
    Optional<List<String>>
    searchDomains()
    Set the lists of DNS search domains.
    Optional<List<String>>
    servers()
    Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port, e.g 8.8.8.8 or 192.168.0.1:40000.

  • Method Details

    • cacheMaxTimeToLive

      @WithDefault("2147483647") int cacheMaxTimeToLive()
      The maximum amount of time in seconds that a successfully resolved address will be cached.

      If not set explicitly, resolved addresses may be cached forever.

    • cacheMinTimeToLive

      @WithDefault("0") int cacheMinTimeToLive()
      The minimum amount of time in seconds that a successfully resolved address will be cached.

    • cacheNegativeTimeToLive

      @WithDefault("0") int cacheNegativeTimeToLive()
      The amount of time in seconds that an unsuccessful attempt to resolve an address will be cached.

    • maxQueries

      @WithDefault("4") int maxQueries()
      The maximum number of queries to be sent during a resolution.

    • queryTimeout

      @WithDefault("5S") Duration queryTimeout()
      The duration after which a DNS query is considered to be failed.

    • hostsPath

      Optional<String> hostsPath()
      Set the path of an alternate hosts configuration file to use instead of the one provided by the os.

      The default value is `null`, so the operating system hosts config (e.g. `/etc/hosts`) is used.

    • hostRefreshPeriod

      @WithDefault("0") int hostRefreshPeriod()
      Set the hosts configuration refresh period in millis, 0 (default) disables it.

      The resolver caches the hosts configuration (configured using `quarkus.vertx.resolver.hosts-path` after it has read it. When the content of this file can change, setting a positive refresh period will load the configuration file again when necessary.

    • servers

      Optional<List<String>> servers()
      Set the list of DNS server addresses, an address is the IP of the dns server, followed by an optional colon and a port, e.g 8.8.8.8 or 192.168.0.1:40000. When the list is empty, the resolver will use the list of the system DNS server addresses from the environment, if that list cannot be retrieved it will use Google's public DNS servers "8.8.8.8" and "8.8.4.4".

    • optResourceEnabled

      @WithDefault("false") boolean optResourceEnabled()
      Set to true to enable the automatic inclusion in DNS queries of an optional record that hints the remote DNS server about how much data the resolver can read per response.

    • rdFlag

      @WithDefault("true") boolean rdFlag()
      Set the DNS queries Recursion Desired flag value.

    • searchDomains

      Optional<List<String>> searchDomains()
      Set the lists of DNS search domains.

      When the search domain list is null, the effective search domain list will be populated using the system DNS search domains.

    • ndots

      @WithDefault("-1") int ndots()
      Set the ndots value used when resolving using search domains, the default value is -1 which determines the value from the OS on Linux or uses the value 1.

    • rotateServers

      Optional<Boolean> rotateServers()
      Set to true to enable round-robin selection of the dns server to use. It spreads the query load among the servers and avoids all lookup to hit the first server of the list.

    • roundRobinInetAddress

      @WithDefault("false") boolean roundRobinInetAddress()
      Set to true to enable round-robin inet address selection of the ip address to use.