パッケージ org.springframework.http.server.reactive

クラス ServerHttpResponseDecorator

java.lang.ObjectSE
org.springframework.http.server.reactive.ServerHttpResponseDecorator
実装されたすべてのインターフェース:
HttpMessage、ReactiveHttpOutputMessage、ServerHttpResponse
既知の直属サブクラス
HttpHeadResponseDecorator
public class ServerHttpResponseDecorator extends ObjectSE implements ServerHttpResponse
別の ServerHttpResponse をラップし、すべてのメソッドをそれに委譲します。サブクラスは、特定のメソッドを選択的にオーバーライドできます。
導入:
5.0
作成者:
Rossen Stoyanchev

  • コンストラクターの詳細

    • ServerHttpResponseDecorator

      public ServerHttpResponseDecorator(ServerHttpResponse delegate)

  • メソッドの詳細

    • getDelegate

      public ServerHttpResponse getDelegate()

    • setStatusCode

      public boolean setStatusCode(@Nullable HttpStatusCode status)
      インターフェースからコピーされた説明: ServerHttpResponse
      レスポンスの HTTP ステータスコードを設定します。
      次で指定:
      インターフェース ServerHttpResponse の setStatusCode 
      パラメーター:
      status - HttpStatusCode 値としての HTTP ステータス
      戻り値:
      HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は false、正常に設定された場合は true。

    • getStatusCode

      @Nullable public HttpStatusCode getStatusCode()
      インターフェースからコピーされた説明: ServerHttpResponse
      設定されているステータスコードを返すか、そうでなければ、基盤となるサーバーからのレスポンスのステータスにフォールバックします。基礎となるサーバーからのデフォルト値がない場合、戻り値は null になる可能性があります。
      次で指定:
      インターフェース ServerHttpResponse の getStatusCode 

    • setRawStatusCode

      public boolean setRawStatusCode(@Nullable IntegerSE value)
      インターフェースからコピーされた説明: ServerHttpResponse
      HTTP ステータスコードを整数として指定された値に設定します。
      次で指定:
      インターフェース ServerHttpResponse の setRawStatusCode 
      パラメーター:
      value - ステータスコード値
      戻り値:
      HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は false、正常に設定された場合は true。

    • getRawStatusCode

      @Nullable @DeprecatedSE public IntegerSE getRawStatusCode()
      使用すべきではありません。
      インターフェースからコピーされた説明: ServerHttpResponse
      設定されているステータスコードを返すか、そうでなければ、基盤となるサーバーからのレスポンスのステータスにフォールバックします。基礎となるサーバーからのデフォルト値がない場合、戻り値は null になる可能性があります。
      次で指定:
      インターフェース ServerHttpResponse の getRawStatusCode 

    • getHeaders

      public HttpHeaders getHeaders()
      インターフェースからコピーされた説明: HttpMessage
      このメッセージのヘッダーを返します。
      次で指定:
      インターフェース HttpMessage の getHeaders 
      戻り値:
      対応する HttpHeaders オブジェクト (非 null)

    • getCookies

      public MultiValueMap<StringSE,ResponseCookie> getCookies()
      インターフェースからコピーされた説明: ServerHttpResponse
      Cookie を含む可変マップを返し、サーバーに送信します。
      次で指定:
      インターフェース ServerHttpResponse の getCookies 

    • addCookie

      public void addCookie(ResponseCookie cookie)
      インターフェースからコピーされた説明: ServerHttpResponse
      指定された ResponseCookie を追加します。
      次で指定:
      インターフェース ServerHttpResponse の addCookie 
      パラメーター:
      cookie - 追加する Cookie

    • bufferFactory

      public DataBufferFactory bufferFactory()
      インターフェースからコピーされた説明: ReactiveHttpOutputMessage
      ボディの作成に使用できる DataBufferFactory を返します。
      次で指定:
      インターフェース ReactiveHttpOutputMessage の bufferFactory 
      戻り値:
      緩衝ファクトリ
      関連事項:

    • beforeCommit

      public void beforeCommit(SupplierSE<? extends reactor.core.publisher.Mono<VoidSE>> action)
      インターフェースからコピーされた説明: 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

      public reactor.core.publisher.Mono<VoidSE> writeWith(Publisher<? extends DataBuffer> body)
      インターフェースからコピーされた説明: ReactiveHttpOutputMessage
      指定された Publisher を使用して、メッセージの本文を基礎となる HTTP レイヤーに書き込みます。
      次で指定:
      インターフェース ReactiveHttpOutputMessage の writeWith 
      パラメーター:
      body - 本文コンテンツ発行者
      戻り値:
      完了またはエラーを示す Mono 

    • writeAndFlushWith

      public reactor.core.publisher.Mono<VoidSE> writeAndFlushWith(Publisher<? extends Publisher<? extends DataBuffer>> body)
      インターフェースからコピーされた説明: ReactiveHttpOutputMessage
      Publishers の指定された Publisher を使用して、HttpOutputMessage の本体を基礎となる HTTP レイヤーに書き込み、各 Publisher<DataBuffer> の後にフラッシュします。
      次で指定:
      インターフェース ReactiveHttpOutputMessage の writeAndFlushWith 
      パラメーター:
      body - 本文コンテンツ発行者
      戻り値:
      完了またはエラーを示す Mono 

    • setComplete

      public reactor.core.publisher.Mono<VoidSE> setComplete()
      インターフェースからコピーされた説明: ReactiveHttpOutputMessage
      メッセージ処理が完了したことを示し、クリーンアップまたは処理の終了タスクを実行できるようにします。たとえば、HttpMessage.getHeaders() を介して行われたヘッダー変更を基になる HTTP メッセージに適用します（まだ適用されていない場合）。

      このメソッドは、メッセージ処理の最後に自動的に呼び出される必要があるため、通常はアプリケーションで呼び出す必要はありません。複数回呼び出された場合、副作用はありません。

      次で指定:
      インターフェース ReactiveHttpOutputMessage の setComplete 
      戻り値:
      完了またはエラーを示す Mono 

    • getNativeResponse

      public static <T> T getNativeResponse(ServerHttpResponse response)
      可能であれば、基盤となるサーバー API のネイティブレスポンスを返し、必要に応じて ServerHttpResponseDecorator もアンラップします。
      型パラメーター:
      T - 予想されるネイティブレスポンス型
      パラメーター:
      response - チェックへのレスポンス
      例外:
      IllegalArgumentExceptionSE - ネイティブレスポンスが得られない場合
      導入:
      5.3.3

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString