ServerWebExchangeDecorator (Spring Framework API)

java.lang.ObjectSE
- org.springframework.web.server.ServerWebExchangeDecorator

実装されたすべてのインターフェース:
ServerWebExchange
```
public class ServerWebExchangeDecorator
extends ObjectSE
implements ServerWebExchange
```
別の ServerWebExchange をラップする必要があるクラスの便利な基本クラス。ラップされたインスタンスに委譲することにより、すべてのメソッドを事前実装します。
注意 : デコレータを使用する目的が getPrincipal() のようなプロパティをオーバーライドすることである場合は、代わりに ServerWebExchange.mutate() の使用を検討してください。
導入:
5.0
作成者:
Rossen Stoyanchev
関連事項:
ServerWebExchange.mutate()

ネストされたクラスのサマリー
- インターフェース org.springframework.web.server.ServerWebExchange から継承されたネストクラス / インターフェース
  ServerWebExchange.Builder

フィールドサマリー
- インターフェース org.springframework.web.server.ServerWebExchange から継承されたフィールド
  LOG_ID_ATTRIBUTE

コンストラクターのサマリー
コンストラクター
修飾子コンストラクターと説明
protected ServerWebExchangeDecorator(ServerWebExchange delegate)

コンストラクター
修飾子	コンストラクターと説明
`protected`	`ServerWebExchangeDecorator(ServerWebExchange delegate)`

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド
修飾子と型	メソッドと説明
`void`	`addUrlTransformer(FunctionSE<StringSE, StringSE> transformer)` `ServerWebExchange.transformUrl(java.lang.String)` で使用する追加の URL 変換関数を登録します。
`boolean`	`checkNotModified(InstantSE lastModified)` タイムスタンプが最後に変更された `ServerWebExchange.checkNotModified(String, Instant)` のオーバーロードバリアント。
`boolean`	`checkNotModified(StringSE etag)` `ETag` （エンティティタグ）値のみを持つ `ServerWebExchange.checkNotModified(String, Instant)` のオーバーロードされたバリアント。
`boolean`	`checkNotModified(StringSE etag, InstantSE lastModified)` 提供された `ETag` （エンティティタグ）およびアプリケーションによって決定された最終変更タイムスタンプを指定して、リクエストされたリソースが変更されたかどうかを確認します。
`ApplicationContext`	`getApplicationContext()` `WebHttpHandlerBuilder.applicationContext(ApplicationContext)` で初期化された場合、Web アプリケーションに関連付けられた `ApplicationContext` を返します。
`MapSE<StringSE, ObjectSE>`	`getAttributes()` 現在の交換のリクエスト属性の可変マップを返します。
`ServerWebExchange`	`getDelegate()`
`reactor.core.publisher.Mono<MultiValueMap<StringSE, StringSE>>`	`getFormData()` Content-Type が `"application/x-www-form-urlencoded"` の場合はリクエストの本文からフォームデータを返し、それ以外の場合は空のマップを返します。
`LocaleContext`	`getLocaleContext()` 設定された `LocaleContextResolver` を使用して `LocaleContext` を返します。
`StringSE`	`getLogPrefix()` この交換のメッセージを相関させるために使用するログメッセージプレフィックスを返します。
`reactor.core.publisher.Mono<MultiValueMap<StringSE, Part>>`	`getMultipartData()` Content-Type が `"multipart/form-data"` である場合はマルチパートリクエストの部分を返し、そうでない場合は空のマップを返します。
`<T extends PrincipalSE> reactor.core.publisher.Mono<T>`	`getPrincipal()` リクエストに対して認証されたユーザーがいる場合、それを返します。
`ServerHttpRequest`	`getRequest()` 現在の HTTP リクエストを返します。
`ServerHttpResponse`	`getResponse()` 現在の HTTP レスポンスを返します。
`reactor.core.publisher.Mono<WebSession>`	`getSession()` 現在のリクエストの Web セッションを返します。
`boolean`	`isNotModified()` この契約の `checkNotModified` メソッドの 1 つが使用され、true を返した場合、`true` を返します。
`StringSE`	`toString()`
`StringSE`	`transformUrl(StringSE url)` 登録された変換関数に従って、指定された URL を変換します。

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

インターフェース org.springframework.web.server.ServerWebExchange から継承されたメソッド
getAttribute, getAttributeOrDefault, getRequiredAttribute, mutate

- コンストラクターの詳細
  - ServerWebExchangeDecorator
```
protected ServerWebExchangeDecorator(ServerWebExchange delegate)
```
- メソッドの詳細
  - getDelegate
```
public ServerWebExchange getDelegate()
```
  - getRequest
```
public ServerHttpRequest getRequest()
```
    インターフェースからコピーされた説明: ServerWebExchange
    現在の HTTP リクエストを返します。
    次で指定:
    インターフェース ServerWebExchange の getRequest
  - getResponse
```
public ServerHttpResponse getResponse()
```
    インターフェースからコピーされた説明: ServerWebExchange
    現在の HTTP レスポンスを返します。
    次で指定:
    インターフェース ServerWebExchange の getResponse
  - getAttributes
```
public MapSE<StringSE,ObjectSE> getAttributes()
```
    インターフェースからコピーされた説明: ServerWebExchange
    現在の交換のリクエスト属性の可変マップを返します。
    次で指定:
    インターフェース ServerWebExchange の getAttributes
  - getSession
```
public reactor.core.publisher.Mono<WebSession> getSession()
```
    インターフェースからコピーされた説明: ServerWebExchange
    現在のリクエストの Web セッションを返します。クライアントがリクエストしたセッション ID に一致するか、クライアントが指定していないか、基礎となるセッションの有効期限が切れたため、新しいセッション ID でインスタンスを返すことが常に保証されます。このメソッドを使用しても、セッションは自動的に作成されません。詳細については、WebSession を参照してください。
    次で指定:
    インターフェース ServerWebExchange の getSession
  - getPrincipal
```
public <T extends PrincipalSE> reactor.core.publisher.Mono<T> getPrincipal()
```
    インターフェースからコピーされた説明: ServerWebExchange
    リクエストに対して認証されたユーザーがいる場合、それを返します。
    次で指定:
    インターフェース ServerWebExchange の getPrincipal
  - getLocaleContext
```
public LocaleContext getLocaleContext()
```
    インターフェースからコピーされた説明: ServerWebExchange
    設定された LocaleContextResolver を使用して LocaleContext を返します。
    次で指定:
    インターフェース ServerWebExchange の getLocaleContext
  - getApplicationContext
```
public ApplicationContext getApplicationContext()
```
    インターフェースからコピーされた説明: ServerWebExchange
    WebHttpHandlerBuilder.applicationContext(ApplicationContext) で初期化された場合、Web アプリケーションに関連付けられた ApplicationContext を返します。
    次で指定:
    インターフェース ServerWebExchange の getApplicationContext
    関連事項:
    WebHttpHandlerBuilder.applicationContext(ApplicationContext)
  - getFormData
```
public reactor.core.publisher.Mono<MultiValueMap<StringSE,StringSE>> getFormData()
```
    インターフェースからコピーされた説明: ServerWebExchange
    Content-Type が "application/x-www-form-urlencoded" の場合はリクエストの本文からフォームデータを返し、それ以外の場合は空のマップを返します。
    注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の MultiValueMap がキャッシュされるため、このメソッドを複数回呼び出しても安全です。
    次で指定:
    インターフェース ServerWebExchange の getFormData
  - getMultipartData
```
public reactor.core.publisher.Mono<MultiValueMap<StringSE,Part>> getMultipartData()
```
    インターフェースからコピーされた説明: ServerWebExchange
    Content-Type が "multipart/form-data" である場合はマルチパートリクエストの部分を返し、そうでない場合は空のマップを返します。
    注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の MultiValueMap がキャッシュされるため、このメソッドを複数回呼び出しても安全です。
    注 : 各部分のコンテンツはキャッシュされず、1 回しか読み取ることができません。
    次で指定:
    インターフェース ServerWebExchange の getMultipartData
  - isNotModified
```
public boolean isNotModified()
```
    インターフェースからコピーされた説明: ServerWebExchange
    この契約の checkNotModified メソッドの 1 つが使用され、true を返した場合、true を返します。
    次で指定:
    インターフェース ServerWebExchange の isNotModified
  - checkNotModified
```
public boolean checkNotModified(InstantSE lastModified)
```
    インターフェースからコピーされた説明: ServerWebExchange
    タイムスタンプが最後に変更された ServerWebExchange.checkNotModified(String, Instant) のオーバーロードバリアント。
    次で指定:
    インターフェース ServerWebExchange の checkNotModified
    パラメーター:
    lastModified - 最終変更時刻
    戻り値:
    リクエストが変更されていないものとみなされるかどうか
  - checkNotModified
```
public boolean checkNotModified(StringSE etag)
```
    インターフェースからコピーされた説明: ServerWebExchange
    ETag （エンティティタグ）値のみを持つ ServerWebExchange.checkNotModified(String, Instant) のオーバーロードされたバリアント。
    次で指定:
    インターフェース ServerWebExchange の checkNotModified
    パラメーター:
    etag - 基になるリソースのエンティティタグ。
    戻り値:
    リクエストがそれ以上の処理を必要としない場合は true。
  - checkNotModified
```
public boolean checkNotModified(@Nullable
                                StringSE etag,
                                InstantSE lastModified)
```
    インターフェースからコピーされた説明: ServerWebExchange
    提供された ETag （エンティティタグ）およびアプリケーションによって決定された最終変更のタイムスタンプを前提として、リクエストされたリソースが変更されているかどうかを確認します。また、レスポンスを透過的に準備し、HTTP ステータスを設定し、必要に応じて "ETag" および "Last-Modified" ヘッダーを追加します。このメソッドは、条件付き GET/HEAD リクエストと条件付き POST/PUT/DELETE リクエストで機能します。
    注意 : HTTP 仕様では、ETag 値と Last-Modified 値の両方を設定することを推奨していますが、#checkNotModified(String) または ServerWebExchange.checkNotModified(Instant) を使用することもできます。
    次で指定:
    インターフェース ServerWebExchange の checkNotModified
    パラメーター:
    etag - アプリケーションが基になるリソースに対して決定したエンティティタグ。このパラメーターには、必要に応じて引用符（"）が埋め込まれます。
    lastModified - アプリケーションが基礎となるリソースについて決定した最終変更のタイムスタンプ
    戻り値:
    リクエストがそれ以上の処理を必要としない場合は true。
  - transformUrl
```
public StringSE transformUrl(StringSE url)
```
    インターフェースからコピーされた説明: ServerWebExchange
    登録された変換関数に従って、指定された URL を変換します。デフォルトでは、このメソッドは指定された url を返しますが、追加の変換関数は ServerWebExchange.addUrlTransformer(java.util.function.Function<java.lang.String, java.lang.String>) に登録できます。
    次で指定:
    インターフェース ServerWebExchange の transformUrl
    パラメーター:
    url - 変換する URL
    戻り値:
    変換された URL
  - addUrlTransformer
```
public void addUrlTransformer(FunctionSE<StringSE,StringSE> transformer)
```
    インターフェースからコピーされた説明: ServerWebExchange
    ServerWebExchange.transformUrl(java.lang.String) で使用する追加の URL 変換関数を登録します。指定された関数を使用して、認証用の ID、CSRF 保護用のノンスなどを挿入できます。
    指定された関数は、以前に登録された関数の後に適用されます。
    次で指定:
    インターフェース ServerWebExchange の addUrlTransformer
    パラメーター:
    transformer - 追加する URL 変換関数
  - getLogPrefix
```
public StringSE getLogPrefix()
```
    インターフェースからコピーされた説明: ServerWebExchange
    この交換のメッセージを関連付けるために使用するログメッセージプレフィックスを返します。接頭辞は、属性 ServerWebExchange.LOG_ID_ATTRIBUTE の値といくつかの追加の書式に基づいているため、接頭辞を追加して、セパレータを必要としない書式を追加する必要はありません。
    次で指定:
    インターフェース ServerWebExchange の getLogPrefix
    戻り値:
    ログメッセージのプレフィックス、または ServerWebExchange.LOG_ID_ATTRIBUTE が設定されていない場合は空の文字列
  - toString
```
public StringSE toString()
```
    オーバーライド:
    クラス ObjectSE の toStringSE

クラス ServerWebExchangeDecorator

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

インターフェース org.springframework.web.server.ServerWebExchange から継承されたネストクラス / インターフェース

フィールドサマリー

インターフェース org.springframework.web.server.ServerWebExchange から継承されたフィールド

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

メソッドのサマリー

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

インターフェース org.springframework.web.server.ServerWebExchange から継承されたメソッド

コンストラクターの詳細

ServerWebExchangeDecorator

メソッドの詳細

getDelegate

getRequest

getResponse

getAttributes

getSession

getPrincipal

getLocaleContext

getApplicationContext

getFormData

getMultipartData

isNotModified

checkNotModified

checkNotModified

checkNotModified

transformUrl

addUrlTransformer

getLogPrefix

toString