java.net.http.HttpRequest

public abstract class HttpRequest extends Object

HTTPリクエスト。

HttpRequestインスタンスは、HttpRequest builderを介して構築されます。 HttpRequestビルダーは、newBuilderメソッドのいずれかから取得されます。リクエストURI、ヘッダーおよび本文を設定できます。リクエスト本体は、POST、PUTまたはmethodメソッドの1つに提供されているBodyPublisherを介して提供されます。必要なパラメータがすべてビルダーに設定されると、buildはHttpRequestを返します。一部のパラメータが異なる複数の関連リクエストを作成するために、ビルダーを何度でもコピーおよび変更できます。

レスポンス本文を文字列として出力するGETリクエストの例を次に示します。

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("http://foo.com/"))
      .build();

client.sendAsync(request, BodyHandlers.ofString())
      .thenApply(HttpResponse::body)
      .thenAccept(System.out::println)
      .join();

クラスBodyPublishersは、多くの共通パブリッシャの実装を提供します。または、カスタムBodyPublisherの実装を使用できます。

導入されたバージョン:: 11

ネストされたクラスのサマリー

ネストされたクラス

修飾子と型

クラス

説明

static interface

HttpRequest.BodyPublisher

BodyPublisherは、上位レベルのJavaオブジェクトをリクエスト本文として送信するのに適したバイト・バッファのフローに変換します。

static class

HttpRequest.BodyPublishers

Stringからのリクエスト本文の公開やファイルからの公開など、各種の便利なパブリッシャを実装するBodyPublisherの実装。

static interface

HttpRequest.Builder

「HTTPリクエスト」のビルダー。
コンストラクタのサマリー

コンストラクタ

修飾子

コンストラクタ

説明

protected

HttpRequest()

HttpRequestを作成します。
メソッドのサマリー

修飾子と型

メソッド

説明

abstract Optional<HttpRequest.BodyPublisher>

bodyPublisher()

このリクエストで設定されたHttpRequest.BodyPublisherを含むOptionalを返します。

final boolean

equals(Object obj)

このHTTPリクエスト・インスタンスが指定されたオブジェクトと等しいかどうかをテストします。

abstract boolean

expectContinue()

このリクエスト「続行の予定」設定を返します。

final int

hashCode()

このHTTPリクエスト・インスタンスのハッシュ・コードを計算します。

abstract HttpHeaders

headers()

このリクエストが送信された(または)である(user-accessible)リクエスト・ヘッダー。

abstract String

method()

このリクエストのリクエスト・メソッドを返します。

static HttpRequest.Builder

newBuilder()

HttpRequestビルダーを作成します。

static HttpRequest.Builder

newBuilder(HttpRequest request, BiPredicate<String,String> filter)

既存のHttpRequestから初期状態がコピーされるBuilderを作成します。

static HttpRequest.Builder

newBuilder(URI uri)

指定されたURIのHttpRequestビルダーを作成します。

abstract Optional<Duration>

timeout()

このリクエストのタイムアウト期間を含むOptionalを返します。

abstract URI

uri()

このリクエストURIを返します。

abstract Optional<HttpClient.Version>

version()

このHttpRequestにリクエストされるHTTPプロトコル・バージョンを含むOptionalを返します。

クラスjava.lang.Objectで宣言されたメソッド
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細
- HttpRequest
  
  protected HttpRequest()
  
  HttpRequestを作成します。
メソッドの詳細
- newBuilder
  
  public static HttpRequest.Builder newBuilder(URI uri)
  
  指定されたURIのHttpRequestビルダーを作成します。
  
  パラメータ:
  
  uri - リクエストURI
  
  戻り値:
  
  新しいリクエスト・ビルダー
  
  例外:
  
  IllegalArgumentException - URIスキームがサポートされていない場合。
- newBuilder
  public static HttpRequest.Builder newBuilder(HttpRequest request, BiPredicate<String,String> filter)
  
  既存のHttpRequestから初期状態がコピーされるBuilderを作成します。
  このビルダーを使用すると、元のビルダーと同等のHttpRequestを構築しながら、構築前のリクエスト状態を修正できます - たとえば、ヘッダーを追加します。
  filterは、特定のリクエストからコピーされるときに、各ヘッダー名と値のペアに適用されます。完了すると、filterによってレイアウトされた条件を満たすヘッダーのみが、このメソッドから返されるBuilderに存在します。
  
  APIのノート:
  
  次のシナリオは、フィルタの一般的なユースケースを示しています。 HttpRequest requestを確認してください:
  
  すべてのヘッダーを保持:
  
  HttpRequest.newBuilder(request, (n, v) -> true)
  
  すべてのヘッダーを削除:
  
  HttpRequest.newBuilder(request, (n, v) -> false)
  
  特定のヘッダー(たとえば、Foo-Bar)を削除します:
  
  HttpRequest.newBuilder(request, (name, value) -> !name.equalsIgnoreCase("Foo-Bar"))
  
  パラメータ:
  
  request - 元のリクエスト
  
  filter - ヘッダー・フィルタ
  
  戻り値:
  
  新しいリクエスト・ビルダー
  
  例外:
  
  IllegalArgumentException - 指定されたリクエスト(たとえば、リクエストに無効なパラメータが含まれている場合)から新しいビルダーをシードできない場合
  
  導入されたバージョン:
  
  16
- newBuilder
  
  public static HttpRequest.Builder newBuilder()
  
  HttpRequestビルダーを作成します。
  
  戻り値:
  
  新しいリクエスト・ビルダー
- bodyPublisher
  
  public abstract Optional<HttpRequest.BodyPublisher> bodyPublisher()
  
  このリクエストで設定されたHttpRequest.BodyPublisherを含むOptionalを返します。リクエストのビルダーでBodyPublisherが設定されていない場合、Optionalは空です。
  
  戻り値:
  
  このリクエストのBodyPublisherを含むOptional
- method
  
  public abstract String method()
  
  このリクエストのリクエスト・メソッドを返します。明示的に設定しない場合、リクエストのデフォルト・メソッドは"GET"です。
  
  戻り値:
  
  このリクエストのメソッド
- timeout
  
  public abstract Optional<Duration> timeout()
  
  このリクエストのタイムアウト期間を含むOptionalを返します。リクエストのビルダーでタイムアウト期間が設定されなかった場合、Optionalは空になります。
  
  戻り値:
  
  このリクエストのタイムアウト期間を含むOptional
- expectContinue
  
  public abstract boolean expectContinue()
  
  このリクエスト「続行の予定」設定を返します。
  
  戻り値:
  
  このリクエストの予想継続設定
- uri
  
  public abstract URI uri()
  
  このリクエストURIを返します。
  
  戻り値:
  
  このリクエストのURI
- version
  
  public abstract Optional<HttpClient.Version> version()
  
  このHttpRequestにリクエストされるHTTPプロトコル・バージョンを含むOptionalを返します。リクエストのビルダーでバージョンが設定されていない場合、Optionalは空です。その場合、リクエストされたバージョンは、送信側HttpClientのバージョンになります。対応するHttpResponseを問い合せて、実際に使用されたバージョンを特定する必要があります。
  
  戻り値:
  
  HTTPプロトコル・バージョン
- headers
  
  public abstract HttpHeaders headers()
  
  このリクエストが送信された(または)である(user-accessible)リクエスト・ヘッダー。
  
  戻り値:
  
  このリクエストのHttpHeaders
- equals
  public final boolean equals(Object obj)
  
  このHTTPリクエスト・インスタンスが指定されたオブジェクトと等しいかどうかをテストします。
  指定されたオブジェクトがHttpRequestでない場合、このメソッドはfalseを返します。 URI、メソッド、およびヘッダー・フィールドがすべて等しい場合、2つのHTTPリクエストは等しいです。
  このメソッドはObject.equalsメソッドの汎用規約を満たします。
  
  オーバーライド:
  
  equals、クラスObject
  
  パラメータ:
  
  obj - このオブジェクトが比較されるオブジェクト
  
  戻り値:
  
  指定されたオブジェクトがこのHTTPリクエストと等しい HttpRequestである場合にのみtrue
  
  関連項目:
  
  Object.hashCode()
  
  HashMap
- hashCode
  public final int hashCode()
  
  このHTTPリクエスト・インスタンスのハッシュ・コードを計算します。
  ハッシュ・コードは、HTTPリクエストのURI、メソッドおよびヘッダー・コンポーネントに基づいており、Object.hashCodeメソッドの一般規約を満たしています。
  
  オーバーライド:
  
  hashCode、クラスObject
  
  戻り値:
  
  このHTTPリクエストのハッシュ・コード値
  
  関連項目:
  
  Object.equals(java.lang.Object)
  
  System.identityHashCode(java.lang.Object)

クラスHttpRequest

ネストされたクラスのサマリー

コンストラクタのサマリー

メソッドのサマリー

クラスjava.lang.Objectで宣言されたメソッド

コンストラクタの詳細

HttpRequest

メソッドの詳細

newBuilder

newBuilder

newBuilder

bodyPublisher

method

timeout

expectContinue

uri

version

headers

equals

hashCode