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