クラス AbstractServerHttpResponse
java.lang.ObjectSE
org.springframework.http.server.reactive.AbstractServerHttpResponse
- 実装されたすべてのインターフェース:
HttpMessage
、ReactiveHttpOutputMessage
、ServerHttpResponse
ServerHttpResponse
実装の基本クラス。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze, Brian Clozel
コンストラクターのサマリー
コンストラクターコンストラクター説明AbstractServerHttpResponse
(DataBufferFactory dataBufferFactory) AbstractServerHttpResponse
(DataBufferFactory dataBufferFactory, HttpHeaders headers) メソッドのサマリー
修飾子と型メソッド説明void
addCookie
(ResponseCookie cookie) 指定されたResponseCookie
を追加します。protected abstract void
基になるレスポンスにgetHeaders()
からの Cookie を追加します。protected abstract void
レスポンスがコミットされたときに呼び出され、サブクラスが基になるレスポンスにヘッダー値を適用できるようにします。protected abstract void
状態コードを基になるレスポンスに書き込みます。void
beforeCommit
(SupplierSE<? extends reactor.core.publisher.Mono<VoidSE>> action) HttpOutputMessage がコミットされる直前に適用するアクションを登録します。final DataBufferFactory
ボディの作成に使用できるDataBufferFactory
を返します。protected reactor.core.publisher.Mono<VoidSE>
doCommit()
ボディなしのレスポンス用のdoCommit(Supplier)
のバリアント。protected reactor.core.publisher.Mono<VoidSE>
doCommit
(SupplierSE<? extends reactor.core.publisher.Mono<VoidSE>> writeAction) beforeCommit
アクションを適用し、レスポンスステータスとヘッダー / Cookie を適用し、レスポンス本文を記述します。Cookie を含む可変マップを返し、サーバーに送信します。このメッセージのヘッダーを返します。abstract <T> T
基礎となるサーバーのレスポンスを返します。使用すべきではありません。設定されたステータスコードを返すか、基になるサーバーからのレスポンスのステータスにフォールバックします。boolean
HttpOutputMessage がコミットされているかどうか。reactor.core.publisher.Mono<VoidSE>
メッセージ処理が完了したことを示し、クリーンアップまたは処理の終了タスクを実行できるようにします。たとえば、HttpMessage.getHeaders()
を介して行われたヘッダー変更を基になる HTTP メッセージに適用します(まだ適用されていない場合)。boolean
setRawStatusCode
(IntegerSE statusCode) HTTP ステータスコードを整数として指定された値に設定します。boolean
setStatusCode
(HttpStatusCode status) レスポンスの HTTP ステータスコードを設定します。protected void
touchDataBuffer
(DataBuffer buffer) ヒントがプールされたバッファであり、リークトラッキングをサポートしている場合、サブクラスがヒントをデータバッファに関連付けることを許可します。final reactor.core.publisher.Mono<VoidSE>
writeAndFlushWith
(Publisher<? extends Publisher<? extends DataBuffer>> body) Publishers
の指定されたPublisher
を使用して、HttpOutputMessage の本体を基礎となる HTTP レイヤーに書き込み、各Publisher<DataBuffer>
の後にフラッシュします。protected abstract reactor.core.publisher.Mono<VoidSE>
writeAndFlushWithInternal
(Publisher<? extends Publisher<? extends DataBuffer>> body) 基本となるレスポンスに書き込み、各Publisher<DataBuffer>
の後にフラッシュします。final reactor.core.publisher.Mono<VoidSE>
writeWith
(Publisher<? extends DataBuffer> body) 指定されたPublisher
を使用して、メッセージの本文を基礎となる HTTP レイヤーに書き込みます。protected abstract reactor.core.publisher.Mono<VoidSE>
writeWithInternal
(Publisher<? extends DataBuffer> body) 基本となるレスポンスに書き込みます。
コンストラクターの詳細
AbstractServerHttpResponse
AbstractServerHttpResponse
メソッドの詳細
bufferFactory
インターフェースからコピーされた説明:ReactiveHttpOutputMessage
ボディの作成に使用できるDataBufferFactory
を返します。- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のbufferFactory
- 戻り値:
- 緩衝ファクトリ
- 関連事項:
setStatusCode
インターフェースからコピーされた説明:ServerHttpResponse
レスポンスの HTTP ステータスコードを設定します。- 次で指定:
- インターフェース
ServerHttpResponse
のsetStatusCode
- パラメーター:
status
-HttpStatusCode
値としての HTTP ステータス- 戻り値:
- HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は
false
、正常に設定された場合はtrue
。
getStatusCode
インターフェースからコピーされた説明:ServerHttpResponse
設定されているステータスコードを返すか、そうでなければ、基盤となるサーバーからのレスポンスのステータスにフォールバックします。基礎となるサーバーからのデフォルト値がない場合、戻り値はnull
になる可能性があります。- 次で指定:
- インターフェース
ServerHttpResponse
のgetStatusCode
setRawStatusCode
インターフェースからコピーされた説明:ServerHttpResponse
HTTP ステータスコードを整数として指定された値に設定します。- 次で指定:
- インターフェース
ServerHttpResponse
のsetRawStatusCode
- パラメーター:
statusCode
- ステータスコード値- 戻り値:
- HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は
false
、正常に設定された場合はtrue
。
getRawStatusCode
使用すべきではありません。インターフェースからコピーされた説明:ServerHttpResponse
設定されているステータスコードを返すか、そうでなければ、基盤となるサーバーからのレスポンスのステータスにフォールバックします。基礎となるサーバーからのデフォルト値がない場合、戻り値はnull
になる可能性があります。- 次で指定:
- インターフェース
ServerHttpResponse
のgetRawStatusCode
getHeaders
インターフェースからコピーされた説明:HttpMessage
このメッセージのヘッダーを返します。- 次で指定:
- インターフェース
HttpMessage
のgetHeaders
- 戻り値:
- 対応する HttpHeaders オブジェクト (非
null
)
getCookies
インターフェースからコピーされた説明:ServerHttpResponse
Cookie を含む可変マップを返し、サーバーに送信します。- 次で指定:
- インターフェース
ServerHttpResponse
のgetCookies
addCookie
インターフェースからコピーされた説明:ServerHttpResponse
指定されたResponseCookie
を追加します。- 次で指定:
- インターフェース
ServerHttpResponse
のaddCookie
- パラメーター:
cookie
- 追加する Cookie
getNativeResponse
public abstract <T> T getNativeResponse()基礎となるサーバーのレスポンスを返します。注意 : これは主に、spring-webflux モジュールでの WebSocket アップグレードなどの内部フレームワークの使用のために公開されています。
beforeCommit
インターフェースからコピーされた説明:ReactiveHttpOutputMessage
HttpOutputMessage がコミットされる直前に適用するアクションを登録します。注意 : 指定されたアクションは適切に延期する必要があります。
Mono.defer(java.util.function.Supplier<? extends reactor.core.publisher.Mono<? extends T>>)
またはMono.fromRunnable(java.lang.Runnable)
を介して、他のアクションに対して適切な順序で実行されるようにします。- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のbeforeCommit
- パラメーター:
action
- 適用するアクション
isCommitted
public boolean isCommitted()インターフェースからコピーされた説明:ReactiveHttpOutputMessage
HttpOutputMessage がコミットされているかどうか。- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のisCommitted
writeWith
インターフェースからコピーされた説明:ReactiveHttpOutputMessage
指定されたPublisher
を使用して、メッセージの本文を基礎となる HTTP レイヤーに書き込みます。- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のwriteWith
- パラメーター:
body
- 本文コンテンツ発行者- 戻り値:
- 完了またはエラーを示す
Mono
writeAndFlushWith
public final reactor.core.publisher.Mono<VoidSE> writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body) インターフェースからコピーされた説明:ReactiveHttpOutputMessage
Publishers
の指定されたPublisher
を使用して、HttpOutputMessage の本体を基礎となる HTTP レイヤーに書き込み、各Publisher<DataBuffer>
の後にフラッシュします。- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のwriteAndFlushWith
- パラメーター:
body
- 本文コンテンツ発行者- 戻り値:
- 完了またはエラーを示す
Mono
setComplete
インターフェースからコピーされた説明:ReactiveHttpOutputMessage
メッセージ処理が完了したことを示し、クリーンアップまたは処理の終了タスクを実行できるようにします。たとえば、HttpMessage.getHeaders()
を介して行われたヘッダー変更を基になる HTTP メッセージに適用します(まだ適用されていない場合)。このメソッドは、メッセージ処理の最後に自動的に呼び出される必要があるため、通常はアプリケーションで呼び出す必要はありません。複数回呼び出された場合、副作用はありません。
- 次で指定:
- インターフェース
ReactiveHttpOutputMessage
のsetComplete
- 戻り値:
- 完了またはエラーを示す
Mono
doCommit
ボディなしのレスポンス用のdoCommit(Supplier)
のバリアント。- 戻り値:
- 完成パブリッシャー
doCommit
protected reactor.core.publisher.Mono<VoidSE> doCommit(@Nullable SupplierSE<? extends reactor.core.publisher.Mono<VoidSE>> writeAction) beforeCommit
アクションを適用し、レスポンスステータスとヘッダー / Cookie を適用し、レスポンス本文を記述します。- パラメーター:
writeAction
- レスポンス本文を書き込むアクション (null
の場合があります)- 戻り値:
- 完成パブリッシャー
writeWithInternal
protected abstract reactor.core.publisher.Mono<VoidSE> writeWithInternal(Publisher<? extends DataBuffer> body) 基本となるレスポンスに書き込みます。- パラメーター:
body
- 一緒に書くパブリッシャー
writeAndFlushWithInternal
protected abstract reactor.core.publisher.Mono<VoidSE> writeAndFlushWithInternal(Publisher<? extends Publisher<? extends DataBuffer>> body) 基本となるレスポンスに書き込み、各Publisher<DataBuffer>
の後にフラッシュします。- パラメーター:
body
- 書き込みおよびフラッシュするパブリッシャー
applyStatusCode
protected abstract void applyStatusCode()状態コードを基になるレスポンスに書き込みます。このメソッドは 1 回だけ呼び出されます。applyHeaders
protected abstract void applyHeaders()レスポンスがコミットされたときに呼び出され、サブクラスが基になるレスポンスにヘッダー値を適用できるようにします。一部のサブクラスは、ネイティブレスポンスヘッダーへのアダプターをラップする
HttpHeaders
インスタンスを使用して、変更が実行時に基礎となるレスポンスに伝播されることに注意してください。つまり、このコールバックは、サーブレットレスポンスの contentType または characterEncoding フィールドの設定などの特殊な更新以外では使用されない可能性があります。applyCookies
protected abstract void applyCookies()基になるレスポンスにgetHeaders()
からの Cookie を追加します。このメソッドは 1 回だけ呼び出されます。touchDataBuffer
ヒントがプールされたバッファであり、リークトラッキングをサポートしている場合、サブクラスがヒントをデータバッファに関連付けることを許可します。- パラメーター:
buffer
- ヒントを添付するバッファ- 導入:
- 5.3.2