クラス AbstractServerHttpRequest
java.lang.ObjectSE
org.springframework.http.server.reactive.AbstractServerHttpRequest
- 実装されているすべてのインターフェース:
HttpMessage、HttpRequest、ReactiveHttpInputMessage、ServerHttpRequest
- 既知の直属サブクラス
MockServerHttpRequest
ServerHttpRequest 実装の共通基本クラス。- 導入:
- 5.0
- 作成者:
- Rossen Stoyanchev
ネストされたクラスの要約
インターフェース org.springframework.http.server.reactive.ServerHttpRequest から継承されたネストクラス / インターフェース
ServerHttpRequest.Builderコンストラクターの概要
コンストラクターコンストラクター説明AbstractServerHttpRequest(URISE uri, StringSE contextPath, HttpHeaders headers) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。AbstractServerHttpRequest(URISE uri, StringSE contextPath, MultiValueMap<StringSE, StringSE> headers) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。AbstractServerHttpRequest(HttpMethod method, URISE uri, StringSE contextPath, MultiValueMap<StringSE, StringSE> headers) リクエストのメソッド、URI、ヘッダーを持つコンストラクター。メソッドのサマリー
修飾子と型メソッド説明クライアントから送信された Cookie の読み取り専用マップを返します。このメッセージのヘッダーを返します。getId()基礎となる接続(存在する場合)を表す ID、またはログメッセージを相関させるためのリクエストを返します。リクエストの HTTP メソッドを返します。abstract <T> T基礎となるサーバーのレスポンスを返します。getPath()解析およびデコードされたクエリパラメーター値を含む読み取り専用マップを返します。リクエストが SSL 証明書を含む安全なプロトコルを介して送信された場合、SSL セッション情報を返します(利用可能な場合)。getURI()リクエストの URI を返します(もしあればクエリ文字列を含みますが、URI 表現のために整形式である場合のみ)。protected abstract MultiValueMap<StringSE,HttpCookie> 基になる「ネイティブ」リクエストから Cookie を取得し、HttpCookieマップに適合させます。protected StringSEinitId()使用するリクエスト ID を取得するか、nullを取得します。この場合、このリクエストインスタンスのオブジェクト ID が使用されます。protected StringSEサブクラスはこれをオーバーライドして、ログメッセージに使用するプレフィックスを提供できます。protected MultiValueMap<StringSE,StringSE> クエリを名前と値のペアに解析する方法。protected abstract SslInfo基になる「ネイティブ」リクエストから SSL セッション情報を取得します。クラス java.lang.ObjectSE から継承されたメソッド
clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSEインターフェース org.springframework.http.HttpRequest から継承されたメソッド
getMethodValueインターフェース org.springframework.http.ReactiveHttpInputMessage から継承されたメソッド
getBodyインターフェース org.springframework.http.server.reactive.ServerHttpRequest から継承されたメソッド
getLocalAddress, getRemoteAddress, mutate
コンストラクターの詳細
AbstractServerHttpRequest
@DeprecatedSE(since="6.0.8", forRemoval=true) public AbstractServerHttpRequest(URISE uri, @Nullable StringSE contextPath, MultiValueMap<StringSE, StringSE> headers) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。リクエストの URI とヘッダーを持つコンストラクター。- パラメーター:
uri- リクエストの URIcontextPath- リクエストのコンテキストパスheaders- リクエストのヘッダー (MultiValueMapとして)- 導入:
- 5.3
AbstractServerHttpRequest
public AbstractServerHttpRequest(HttpMethod method, URISE uri, @Nullable StringSE contextPath, MultiValueMap<StringSE, StringSE> headers) リクエストのメソッド、URI、ヘッダーを持つコンストラクター。- パラメーター:
method- リクエストの HTTP メソッドuri- リクエストの URIcontextPath- リクエストのコンテキストパスheaders- リクエストのヘッダー (MultiValueMapとして)- 導入:
- 6.0.8
AbstractServerHttpRequest
@DeprecatedSE(since="6.0.8", forRemoval=true) public AbstractServerHttpRequest(URISE uri, @Nullable StringSE contextPath, HttpHeaders headers) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。リクエストの URI とヘッダーを持つコンストラクター。- パラメーター:
uri- リクエストの URIcontextPath- リクエストのコンテキストパスheaders- リクエストのヘッダー (HttpHeadersとして)
メソッドの詳細
getId
インターフェースからコピーされた説明:ServerHttpRequest基礎となる接続(存在する場合)を表す ID、またはログメッセージを相関させるためのリクエストを返します。- 次で指定:
- インターフェース
ServerHttpRequestのgetId - 関連事項:
initId
使用するリクエスト ID を取得するか、nullを取得します。この場合、このリクエストインスタンスのオブジェクト ID が使用されます。- 導入:
- 5.1
getMethod
インターフェースからコピーされた説明:HttpRequestリクエストの HTTP メソッドを返します。- 次で指定:
- インターフェース
HttpRequestのgetMethod - 戻り値:
- HttpMethod 値としての HTTP メソッド
- 関連事項:
getURI
インターフェースからコピーされた説明:HttpRequestリクエストの URI を返します(もしあればクエリ文字列を含みますが、URI 表現のために整形式である場合のみ)。- 次で指定:
- インターフェース
HttpRequestのgetURI - 戻り値:
- リクエストの URI (非
null)
getPath
インターフェースからコピーされた説明:ServerHttpRequestqueryまでの完全なリクエストパスの構造化表現を返しますが、queryは含まれません。返されたパスは、
RequestPath.contextPath()部分と残りのpathWithinApplication部分に細分されます。後者は、パスマッチングの目的でPathPatternのメソッドに渡すことができます。- 次で指定:
- インターフェース
ServerHttpRequestのgetPath
getHeaders
インターフェースからコピーされた説明:HttpMessageこのメッセージのヘッダーを返します。- 次で指定:
- インターフェース
HttpMessageのgetHeaders - 戻り値:
- 対応する HttpHeaders オブジェクト (非
null)
getQueryParams
インターフェースからコピーされた説明:ServerHttpRequest解析およびデコードされたクエリパラメーター値を含む読み取り専用マップを返します。- 次で指定:
- インターフェース
ServerHttpRequestのgetQueryParams
initQueryParams
クエリを名前と値のペアに解析する方法。戻り値は不変のマップに変換され、キャッシュされます。このメソッドは、
getQueryParams()への最初のアクセス時に遅延して呼び出されることに注意してください。呼び出しは同期されませんが、それでも解析はスレッドセーフです。getCookies
インターフェースからコピーされた説明:ServerHttpRequestクライアントから送信された Cookie の読み取り専用マップを返します。- 次で指定:
- インターフェース
ServerHttpRequestのgetCookies
initCookies
基になる「ネイティブ」リクエストから Cookie を取得し、HttpCookieマップに適合させます。戻り値は不変のマップに変換され、キャッシュされます。このメソッドは、
getCookies()へのアクセス時に遅延して呼び出されることに注意してください。基になる「ネイティブ」リクエストが Cookie データへのスレッドセーフなアクセスを提供しない場合、サブクラスは Cookie の初期化を同期する必要があります。getSslInfo
インターフェースからコピーされた説明:ServerHttpRequestリクエストが SSL 証明書を含む安全なプロトコルを介して送信された場合、SSL セッション情報を返します(利用可能な場合)。- 次で指定:
- インターフェース
ServerHttpRequestのgetSslInfo - 戻り値:
- セッション情報、または使用可能なものがない場合は
null
initSslInfo
基になる「ネイティブ」リクエストから SSL セッション情報を取得します。- 戻り値:
- セッション情報、または使用可能なものがない場合は
null - 導入:
- 5.0.2
getNativeRequest
public abstract <T> T getNativeRequest()基礎となるサーバーのレスポンスを返します。注意 : これは主に、spring-webflux モジュールでの WebSocket アップグレードなどの内部フレームワークの使用のために公開されています。
initLogPrefix
サブクラスはこれをオーバーライドして、ログメッセージに使用するプレフィックスを提供できます。デフォルトでは、これは
getId()です。- 導入:
- 5.3.15
AbstractServerHttpRequest(HttpMethod, URI, String, MultiValueMap)を推奨