1 /*
   2  * Copyright (c) 2015, 2017, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 /**
  27  * <h2>High level HTTP and WebSocket API</h2>
  28  * {@Incubating}
  29  *
  30  * <p> Provides high-level client interfaces to HTTP (versions 1.1 and 2) and
  31  * WebSocket. The main types defined are:
  32  *
  33  * <ul>
  34  *    <li>{@link jdk.incubator.http.HttpClient}</li>
  35  *    <li>{@link jdk.incubator.http.HttpRequest}</li>
  36  *    <li>{@link jdk.incubator.http.HttpResponse}</li>
  37  *    <li>{@link jdk.incubator.http.WebSocket}</li>
  38  * </ul>
  39  *
  40  * <p> The API functions asynchronously (using {@link java.util.concurrent.CompletableFuture})
  41  * and work is done on the threads supplied by the client's {@link java.util.concurrent.Executor}
  42  * where practical.
  43  *
  44  * <p> {@code HttpClient} also provides a simple synchronous mode, where all
  45  * work may be done on the calling thread.
  46  *
  47  * <p> {@code CompletableFuture}s returned by this API will throw {@link java.lang.UnsupportedOperationException}
  48  * for their {@link java.util.concurrent.CompletableFuture#obtrudeValue(Object) obtrudeValue}
  49  * and {@link java.util.concurrent.CompletableFuture#obtrudeException(Throwable) obtrudeException}
  50  * methods. Invoking the {@link java.util.concurrent.CompletableFuture#cancel cancel}
  51  * method on a {@code CompletableFuture} returned by this API will not interrupt
  52  * the underlying operation, but may be useful to complete, exceptionally,
  53  * dependent stages that have not already completed.
  54  *
  55  * <p> Unless otherwise stated, {@code null} parameter values will cause methods
  56  * of all classes in this package to throw {@code NullPointerException}.
  57  *
  58  * @since 9
  59  */
  60 package jdk.incubator.http;