- java.lang.Object
-
- jdk.incubator.http.HttpClient
-
public abstract class HttpClient extends Object
複数のHttpRequest
sに共通する構成情報のためのコンテナ。 すべてのリクエストはHttpClient
を介して送信されます。
インキュベーション機能。将来のリリースで削除されます。HttpClient
は不変であり、newBuilder()
から返されたビルダーから作成されます。 リクエスト作成者は、HttpRequest.newBuilder()
を呼び出すことによって作成されます。このAPIの使用例については、
HttpRequest
を参照してください。- 導入されたバージョン:
- 9
-
-
ネストされたクラスのサマリー
ネストされたクラス 修飾子と型 クラス 説明 static class
HttpClient.Builder
不変のHttpClient
のビルダー。static class
HttpClient.Redirect
自動リダイレクト・ポリシーを定義します。static class
HttpClient.Version
HTTPプロトコルのバージョン。
-
コンストラクタのサマリー
コンストラクタ 修飾子 コンストラクタ 説明 protected
HttpClient()
HttpClientを作成します。
-
メソッドのサマリー
すべてのメソッド staticメソッド インスタンス・メソッド 抽象メソッド 具象メソッド 修飾子と型 メソッド 説明 abstract Optional<Authenticator>
authenticator()
このクライアントに設定されたAuthenticator
を含むOptional
を返します。abstract Optional<CookieHandler>
cookieHandler()
このクライアントCookieHandlerを含むOptional
を返します。abstract Optional<Executor>
executor()
このクライアントExecutorを含むOptional
を返します。abstract HttpClient.Redirect
followRedirects()
このクライアントのフォロー・リダイレクト・ポリシーを返します。static HttpClient.Builder
newBuilder()
新しいHttpClient
ビルダーを作成します。static HttpClient
newHttpClient()
デフォルトの設定で新しいHttpClientを返します。WebSocket.Builder
newWebSocketBuilder()
新しいWebSocket
ビルダー(オプションの操作)を作成します。abstract Optional<ProxySelector>
proxy()
このクライアントに提供されたProxySelector
を含むOptional
を返します。abstract <T> HttpResponse<T>
send(HttpRequest req, HttpResponse.BodyHandler<T> responseBodyHandler)
このクライアントを使用してリクエストを送信し、必要に応じてブロックしてレスポンスを取得します。abstract <T> CompletableFuture<HttpResponse<T>>
sendAsync(HttpRequest req, HttpResponse.BodyHandler<T> responseBodyHandler)
このクライアントと指定されたレスポンス・ハンドラを使用して、指定されたリクエストを非同期的に送信します。abstract <U,T> CompletableFuture<U>
sendAsync(HttpRequest req, HttpResponse.MultiSubscriber<U,T> multiSubscriber)
このクライアントと指定されたマルチ・レスポンス・ハンドラを使用して、指定されたリクエストを非同期に送信します。abstract SSLContext
sslContext()
このクライアントSSLContext
を返します。abstract SSLParameters
sslParameters()
このクライアントSSLParameters
のコピーを返します。abstract HttpClient.Version
version()
このクライアントにリクエストされたHTTPプロトコルのバージョンを返します。
-
-
-
メソッドの詳細
-
newHttpClient
public static HttpClient newHttpClient()
デフォルトの設定で新しいHttpClientを返します。newBuilder().build()
と等価です。デフォルト設定には: "GET"リクエスト・メソッド、HTTP/2のプリファレンス、NEVERのリダイレクション・ポリシー、「デフォルト・プロキシ・セレクタ」、および「デフォルトのSSLコンテキスト」があります。
- 実装上の注意:
- システム全体のデフォルト値は、
HttpClient
インスタンスの構築時に取得されます。 たとえばProxySelector.setDefault(ProxySelector)
またはSSLContext.setDefault(SSLContext)
を呼び出して、HttpClient
インスタンスが構築された後にシステム全体の値を変更しても、すでにビルドされたインスタンスには影響しません。 - 戻り値:
- 新しいHttpClient
-
newBuilder
public static HttpClient.Builder newBuilder()
新しいHttpClient
ビルダーを作成します。- 戻り値:
HttpClient.Builder
-
cookieHandler
public abstract Optional<CookieHandler> cookieHandler()
このクライアントCookieHandlerを含むOptional
を返します。 このクライアントビルダーにCookieHandler
が設定されていない場合、Optional
は空です。- 戻り値:
- このクライアントを含む
Optional
CookieHandler
-
followRedirects
public abstract HttpClient.Redirect followRedirects()
このクライアントのフォロー・リダイレクト・ポリシーを返します。 リダイレクト・ポリシーを指定しないBuilderによって構築されたクライアントのデフォルト値はNEVER
です。- 戻り値:
- このクライアントはリダイレクト設定に従います
-
proxy
public abstract Optional<ProxySelector> proxy()
このクライアントに提供されたProxySelector
を含むOptional
を返します。 このクライアントビルダーにプロキシ・セレクタが設定されていない場合、Optional
は空です。このメソッドは空のオプションを返すかもしれませんが、
HttpClient
には依然としてHTTPリクエストの送信に使用される「デフォルト・プロキシ・セレクタ」が公開されている場合があります。- 戻り値:
- このクライアントに提供されたプロキシ・セレクタを含む
Optional
。
-
sslContext
public abstract SSLContext sslContext()
このクライアントSSLContext
を返します。このクライアントビルダーに
SSLContext
が設定されていない場合は、「デフォルト・コンテキスト」が返されます。- 戻り値:
- このクライアントSSLContext
-
sslParameters
public abstract SSLParameters sslParameters()
このクライアントSSLParameters
のコピーを返します。SSLParameters
がクライアントビルダーに設定されていない場合、クライアントが使用する実装固有のデフォルトのパラメータ・セットが返されます。- 戻り値:
- このクライアント
SSLParameters
-
authenticator
public abstract Optional<Authenticator> authenticator()
このクライアントに設定されたAuthenticator
を含むOptional
を返します。Authenticator
がクライアント・ビルダーに設定されていない場合、Optional
は空です。- 戻り値:
- このクライアントを含む
Optional
Authenticator
-
version
public abstract HttpClient.Version version()
このクライアントにリクエストされたHTTPプロトコルのバージョンを返します。 デフォルト値はHttpClient.Version.HTTP_2
です。- 戻り値:
- リクエストされたHTTPプロトコルのバージョン
-
executor
public abstract Optional<Executor> executor()
このクライアントExecutorを含むOptional
を返します。Executor
がクライアント・ビルダーに設定されていない場合、Optional
は空です。このメソッドは空のオプションを返すかもしれませんが、
HttpClient
には、非同期および依存タスクの実行に使用される「デフォルトのエグゼキュータ」がまだ公開されていないことがあります。- 戻り値:
- このクライアントを含む
Optional
Executor
-
send
public abstract <T> HttpResponse<T> send(HttpRequest req, HttpResponse.BodyHandler<T> responseBodyHandler) throws IOException, InterruptedException
このクライアントを使用してリクエストを送信し、必要に応じてブロックしてレスポンスを取得します。 返されたHttpResponse
<T>
には、レスポンス・ステータス、ヘッダー、および本文(指定されたレスポンス本文ハンドラによって処理される)が含まれています。- 型パラメータ:
T
- レスポンス本文型- パラメータ:
req
- リクエストresponseBodyHandler
- レスポンス本文ハンドラ- 戻り値:
- レスポンス本文
- 例外:
IOException
- 送信または受信時にI/Oエラーが発生した場合InterruptedException
- 操作が中断された場合IllegalArgumentException
- リクエスト・メソッドがサポートされていない場合SecurityException
- セキュリティ・マネージャがインストールされていて、指定されたリクエストのURLにaccess
を拒否した場合、またはプロキシが構成されている場合はプロキシを拒否します。 「セキュリティ・チェック」の詳細については、HttpRequestを参照してください。
-
sendAsync
public abstract <T> CompletableFuture<HttpResponse<T>> sendAsync(HttpRequest req, HttpResponse.BodyHandler<T> responseBodyHandler)
このクライアントと指定されたレスポンス・ハンドラを使用して、指定されたリクエストを非同期的に送信します。返された完了可能な未来は例外的に次のように完了します:
IOException
- 送信時または受信時にI/Oエラーが発生した場合IllegalArgumentException
- リクエスト・メソッドがサポートされていない場合SecurityException
- セキュリティ・マネージャがインストールされていて、指定されたリクエストのURLにaccess
を拒否した場合、またはプロキシが構成されている場合はプロキシを拒否します。 「セキュリティ・チェック」の詳細については、HttpRequestを参照してください。
- 型パラメータ:
T
- レスポンス本文型- パラメータ:
req
- リクエストresponseBodyHandler
- レスポンス本文ハンドラ- 戻り値:
CompletableFuture<HttpResponse<T>>
-
sendAsync
public abstract <U,T> CompletableFuture<U> sendAsync(HttpRequest req, HttpResponse.MultiSubscriber<U,T> multiSubscriber)
このクライアントと指定されたマルチ・レスポンス・ハンドラを使用して、指定されたリクエストを非同期に送信します。返された完了可能な未来は例外的に次のように完了します:
IOException
- 送信時または受信時にI/Oエラーが発生した場合IllegalArgumentException
- リクエスト・メソッドがサポートされていない場合SecurityException
- セキュリティ・マネージャがインストールされていて、指定されたリクエストのURLにaccess
を拒否した場合、またはプロキシが構成されている場合はプロキシを拒否します。 「セキュリティ・チェック」の詳細については、HttpRequestを参照してください。
- 型パラメータ:
U
- 集計結果を表す型T
- すべてのレスポンス体を表す型- パラメータ:
req
- リクエストmultiSubscriber
- リクエストのmultiSubscriber- 戻り値:
CompletableFuture<U>
-
newWebSocketBuilder
public WebSocket.Builder newWebSocketBuilder()
新しいWebSocket
ビルダー(オプションの操作)を作成します。例
HttpClient client = HttpClient.newHttpClient(); CompletableFuture<WebSocket> ws = client.newWebSocketBuilder() .buildAsync(URI.create("ws://websocket.example.com"), listener);
カスタムの
HttpClient
を使用すると、WebSocketオープニング・ハンドシェイクの細かい制御が可能になります。例
InetSocketAddress addr = new InetSocketAddress("proxy.example.com", 80); HttpClient client = HttpClient.newBuilder() .proxy(ProxySelector.of(addr)) .build(); CompletableFuture<WebSocket> ws = client.newWebSocketBuilder() .buildAsync(URI.create("ws://websocket.example.com"), listener);
このメソッドから返された
WebSocket.Builder
は、外部同期なしで複数のスレッドで使用することは安全ではありません。- 実装要件:
- このメソッドのデフォルト実装は
UnsupportedOperationException
をスローします。newHttpClient()
またはnewBuilder()
で取得したクライアントは、WebSocket
Builderを返します。 - 実装上の注意:
- ビルダーとそれで作成された
WebSocket
の両方が、非ブロッキングの方法で動作します。 つまり、それらのメソッドはCompletableFuture
を返す前にブロックしません。 非同期タスクは、このHttpClient
エグゼキュータで実行されます。CompletionStage
がListener.onClose
から返されると、WebSocket
は、受信したメッセージと同じコードを持ち、空の理由があるCloseメッセージを送信します。 - 戻り値:
- a
WebSocket.Builder
- 例外:
UnsupportedOperationException
- このHttpClient
がWebSocketサポートを提供しない場合
-
-