org.xbill.DNS.ResolverConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of org.apache.servicemix.bundles.dnsjava
This OSGi bundle wraps ${pkgArtifactId} ${pkgVersion} jar file.
There is a newer version: 3.6.2_1
// SPDX-License-Identifier: BSD-3-Clause
// Copyright (c) 1999-2004 Brian Wellington ([email protected])

package org.xbill.DNS;

import java.net.InetAddress;
import java.net.InetSocketAddress;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import lombok.extern.slf4j.Slf4j;
import org.xbill.DNS.config.AndroidResolverConfigProvider;
import org.xbill.DNS.config.FallbackPropertyResolverConfigProvider;
import org.xbill.DNS.config.InitializationException;
import org.xbill.DNS.config.JndiContextResolverConfigProvider;
import org.xbill.DNS.config.PropertyResolverConfigProvider;
import org.xbill.DNS.config.ResolvConfResolverConfigProvider;
import org.xbill.DNS.config.ResolverConfigProvider;
import org.xbill.DNS.config.SunJvmResolverConfigProvider;
import org.xbill.DNS.config.WindowsResolverConfigProvider;

/**
 * Locates name servers and the search path to be appended to unqualified names.
 *
 * The following are attempted, in order, until one succeeds.
 *
 * 

 *   dnsjava properties, see {@link org.xbill.DNS.config.PropertyResolverConfigProvider}
 *   
On Unix, /etc/resolv.conf is parsed, see {@link
 *       org.xbill.DNS.config.ResolvConfResolverConfigProvider}
 *   
On Windows, GetAdaptersAddresses is called, see {@link
 *       org.xbill.DNS.config.WindowsResolverConfigProvider}
 *   
On Android, system properties or the ConnectivityManager are read, see {@link
 *       org.xbill.DNS.config.AndroidResolverConfigProvider}
 *   
The JNDI DNS Service Provider is queried, see {@link
 *       org.xbill.DNS.config.JndiContextResolverConfigProvider}
 *   
The sun.net.dns.ResolverConfiguration class is queried, see {@link
 *       org.xbill.DNS.config.SunJvmResolverConfigProvider}
 *   
{@code localhost} is used as the nameserver, and the search path is empty.
 * 
 *
 * These routines will be called internally when creating Resolvers/Lookups without explicitly
 * specifying server names, and can also be called directly if desired.
 */
@Slf4j
public final class ResolverConfig {
  /** @since 3.2 */
  public static final String CONFIGPROVIDER_SKIP_INIT = "dnsjava.configprovider.skipinit";

  private final List servers = new ArrayList<>(2);
  private final List searchlist = new ArrayList<>(0);
  private int ndots = 1;

  private static ResolverConfig currentConfig;
  private static List configProviders;

  private static void checkInitialized() {
    if (currentConfig == null || configProviders == null) {
      refresh();
    }
  }

  /** Gets the current configuration */
  public static synchronized ResolverConfig getCurrentConfig() {
    checkInitialized();
    return currentConfig;
  }

  /**
   * Gets the ordered list of resolver config providers.
   *
   * @since 3.2
   */
  public static synchronized List getConfigProviders() {
    checkInitialized();
    return Collections.unmodifiableList(configProviders);
  }

  /** Set a new ordered list of resolver config providers. */
  public static synchronized void setConfigProviders(List providers) {
    configProviders = new ArrayList<>(providers);
  }

  /** Gets the current configuration */
  public static void refresh() {
    ResolverConfig newConfig = new ResolverConfig();
    synchronized (ResolverConfig.class) {
      currentConfig = newConfig;
    }
  }

  public ResolverConfig() {
    synchronized (ResolverConfig.class) {
      if (configProviders == null) {
        configProviders = new ArrayList<>(8);
        if (!Boolean.getBoolean(CONFIGPROVIDER_SKIP_INIT)) {
          configProviders.add(new PropertyResolverConfigProvider());
          configProviders.add(new ResolvConfResolverConfigProvider());
          configProviders.add(new WindowsResolverConfigProvider());
          configProviders.add(new AndroidResolverConfigProvider());
          configProviders.add(new JndiContextResolverConfigProvider());
          configProviders.add(new SunJvmResolverConfigProvider());
          configProviders.add(new FallbackPropertyResolverConfigProvider());
        }
      }
    }

    for (ResolverConfigProvider provider : configProviders) {
      if (provider.isEnabled()) {
        try {
          provider.initialize();
          if (servers.isEmpty()) {
            servers.addAll(provider.servers());
          }

          if (searchlist.isEmpty()) {
            List lsearchPaths = provider.searchPaths();
            if (!lsearchPaths.isEmpty()) {
              searchlist.addAll(lsearchPaths);
              ndots = provider.ndots();
            }
          }

          if (!servers.isEmpty() && !searchlist.isEmpty()) {
            // found both servers and search path, we're done
            return;
          }
        } catch (InitializationException e) {
          log.warn("Failed to initialize provider", e);
        }
      }
    }

    if (servers.isEmpty()) {
      servers.add(
          new InetSocketAddress(InetAddress.getLoopbackAddress(), SimpleResolver.DEFAULT_PORT));
    }
  }

  /** Returns all located servers */
  public List servers() {
    return servers;
  }

  /** Returns the first located server */
  public InetSocketAddress server() {
    return servers.get(0);
  }

  /** Returns all entries in the located search path */
  public List searchPath() {
    return searchlist;
  }

  /**
   * Gets the threshold for the number of dots which must appear in a name before it is considered
   * absolute. The default is {@code 1}, meaning meaning that if there are any dots in a name, the
   * name will be tried first as an absolute name.
   *
   * Note that ndots can only be configured in a resolv.conf file or the property {@link
   * PropertyResolverConfigProvider#DNS_NDOTS_PROP}.
   */
  public int ndots() {
    return ndots;
  }
}