クラス DefaultServerWebExchange
java.lang.ObjectSE
org.springframework.web.server.adapter.DefaultServerWebExchange
- 実装されたすべてのインターフェース:
ServerWebExchange
- 既知の直属サブクラス
MockServerWebExchange
ServerWebExchange
のデフォルト実装。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev, Brian Clozel
ネストされたクラスのサマリー
インターフェース org.springframework.web.server.ServerWebExchange から継承されたネストクラス / インターフェース
ServerWebExchange.Builder
フィールドのサマリー
インターフェース org.springframework.web.server.ServerWebExchange から継承されたフィールド
LOG_ID_ATTRIBUTE
コンストラクターのサマリー
コンストラクター修飾子コンストラクター説明DefaultServerWebExchange
(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver) protected
DefaultServerWebExchange
(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver, ApplicationContext applicationContext) メソッドのサマリー
修飾子と型メソッド説明void
addUrlTransformer
(FunctionSE<StringSE, StringSE> transformer) ServerWebExchange.transformUrl(java.lang.String)
で使用する追加の URL 変換関数を登録します。boolean
checkNotModified
(StringSE etag) ETag
(エンティティタグ)値のみを持つServerWebExchange.checkNotModified(String, Instant)
のオーバーロードされたバリアント。boolean
checkNotModified
(StringSE eTag, InstantSE lastModified) 提供されたETag
(エンティティタグ)およびアプリケーションによって決定された最終変更タイムスタンプを指定して、リクエストされたリソースが変更されたかどうかを確認します。boolean
checkNotModified
(InstantSE lastModified) タイムスタンプが最後に変更されたServerWebExchange.checkNotModified(String, Instant)
のオーバーロードバリアント。reactor.core.publisher.Mono<VoidSE>
マルチパート処理に使用されるストレージをクリーンアップします。WebHttpHandlerBuilder.applicationContext(ApplicationContext)
で初期化された場合、Web アプリケーションに関連付けられたApplicationContext
を返します。現在の交換のリクエスト属性の可変マップを返します。reactor.core.publisher.Mono<MultiValueMap<StringSE,
StringSE>> Content-Type が"application/x-www-form-urlencoded"
の場合はリクエストの本文からフォームデータを返し、それ以外の場合は空のマップを返します。設定されたLocaleContextResolver
を使用してLocaleContext
を返します。この交換のメッセージを相関させるために使用するログメッセージプレフィックスを返します。reactor.core.publisher.Mono<MultiValueMap<StringSE,
Part>> Content-Type が"multipart/form-data"
である場合はマルチパートリクエストの部分を返し、そうでない場合は空のマップを返します。<T extends PrincipalSE>
reactor.core.publisher.Mono<T>リクエストに対して認証されたユーザーがいる場合、それを返します。現在の HTTP リクエストを返します。現在の HTTP レスポンスを返します。reactor.core.publisher.Mono<WebSession>
現在のリクエストの Web セッションを返します。boolean
この契約のcheckNotModified
メソッドの 1 つが使用され、true を返した場合、true
を返します。transformUrl
(StringSE url) 登録された変換関数に従って、指定された URL を変換します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE
インターフェース org.springframework.web.server.ServerWebExchange から継承されたメソッド
getAttribute, getAttributeOrDefault, getRequiredAttribute, mutate
コンストラクターの詳細
DefaultServerWebExchange
public DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver) DefaultServerWebExchange
protected DefaultServerWebExchange(ServerHttpRequest request, ServerHttpResponse response, WebSessionManager sessionManager, ServerCodecConfigurer codecConfigurer, LocaleContextResolver localeContextResolver, @Nullable ApplicationContext applicationContext)
メソッドの詳細
getRequest
インターフェースからコピーされた説明:ServerWebExchange
現在の HTTP リクエストを返します。- 次で指定:
- インターフェース
ServerWebExchange
のgetRequest
getResponse
インターフェースからコピーされた説明:ServerWebExchange
現在の HTTP レスポンスを返します。- 次で指定:
- インターフェース
ServerWebExchange
のgetResponse
getAttributes
インターフェースからコピーされた説明:ServerWebExchange
現在の交換のリクエスト属性の可変マップを返します。- 次で指定:
- インターフェース
ServerWebExchange
のgetAttributes
getSession
インターフェースからコピーされた説明:ServerWebExchange
現在のリクエストの Web セッションを返します。クライアントがリクエストしたセッション ID に一致するか、クライアントが指定していないか、基礎となるセッションの有効期限が切れたため、新しいセッション ID でインスタンスを返すことが常に保証されます。このメソッドを使用しても、セッションは自動的に作成されません。詳細については、WebSession
を参照してください。- 次で指定:
- インターフェース
ServerWebExchange
のgetSession
getPrincipal
インターフェースからコピーされた説明:ServerWebExchange
リクエストに対して認証されたユーザーがいる場合、それを返します。- 次で指定:
- インターフェース
ServerWebExchange
のgetPrincipal
getFormData
インターフェースからコピーされた説明:ServerWebExchange
Content-Type が"application/x-www-form-urlencoded"
の場合はリクエストの本文からフォームデータを返し、それ以外の場合は空のマップを返します。注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の
MultiValueMap
がキャッシュされるため、このメソッドを複数回呼び出しても安全です。- 次で指定:
- インターフェース
ServerWebExchange
のgetFormData
getMultipartData
インターフェースからコピーされた説明:ServerWebExchange
Content-Type が"multipart/form-data"
である場合はマルチパートリクエストの部分を返し、そうでない場合は空のマップを返します。注意 : このメソッドを呼び出すと、リクエストの本文が完全に読み取られて解析され、結果の
MultiValueMap
がキャッシュされるため、このメソッドを複数回呼び出しても安全です。注 : 各部分のコンテンツはキャッシュされず、1 回しか読み取ることができません。
- 次で指定:
- インターフェース
ServerWebExchange
のgetMultipartData
cleanupMultipart
インターフェースからコピーされた説明:ServerWebExchange
マルチパート処理に使用されるストレージをクリーンアップします。- 次で指定:
- インターフェース
ServerWebExchange
のcleanupMultipart
- 関連事項:
getLocaleContext
インターフェースからコピーされた説明:ServerWebExchange
設定されたLocaleContextResolver
を使用してLocaleContext
を返します。- 次で指定:
- インターフェース
ServerWebExchange
のgetLocaleContext
getApplicationContext
インターフェースからコピーされた説明:ServerWebExchange
WebHttpHandlerBuilder.applicationContext(ApplicationContext)
で初期化された場合、Web アプリケーションに関連付けられたApplicationContext
を返します。isNotModified
public boolean isNotModified()インターフェースからコピーされた説明:ServerWebExchange
この契約のcheckNotModified
メソッドの 1 つが使用され、true を返した場合、true
を返します。- 次で指定:
- インターフェース
ServerWebExchange
のisNotModified
checkNotModified
インターフェースからコピーされた説明:ServerWebExchange
タイムスタンプが最後に変更されたServerWebExchange.checkNotModified(String, Instant)
のオーバーロードバリアント。- 次で指定:
- インターフェース
ServerWebExchange
のcheckNotModified
- パラメーター:
lastModified
- 最終変更時刻- 戻り値:
- リクエストが変更されていないものとみなされるかどうか
checkNotModified
インターフェースからコピーされた説明:ServerWebExchange
ETag
(エンティティタグ)値のみを持つServerWebExchange.checkNotModified(String, Instant)
のオーバーロードされたバリアント。- 次で指定:
- インターフェース
ServerWebExchange
のcheckNotModified
- パラメーター:
etag
- 基になるリソースのエンティティタグ。- 戻り値:
- リクエストがそれ以上の処理を必要としない場合は true。
checkNotModified
インターフェースからコピーされた説明: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
インターフェースからコピーされた説明:ServerWebExchange
登録された変換関数に従って、指定された URL を変換します。デフォルトでは、このメソッドは指定されたurl
を返しますが、追加の変換関数をServerWebExchange.addUrlTransformer(java.util.function.Function<java.lang.String, java.lang.String>)
に登録できます。- 次で指定:
- インターフェース
ServerWebExchange
のtransformUrl
- パラメーター:
url
- 変換する URL- 戻り値:
- 変換された URL
addUrlTransformer
インターフェースからコピーされた説明:ServerWebExchange
ServerWebExchange.transformUrl(java.lang.String)
で使用する追加の URL 変換関数を登録します。指定された関数を使用して、認証用の ID、CSRF 保護用のノンスなどを挿入できます。指定された関数は、以前に登録された関数の後に適用されます。
- 次で指定:
- インターフェース
ServerWebExchange
のaddUrlTransformer
- パラメーター:
transformer
- 追加する URL 変換関数
getLogPrefix
インターフェースからコピーされた説明:ServerWebExchange
この交換のメッセージを関連付けるために使用するログメッセージプレフィックスを返します。接頭辞は、属性ServerWebExchange.LOG_ID_ATTRIBUTE
の値といくつかの追加の書式に基づいているため、接頭辞を追加して、セパレータを必要としない書式を追加する必要はありません。- 次で指定:
- インターフェース
ServerWebExchange
のgetLogPrefix
- 戻り値:
- ログメッセージのプレフィックス、または
ServerWebExchange.LOG_ID_ATTRIBUTE
が設定されていない場合は空の文字列