src/jdk.naming.dns/share/classes/module-info.java
author egahlin
Fri, 18 Oct 2019 17:45:17 +0200
branchJEP-349-branch
changeset 58687 222f727e9b05
parent 58308 b7192797f434
permissions -rw-r--r--
Stabilize TestLatestEvent.java
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     1
/*
58308
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
     2
 * Copyright (c) 2014, 2019, Oracle and/or its affiliates. All rights reserved.
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     4
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    10
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    15
 * accompanied this code).
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    16
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    20
 *
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    23
 * questions.
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    24
 */
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    25
44417
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 42338
diff changeset
    26
/**
45528
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 44417
diff changeset
    27
 * Provides the implementation of the DNS Java Naming provider.
44417
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 42338
diff changeset
    28
 *
58308
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    29
 * <h2>Environment Properties</h2>
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    30
 *
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    31
 * <p> The following JNDI environment properties may be used when creating
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    32
 * the initial context.
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    33
 *
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    34
 * <ul>
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    35
 *    <li>com.sun.jndi.dns.timeout.initial</li>
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    36
 *    <li>com.sun.jndi.dns.timeout.retries</li>
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    37
 *  </ul>
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    38
 *
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    39
 * <p> These properties are used to alter the timeout-related defaults that the
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    40
 * DNS provider uses when submitting queries. The DNS provider submits queries
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    41
 * using the following exponential backoff algorithm. The provider submits a
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    42
 * query to a DNS server and waits for a response to arrive within a timeout
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    43
 * period (1 second by default). If it receives no response within the timeout
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    44
 * period, it queries the next server, and so on. If the provider receives no
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    45
 * response from any server, it doubles the timeout period and repeats the
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    46
 * process of submitting the query to each server, up to a maximum number of
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    47
 * retries (4 by default).
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    48
 *
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    49
 * <p> The {@code com.sun.jndi.dns.timeout.initial} property, if set, specifies
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    50
 * the number of milliseconds to use as the initial timeout period (i.e., before
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    51
 * any doubling). If this property has not been set, the default initial timeout
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    52
 * is 1000 milliseconds.
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    53
 *
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    54
 * <p> The {@code com.sun.jndi.dns.timeout.retries} property, if set, specifies
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    55
 * the number of times to retry each server using the exponential backoff
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    56
 * algorithm described previously. If this property has not been set, the
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    57
 * default number of retries is 4.
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    58
 *
45528
1e8c2f062ad3 8181639: Add tool and services information to module summary
mchung
parents: 44417
diff changeset
    59
 * @provides javax.naming.spi.InitialContextFactory
58308
b7192797f434 8228580: DnsClient TCP socket timeout
prappo
parents: 47216
diff changeset
    60
 *
44417
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 42338
diff changeset
    61
 * @moduleGraph
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 42338
diff changeset
    62
 * @since 9
a431edba1629 8173303: Add module-subgraph images to main platform documentation
mchung
parents: 42338
diff changeset
    63
 */
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    64
module jdk.naming.dns {
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    65
    requires java.naming;
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    66
42338
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 36967
diff changeset
    67
    // temporary export until NamingManager.getURLContext uses services
a60f280f803c 8169069: Module system implementation refresh (11/2016)
alanb
parents: 36967
diff changeset
    68
    exports com.sun.jndi.url.dns to java.naming;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    69
45654
5ff2edfa03fc 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45528
diff changeset
    70
    provides javax.naming.spi.InitialContextFactory with
5ff2edfa03fc 8182416: Clean up module-info.java like move requires transitive adjacent to exports
mchung
parents: 45528
diff changeset
    71
        com.sun.jndi.dns.DnsContextFactory;
36511
9d0388c6b336 8142968: Module System implementation
alanb
parents:
diff changeset
    72
}