mirror of
https://github.com/openjdk/jdk.git
synced 2026-02-15 12:55:07 +00:00
e8db14f584
Co-authored-by: Aleksei Efimov <aefimov@openjdk.org> Co-authored-by: Bradford Wetmore <wetmore@openjdk.org> Co-authored-by: Daniel Jeliński <djelinski@openjdk.org> Co-authored-by: Darragh Clarke <dclarke@openjdk.org> Co-authored-by: Jaikiran Pai <jpai@openjdk.org> Co-authored-by: Michael McMahon <michaelm@openjdk.org> Co-authored-by: Volkan Yazici <vyazici@openjdk.org> Co-authored-by: Conor Cleary <conor.cleary@oracle.com> Co-authored-by: Patrick Concannon <patrick.concannon@oracle.com> Co-authored-by: Rahul Yadav <rahul.r.yadav@oracle.com> Co-authored-by: Daniel Fuchs <dfuchs@openjdk.org> Reviewed-by: djelinski, jpai, aefimov, abarashev, michaelm
89 lines
4.0 KiB
Java
89 lines
4.0 KiB
Java
/*
|
|
* Copyright (c) 2015, 2025, 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.
|
|
*/
|
|
|
|
/**
|
|
* <h2>HTTP Client and WebSocket APIs</h2>
|
|
*
|
|
* <p> Provides high-level client interfaces to HTTP (versions 1.1, 2, and 3) and
|
|
* low-level client interfaces to WebSocket. The main types defined are:
|
|
*
|
|
* <ul>
|
|
* <li>{@link java.net.http.HttpClient}</li>
|
|
* <li>{@link java.net.http.HttpRequest}</li>
|
|
* <li>{@link java.net.http.HttpResponse}</li>
|
|
* <li>{@link java.net.http.WebSocket}</li>
|
|
* </ul>
|
|
*
|
|
* <p> The protocol-specific requirements are defined in the
|
|
* <a href="https://www.rfc-editor.org/info/rfc9114">Hypertext Transfer Protocol
|
|
* Version 3 (HTTP/3)</a>, the <a href="https://www.rfc-editor.org/info/rfc7540">
|
|
* Hypertext Transfer Protocol Version 2 (HTTP/2)</a>, the
|
|
* <a href="https://www.rfc-editor.org/info/rfc2616">
|
|
* Hypertext Transfer Protocol (HTTP/1.1)</a>, and
|
|
* <a href="https://www.rfc-editor.org/info/rfc6455">The WebSocket Protocol</a>.
|
|
*
|
|
* <p> In general, asynchronous tasks execute in either the thread invoking
|
|
* the operation, e.g. {@linkplain HttpClient#send(HttpRequest, BodyHandler)
|
|
* sending} an HTTP request, or by the threads supplied by the client's {@link
|
|
* HttpClient#executor() executor}. Dependent tasks, those that are triggered by
|
|
* returned CompletionStages or CompletableFutures, that do not explicitly
|
|
* specify an executor, execute in the same {@link
|
|
* CompletableFuture#defaultExecutor() default executor} as that of {@code
|
|
* CompletableFuture}, or the invoking thread if the operation completes before
|
|
* the dependent task is registered.
|
|
*
|
|
* <p> {@code CompletableFuture}s returned by this API will throw {@link
|
|
* UnsupportedOperationException} for their {@link
|
|
* CompletableFuture#obtrudeValue(Object) obtrudeValue}
|
|
* and {@link CompletableFuture#obtrudeException(Throwable)
|
|
* obtrudeException} methods. Unless {@linkplain
|
|
* HttpClient##cancel otherwise specified}, invoking
|
|
* the {@link CompletableFuture#cancel cancel} method on a
|
|
* {@code CompletableFuture} returned by this API may not
|
|
* interrupt the underlying operation, but may be useful to complete,
|
|
* exceptionally, dependent stages that have not already completed.
|
|
*
|
|
* <p> Unless otherwise stated, {@code null} parameter values will cause methods
|
|
* of all classes in this package to throw {@code NullPointerException}.
|
|
*
|
|
* @spec https://www.rfc-editor.org/info/rfc9114
|
|
* RFC 9114: HTTP/3
|
|
* @spec https://www.rfc-editor.org/info/rfc7540
|
|
* RFC 7540: Hypertext Transfer Protocol Version 2 (HTTP/2)
|
|
* @spec https://www.rfc-editor.org/info/rfc2616
|
|
* RFC 2616: Hypertext Transfer Protocol -- HTTP/1.1
|
|
* @spec https://www.rfc-editor.org/info/rfc6455
|
|
* RFC 6455: The WebSocket Protocol
|
|
*
|
|
* @since 11
|
|
*/
|
|
package java.net.http;
|
|
|
|
import java.lang.UnsupportedOperationException;
|
|
import java.net.http.HttpClient;
|
|
import java.net.http.HttpRequest;
|
|
import java.net.http.HttpResponse.BodyHandler;
|
|
import java.util.concurrent.CompletableFuture;
|