-
- 型パラメータ:
T
- レスポンス本文型
- すべてのスーパー・インタフェース:
Flow.Subscriber<ByteBuffer>
- 含まれているクラス:
- HttpResponse < T>
public static interface HttpResponse.BodyProcessor<T> extends Flow.Subscriber<ByteBuffer>
レスポンス・ボディ用のプロセッサ。
インキュベーション機能。将来のリリースで削除されます。このオブジェクトは、レスポンス本文を含むByteBuffersを公開するHTTPクライアント実装への
Flow.Subscriber
<ByteBuffer
>として機能します。 プロセッサは、入ってくるデータのバッファをユーザー定義のオブジェクト型T
に変換します。getBody()
メソッドは、レスポンス本文オブジェクトを提供するCompletionStage
<T>
を返します。CompletionStage
はいつでも入手可能でなければなりません。 完了すると、型T
の性質に依存します。 多くの場合、T
が読み込まれた後に本文全体を表すとき、本文が読み込まれた後で完了します。T
がInputStream
のようなストリーミング型の場合、本文が読み込まれる前に完了します。なぜなら、呼び出しコードがデータを消費するためです。
-
-
メソッドのサマリー
すべてのメソッド staticメソッド インスタンス・メソッド 抽象メソッド デフォルト・メソッド 修飾子と型 メソッド 説明 static HttpResponse.BodyProcessor<byte[]>
asByteArray()
レスポンス本文をバイト配列として格納するBodyProcessor
を返します。static HttpResponse.BodyProcessor<Void>
asByteArrayConsumer(Consumer<Optional<byte[]>> consumer)
提供されたOptional<byte[]>
のコンシューマに着信する本文データを提供するBodyProcessor
を返します。static HttpResponse.BodyProcessor<Path>
asFile(Path file)
与えられた名前でオープンされたファイルにレスポンス本文を格納するBodyProcessor
を返します。static HttpResponse.BodyProcessor<Path>
asFile(Path file, OpenOption... openOptions)
与えられたオプションと名前でオープンされたファイルにレスポンス本文を格納するBodyProcessor
を返します。static HttpResponse.BodyProcessor<String>
asString(Charset charset)
レスポンス本文を、指定されたCharset
を使用して変換されたString
として格納する本文プロセッサを返します。static <U> HttpResponse.BodyProcessor<U>
discard(U value)
レスポンス本文を破棄するレスポンス・プロセッサを返します。CompletionStage<T>
getBody()
終了時にレスポンス本文オブジェクトを返すCompletionStage
を返します。-
interface java.util.concurrent.Flow.Subscriberから継承したメソッド
onComplete, onError, onNext, onSubscribe
-
-
-
-
メソッドの詳細
-
getBody
CompletionStage<T> getBody()
終了時にレスポンス本文オブジェクトを返すCompletionStage
を返します。- 戻り値:
- レスポンス本文のCompletionStage
-
asString
static HttpResponse.BodyProcessor<String> asString(Charset charset)
レスポンス本文を、指定されたCharset
を使用して変換されたString
として格納する本文プロセッサを返します。このプロセッサを使用する
HttpResponse
は、レスポンス全体を読み取った後に使用できます。- パラメータ:
charset
- 文字列を変換する文字セット- 戻り値:
- 本文プロセッサ
-
asByteArray
static HttpResponse.BodyProcessor<byte[]> asByteArray()
レスポンス本文をバイト配列として格納するBodyProcessor
を返します。このプロセッサを使用する
HttpResponse
は、レスポンス全体を読み取った後に使用できます。- 戻り値:
- 本文プロセッサ
-
asFile
static HttpResponse.BodyProcessor<Path> asFile(Path file, OpenOption... openOptions)
与えられたオプションと名前でオープンされたファイルにレスポンス本文を格納するBodyProcessor
を返します。 ファイルは、本文が読み込まれる直前にFileChannel.open
を使用して、指定されたオプションで開かれます。 スローされた例外は、必要に応じてHttpClient::send
またはHttpClient::sendAsync
から返されるか、スローされます。このプロセッサを使用する
HttpResponse
は、レスポンス全体を読み取った後に使用できます。- パラメータ:
file
- 本文を格納するファイルopenOptions
- ファイルを開くためのオプションのリスト- 戻り値:
- 本文プロセッサ
-
asByteArrayConsumer
static HttpResponse.BodyProcessor<Void> asByteArrayConsumer(Consumer<Optional<byte[]>> consumer)
提供されたOptional<byte[]>
のコンシューマに着信する本文データを提供するBodyProcessor
を返します。Optional
が空の場合、Consumer.accept()
の各呼び出しには、空のOptional
が含まれます。ただし、すべての本文データが読み取られた後の最終呼び出しを除きます。このプロセッサを使用する
HttpResponse
は、レスポンス全体を読み取った後に使用できます。- パラメータ:
consumer
- バイト配列のコンシューマ- 戻り値:
- BodyProcessor
-
asFile
static HttpResponse.BodyProcessor<Path> asFile(Path file)
与えられた名前でオープンされたファイルにレスポンス本文を格納するBodyProcessor
を返します。 標準オープン・オプションCREATE
とWRITE
でasFile
を呼び出すのと同じ効果がありますこのプロセッサを使用する
HttpResponse
は、レスポンス全体を読み取った後に使用できます。- パラメータ:
file
- 本文を格納するファイル- 戻り値:
- 本文プロセッサ
-
discard
static <U> HttpResponse.BodyProcessor<U> discard(U value)
レスポンス本文を破棄するレスポンス・プロセッサを返します。 指定された値は、HttpResponse.body()
から返される値です。- 型パラメータ:
U
- レスポンス本文の型- パラメータ:
value
- HttpResponse.body()から返す値- 戻り値:
BodyProcessor
-
-