author | chegar |
Wed, 06 Jun 2018 13:57:19 +0100 | |
branch | http-client-branch |
changeset 56677 | f57700f449bd |
parent 56451 | 9585061fdb04 |
child 56729 | d32f57638b7b |
permissions | -rw-r--r-- |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
1 |
/* |
49765 | 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 | 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 | 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 | 33 |
* <li>{@link java.net.http.HttpClient}</li> |
34 |
* <li>{@link java.net.http.HttpRequest}</li> |
|
35 |
* <li>{@link java.net.http.HttpResponse}</li> |
|
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 | 39 |
* <p> The protocol-specific requirements are defined in the |
40 |
* <a href="https://tools.ietf.org/html/rfc7540">Hypertext Transfer Protocol |
|
41 |
* Version 2 (HTTP/2)</a>, the <a href="https://tools.ietf.org/html/rfc2616"> |
|
42 |
* Hypertext Transfer Protocol (HTTP/1.1)</a>, and |
|
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 |
* |
56677
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
45 |
* <p> In general, asynchronous tasks are executed either by the thread |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
46 |
* performing the send operation, or by the threads supplied by the client's |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
47 |
* {@link java.net.http.HttpClient#executor() executor}. Dependent tasks, those |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
48 |
* that are triggered by returned CompletionStages or CompletableFutures, that |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
49 |
* do not explicitly specify an executor, are executed in the same |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
50 |
* {@link java.util.concurrent.CompletableFuture#defaultExecutor() default |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
51 |
* executor} as that of CompletableFuture, or the invoking thread if the send |
f57700f449bd
http-client-branch: dependent tasks execute in the common pool
chegar
parents:
56451
diff
changeset
|
52 |
* operation completes before the dependent task is registered. |
49765 | 53 |
* |
54 |
* <p> {@code CompletableFuture}s returned by this API will throw {@link |
|
55 |
* java.lang.UnsupportedOperationException} for their {@link |
|
56 |
* java.util.concurrent.CompletableFuture#obtrudeValue(Object) obtrudeValue} |
|
57 |
* and {@link java.util.concurrent.CompletableFuture#obtrudeException(Throwable) |
|
58 |
* obtrudeException} methods. Invoking the {@link |
|
59 |
* java.util.concurrent.CompletableFuture#cancel cancel} method on a {@code |
|
60 |
* CompletableFuture} returned by this API will not interrupt the underlying |
|
61 |
* operation, but may be useful to complete, exceptionally, dependent stages |
|
62 |
* 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 | 67 |
* @since 11 |
42460
7133f144981a
8170648: Move java.net.http package out of Java SE to incubator namespace
michaelm
parents:
diff
changeset
|
68 |
*/ |
49765 | 69 |
package java.net.http; |