パッケージ org.springframework.http.server.reactive

インターフェース ServerHttpRequest

すべてのスーパーインターフェース:
HttpMessage、HttpRequest、ReactiveHttpInputMessage
すべての既知の実装クラス:
AbstractServerHttpRequest、MockServerHttpRequest、ServerHttpRequestDecorator
public interface ServerHttpRequest extends HttpRequest, ReactiveHttpInputMessage
リアクティブなサーバー側の HTTP リクエストを表します。
導入:
5.0
作成者:
Arjen Poutsma, Rossen Stoyanchev, Sam Brannen

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

    ネストされたクラス
    修飾子と型
    インターフェース
    説明
    static interface
    ServerHttpRequest.Builder
    既存の ServerHttpRequest を変更するためのビルダー。

  • 方法の概要

    修飾子と型
    メソッド
    説明
    MultiValueMap<StringSE,HttpCookie>
    getCookies()
    クライアントから送信された Cookie の読み取り専用マップを返します。
    StringSE
    getId()
    基礎となる接続（存在する場合）を表す ID、またはログメッセージを相関させるためのリクエストを返します。
    default InetSocketAddressSE
    getLocalAddress()
    リクエストが受け入れられた場合は、ローカルアドレスを返します（利用可能な場合）。
    RequestPath
    getPath()
    query までの完全なリクエストパスの構造化表現を返しますが、query は含まれません。
    MultiValueMap<StringSE,StringSE>
    getQueryParams()
    解析およびデコードされたクエリパラメーター値を含む読み取り専用マップを返します。
    default InetSocketAddressSE
    getRemoteAddress()
    可能な場合、このリクエストが接続されているリモートアドレスを返します。
    default SslInfo
    getSslInfo()
    リクエストが SSL 証明書を含む安全なプロトコルを介して送信された場合、SSL セッション情報を返します（利用可能な場合）。
    default ServerHttpRequest.Builder
    mutate()
    ServerHttpRequestDecorator でラップし、変更された値を返すか、このインスタンスに委譲して返すことにより、このリクエストのプロパティを変更するビルダーを返します。

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

    getHeaders

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

    getAttributes, getMethod, getURI

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

    getBody

  • メソッドの詳細

    • getId

      StringSE getId()
      基礎となる接続（存在する場合）を表す ID、またはログメッセージを相関させるためのリクエストを返します。
      導入:
      5.1
      関連事項:

    • getPath

      RequestPath getPath()
      query までの完全なリクエストパスの構造化表現を返しますが、query は含まれません。

      返されたパスは、RequestPath.contextPath() 部分と残りの pathWithinApplication 部分に細分されます。後者は、パスマッチングの目的で PathPattern のメソッドに渡すことができます。

    • getQueryParams

      MultiValueMap<StringSE,StringSE> getQueryParams()
      解析およびデコードされたクエリパラメーター値を含む読み取り専用マップを返します。

    • getCookies

      MultiValueMap<StringSE,HttpCookie> getCookies()
      クライアントから送信された Cookie の読み取り専用マップを返します。

    • getLocalAddress

      @Nullable default InetSocketAddressSE getLocalAddress()
      リクエストが受け入れられた場合は、ローカルアドレスを返します（利用可能な場合）。
      導入:
      5.2.3

    • getRemoteAddress

      @Nullable default InetSocketAddressSE getRemoteAddress()
      可能な場合、このリクエストが接続されているリモートアドレスを返します。

    • getSslInfo

      @Nullable default SslInfo getSslInfo()
      リクエストが SSL 証明書を含む安全なプロトコルを介して送信された場合、SSL セッション情報を返します（利用可能な場合）。
      戻り値:
      セッション情報、または使用可能なものがない場合は null 
      導入:
      5.0.2

    • mutate

      default ServerHttpRequest.Builder mutate()
      ServerHttpRequestDecorator でラップし、変更された値を返すか、このインスタンスに委譲して返すことにより、このリクエストのプロパティを変更するビルダーを返します。