src/java.net.http/share/classes/java/net/http/package-info.java
author herrick
Wed, 17 Oct 2018 13:50:11 -0400
branchJDK-8200758-branch
changeset 56982 e094d5483bd6
parent 50681 4254bed3c09d
child 56795 03ece2518428
permissions -rw-r--r--
8212048: Cleanup source code and fix issues discussed in preliminary review Reviewed-by: almatvee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     1
/*
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
     2
 * Copyright (c) 2015, 2018, Oracle and/or its affiliates. All rights reserved.
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     4
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    10
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    15
 * accompanied this code).
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    16
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    20
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    23
 * questions.
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    24
 */
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    25
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    26
/**
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    27
 * <h2>HTTP Client and WebSocket APIs</h2>
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    28
 *
43302
45de1dc92ecd 8173354: javadoc warning notice for types in Incubator Modules
chegar
parents: 42460
diff changeset
    29
 * <p> Provides high-level client interfaces to HTTP (versions 1.1 and 2) and
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    30
 * low-level client interfaces to WebSocket. The main types defined are:
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    31
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    32
 * <ul>
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    33
 *    <li>{@link java.net.http.HttpClient}</li>
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    34
 *    <li>{@link java.net.http.HttpRequest}</li>
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    35
 *    <li>{@link java.net.http.HttpResponse}</li>
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    36
 *    <li>{@link java.net.http.WebSocket}</li>
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    37
 * </ul>
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    38
 *
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    39
 * <p> The protocol-specific requirements are defined in the
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    40
 * <a href="https://tools.ietf.org/html/rfc7540">Hypertext Transfer Protocol
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    41
 * Version 2 (HTTP/2)</a>, the <a href="https://tools.ietf.org/html/rfc2616">
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    42
 * Hypertext Transfer Protocol (HTTP/1.1)</a>, and
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    43
 * <a href="https://tools.ietf.org/html/rfc6455">The WebSocket Protocol</a>.
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    44
 *
50681
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    45
 * <p> In general, asynchronous tasks execute in either the thread invoking
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    46
 * the operation, e.g. {@linkplain HttpClient#send(HttpRequest, BodyHandler)
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    47
 * sending} an HTTP request, or by the threads supplied by the client's {@link
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    48
 * HttpClient#executor() executor}. Dependent tasks, those that are triggered by
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    49
 * returned CompletionStages or CompletableFutures, that do not explicitly
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    50
 * specify an executor, execute in the same {@link
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    51
 * CompletableFuture#defaultExecutor() default executor} as that of {@code
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    52
 * CompletableFuture}, or the invoking thread if the operation completes before
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    53
 * the dependent task is registered.
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    54
 *
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    55
 * <p> {@code CompletableFuture}s returned by this API will throw {@link
50681
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    56
 * UnsupportedOperationException} for their {@link
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    57
 * CompletableFuture#obtrudeValue(Object) obtrudeValue}
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    58
 * and {@link CompletableFuture#obtrudeException(Throwable)
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    59
 * obtrudeException} methods. Invoking the {@link CompletableFuture#cancel
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    60
 * cancel} method on a {@code CompletableFuture} returned by this API may not
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    61
 * interrupt the underlying operation, but may be useful to complete,
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    62
 * exceptionally, dependent stages that have not already completed.
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    63
 *
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    64
 * <p> Unless otherwise stated, {@code null} parameter values will cause methods
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    65
 * of all classes in this package to throw {@code NullPointerException}.
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    66
 *
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    67
 * @since 11
42460
7133f144981a 8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff changeset
    68
 */
49765
ee6f7a61f3a5 8197564: HTTP Client implementation
chegar
parents: 48083
diff changeset
    69
package java.net.http;
50681
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    70
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    71
import java.lang.UnsupportedOperationException;
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    72
import java.net.http.HttpClient;
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    73
import java.net.http.HttpRequest;
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    74
import java.net.http.HttpResponse.BodyHandler;
4254bed3c09d 8204679: HTTP Client refresh
chegar
parents: 49765
diff changeset
    75
import java.util.concurrent.CompletableFuture;