src/jdk.naming.dns/share/classes/module-info.java

/*
 * Copyright (c) 2014, 2019, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

/**
 * Provides the implementation of the DNS Java Naming provider.
 *
 * <h2>Environment Properties</h2>
 *
 * <p> The following JNDI environment properties may be used when creating
 * the initial context.
 *
 * <ul>
 *    <li>com.sun.jndi.dns.timeout.initial</li>
 *    <li>com.sun.jndi.dns.timeout.retries</li>
 *  </ul>
 *
 * <p> These properties are used to alter the timeout-related defaults that the
 * DNS provider uses when submitting queries. The DNS provider submits queries
 * using the following exponential backoff algorithm. The provider submits a
 * query to a DNS server and waits for a response to arrive within a timeout
 * period (1 second by default). If it receives no response within the timeout
 * period, it queries the next server, and so on. If the provider receives no
 * response from any server, it doubles the timeout period and repeats the
 * process of submitting the query to each server, up to a maximum number of
 * retries (4 by default).
 *
 * <p> The {@code com.sun.jndi.dns.timeout.initial} property, if set, specifies
 * the number of milliseconds to use as the initial timeout period (i.e., before
 * any doubling). If this property has not been set, the default initial timeout
 * is 1000 milliseconds.
 *
 * <p> The {@code com.sun.jndi.dns.timeout.retries} property, if set, specifies
 * the number of times to retry each server using the exponential backoff
 * algorithm described previously. If this property has not been set, the
 * default number of retries is 4.
 *
 * @provides javax.naming.spi.InitialContextFactory
 *
 * @moduleGraph
 * @since 9
 */
module jdk.naming.dns {
    requires java.naming;

    // temporary export until NamingManager.getURLContext uses services
    exports com.sun.jndi.url.dns to java.naming;

    provides javax.naming.spi.InitialContextFactory with
        com.sun.jndi.dns.DnsContextFactory;
}