AbstractServerHttpResponse (Spring Framework 5.2.6.RELEASE API)

java.lang.ObjectSE
- org.springframework.http.server.reactive.AbstractServerHttpResponse

実装されているすべてのインターフェース:
HttpMessage, ReactiveHttpOutputMessage, ServerHttpResponse
既知の直属サブクラス
AbstractListenerServerHttpResponse, MockServerHttpResponse
```
public abstract class AbstractServerHttpResponse
extends ObjectSE
implements ServerHttpResponse
```
ServerHttpResponse 実装の基本クラス。
導入:
5.0
作成者:
Rossen Stoyanchev, Juergen Hoeller, Sebastien Deleuze, Brian Clozel

フィールドのサマリー
フィールド
修飾子と型フィールドと説明
protected Log logger

フィールド
修飾子と型	フィールドと説明
`protected Log`	`logger`

コンストラクターの概要

コンストラクター
コンストラクターと説明
`AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)`
`AbstractServerHttpResponse(DataBufferFactory dataBufferFactory, HttpHeaders headers)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`addCookie(ResponseCookie cookie)` 指定された `ResponseCookie` を追加します。
`protected abstract void`	`applyCookies()` 基になるレスポンスに `getHeaders()` からの Cookie を追加します。
`protected abstract void`	`applyHeaders()` レスポンスがコミットされるときに呼び出され、サブクラスが基になるレスポンスにヘッダー値を適用できるようにします。
`protected abstract void`	`applyStatusCode()` 状態コードを基になるレスポンスに書き込みます。
`void`	`beforeCommit(SupplierSE<? extends reactor.core.publisher.Mono<VoidSE>> action)` HttpOutputMessage がコミットされる直前に適用するアクションを登録します。
`DataBufferFactory`	`bufferFactory()` ボディの作成に使用できる `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 を適用し、レスポンス本文を記述します。
`MultiValueMap<StringSE, ResponseCookie>`	`getCookies()` Cookie を含む可変マップを返し、サーバーに送信します。
`HttpHeaders`	`getHeaders()` このメッセージのヘッダーを返します。
`abstract <T> T`	`getNativeResponse()` 基礎となるサーバーのレスポンスを返します。
`IntegerSE`	`getRawStatusCode()` 設定されたステータスコードを返すか、基になるサーバーからのレスポンスのステータスにフォールバックします。
`HttpStatus`	`getStatusCode()` 設定されたステータスコードを返すか、基になるサーバーからのレスポンスのステータスにフォールバックします。
`IntegerSE`	`getStatusCodeValue()` 使用すべきではありません。 5.2.4 現在、`ServerHttpResponse.getRawStatusCode()` を推奨
`boolean`	`isCommitted()` HttpOutputMessage がコミットされているかどうか。
`reactor.core.publisher.Mono<VoidSE>`	`setComplete()` メッセージ処理が完了したことを示し、クリーンアップまたは処理の終了タスクを実行できるようにします。たとえば、`HttpMessage.getHeaders()` を介して行われたヘッダー変更を基になる HTTP メッセージに適用します（まだ適用されていない場合）。
`boolean`	`setRawStatusCode(IntegerSE statusCode)` HTTP ステータスコードを整数として指定された値（非標準であり、`HttpStatus` 列挙型で解決できない可能性があります）に設定します。
`boolean`	`setStatusCode(HttpStatus status)` レスポンスの HTTP ステータスコードを設定します。
`void`	`setStatusCodeValue(IntegerSE statusCode)` 使用すべきではありません。 5.2.4 現在、`ServerHttpResponse.setRawStatusCode(Integer)` を推奨
`reactor.core.publisher.Mono<VoidSE>`	`writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body)` `Publishers` の指定された `Publisher` を使用して、HttpOutputMessage の本体を基礎となる HTTP レイヤーに書き込み、各 `Publisher<DataBuffer>` の後にフラッシュします。
`protected abstract reactor.core.publisher.Mono<VoidSE>`	`writeAndFlushWithInternal(org.reactivestreams.Publisher<? extends org.reactivestreams.Publisher<? extends DataBuffer>> body)` 基本となるレスポンスに書き込み、各 `Publisher<DataBuffer>` の後にフラッシュします。
`reactor.core.publisher.Mono<VoidSE>`	`writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body)` 指定された `Publisher` を使用して、メッセージの本文を基礎となる HTTP レイヤーに書き込みます。
`protected abstract reactor.core.publisher.Mono<VoidSE>`	`writeWithInternal(org.reactivestreams.Publisher<? extends DataBuffer> body)` 基本となるレスポンスに書き込みます。

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- フィールドの詳細
  - logger
```
protected final Log logger
```
- コンストラクターの詳細
  - AbstractServerHttpResponse
```
public AbstractServerHttpResponse(DataBufferFactory dataBufferFactory)
```
  - AbstractServerHttpResponse
```
public AbstractServerHttpResponse(DataBufferFactory dataBufferFactory,
                                  HttpHeaders headers)
```
- メソッドの詳細
  - bufferFactory
```
public final DataBufferFactory bufferFactory()
```
    インターフェースからコピーされた説明: ReactiveHttpOutputMessage
    ボディの作成に使用できる DataBufferFactory を返します。
    次で指定:
    インターフェース ReactiveHttpOutputMessage の bufferFactory
    戻り値:
    緩衝ファクトリ
    関連事項:
    ReactiveHttpOutputMessage.writeWith(Publisher)
  - setStatusCode
```
public boolean setStatusCode(@Nullable
                             HttpStatus status)
```
    インターフェースからコピーされた説明: ServerHttpResponse
    レスポンスの HTTP ステータスコードを設定します。
    次で指定:
    インターフェース ServerHttpResponse の setStatusCode
    パラメーター:
    status - HttpStatus 列挙値としての HTTP ステータス
    戻り値:
    HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は false、正常に設定された場合は true。
  - getStatusCode
```
@Nullable
public HttpStatus getStatusCode()
```
    インターフェースからコピーされた説明: ServerHttpResponse
    設定されたステータスコードを返すか、基になるサーバーからのレスポンスのステータスにフォールバックします。ステータスコードの値が HttpStatus 列挙範囲外の場合、または基になるサーバーからデフォルト値がない場合、戻り値は null になります。
    次で指定:
    インターフェース ServerHttpResponse の getStatusCode
  - setRawStatusCode
```
public boolean setRawStatusCode(@Nullable
                                IntegerSE statusCode)
```
    インターフェースからコピーされた説明: ServerHttpResponse
    HTTP ステータスコードを整数として指定された値（非標準であり、HttpStatus 列挙型で解決できない可能性があります）に設定します。
    次で指定:
    インターフェース ServerHttpResponse の setRawStatusCode
    パラメーター:
    statusCode - ステータスコード値
    戻り値:
    HTTP レスポンスがコミットされたためにステータスコードの変更が処理されなかった場合は false、正常に設定された場合は true。
  - getRawStatusCode
```
@Nullable
public IntegerSE getRawStatusCode()
```
    インターフェースからコピーされた説明: ServerHttpResponse
    設定されているステータスコードを返すか、そうでなければ、基盤となるサーバーからのレスポンスのステータスにフォールバックします。基礎となるサーバーからのデフォルト値がない場合、戻り値は null になる可能性があります。
    次で指定:
    インターフェース ServerHttpResponse の getRawStatusCode
  - setStatusCodeValue
```
@DeprecatedSE
public void setStatusCodeValue(@Nullable
                                           IntegerSE statusCode)
```
    非推奨。5.2.4 より ServerHttpResponse.setRawStatusCode(Integer) に切り替え。
    レスポンスの HTTP ステータスコードを設定します。
    パラメーター:
    statusCode - 整数値としての HTTP ステータス
    導入:
    5.0.1
  - getStatusCodeValue
```
@Nullable
 @DeprecatedSE
public IntegerSE getStatusCodeValue()
```
    非推奨。5.2.4 より ServerHttpResponse.getRawStatusCode() に切り替え。
    レスポンスの HTTP ステータスコードを返します。
    戻り値:
    整数値としての HTTP ステータス
    導入:
    5.0.1
  - 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
  - getNativeResponse
```
public abstract <T> T getNativeResponse()
```
    基礎となるサーバーのレスポンスを返します。
    注意 : これは主に、spring-webflux モジュールでの WebSocket アップグレードなどの内部フレームワークの使用のために公開されています。
  - 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 final reactor.core.publisher.Mono<VoidSE> writeWith(org.reactivestreams.Publisher<? extends DataBuffer> body)
```
    インターフェースからコピーされた説明: ReactiveHttpOutputMessage
    指定された Publisher を使用して、メッセージの本文を基礎となる HTTP レイヤーに書き込みます。
    次で指定:
    インターフェース ReactiveHttpOutputMessage の writeWith
    パラメーター:
    body - 本文コンテンツ発行者
    戻り値:
    完了またはエラーを示す Mono
  - writeAndFlushWith
```
public final reactor.core.publisher.Mono<VoidSE> writeAndFlushWith(org.reactivestreams.Publisher<? extends org.reactivestreams.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
  - doCommit
```
protected reactor.core.publisher.Mono<VoidSE> 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(org.reactivestreams.Publisher<? extends DataBuffer> body)
```
    基本となるレスポンスに書き込みます。
    パラメーター:
    body - 一緒に書くパブリッシャー
  - writeAndFlushWithInternal
```
protected abstract reactor.core.publisher.Mono<VoidSE> writeAndFlushWithInternal(org.reactivestreams.Publisher<? extends org.reactivestreams.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 回だけ呼び出されます。

クラス AbstractServerHttpResponse

フィールドのサマリー

コンストラクターの概要

メソッドのサマリー

クラス java.lang.ObjectSE から継承されたメソッド

フィールドの詳細

logger

コンストラクターの詳細

AbstractServerHttpResponse

AbstractServerHttpResponse

メソッドの詳細

bufferFactory

setStatusCode

getStatusCode

setRawStatusCode

getRawStatusCode

setStatusCodeValue

getStatusCodeValue

getHeaders

getCookies

addCookie

getNativeResponse

beforeCommit

isCommitted

writeWith

writeAndFlushWith

setComplete

doCommit

doCommit

writeWithInternal

writeAndFlushWithInternal

applyStatusCode

applyHeaders

applyCookies