ServerRequest (Spring Framework 5.2.3.RELEASE API)

```
public interface ServerRequest
```
HandlerFunction で処理されるサーバー側の HTTP リクエストを表します。ヘッダーと本文へのアクセスは、それぞれ ServerRequest.Headers と body(Class) によって提供されます。
導入:
5.2
作成者:
Arjen Poutsma

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

ネストされたクラス
修飾子と型	インターフェースと説明
`static interface`	`ServerRequest.Builder` リクエストのビルダーを定義します。
`static interface`	`ServerRequest.Headers` HTTP リクエストのヘッダーを表します。

メソッドのサマリー

すべてのメソッド静的メソッドインスタンスメソッド抽象メソッドデフォルトメソッド
修飾子と型	メソッドと説明
`default OptionalSE<ObjectSE>`	`attribute(StringSE name)` リクエスト属性値が存在する場合は取得します。
`MapSE<StringSE, ObjectSE>`	`attributes()` リクエスト属性の可変マップを取得します。
`<T> T`	`body(ClassSE<T> bodyType)` ボディを指定された型のオブジェクトとして抽出します。
`<T> T`	`body(ParameterizedTypeReference<T> bodyType)` ボディを指定された型のオブジェクトとして抽出します。
`MultiValueMap<StringSE, CookieEE>`	`cookies()` このリクエストの Cookie を取得します。
`static ServerRequest`	`create(HttpServletRequestEE servletRequest, ListSE<HttpMessageConverter<?>> messageReaders)` 指定された `HttpServletRequest` およびメッセージコンバーターに基づいて新しい `ServerRequest` を作成します。
`static ServerRequest.Builder`	`from(ServerRequest other)` 指定されたリクエストのステータス、ヘッダー、Cookie を使用してビルダーを作成します。
`ServerRequest.Headers`	`headers()` このリクエストのヘッダーを取得します。
`ListSE<HttpMessageConverter<?>>`	`messageConverters()` このリクエストの本文の変換に使用されるリーダーを取得します。
`default HttpMethod`	`method()` HTTP メソッドを取得します。
`StringSE`	`methodName()` HTTP メソッドの名前を取得します。
`default OptionalSE<StringSE>`	`param(StringSE name)` 存在する場合、指定された名前の最初のパラメーターを取得します。
`MultiValueMap<StringSE, StringSE>`	`params()` このリクエストのすべてのパラメーターを取得します。
`default StringSE`	`path()` リクエストパスを取得します。
`default PathContainer`	`pathContainer()` リクエストパスを `PathContainer` として取得します。
`default StringSE`	`pathVariable(StringSE name)` 指定された名前のパス変数があれば、それを取得します。
`MapSE<StringSE, StringSE>`	`pathVariables()` このリクエストのすべてのパス変数を取得します。
`OptionalSE<PrincipalSE>`	`principal()` リクエストに対して認証されたユーザーを取得します（存在する場合）。
`OptionalSE<InetSocketAddressSE>`	`remoteAddress()` 可能な場合、このリクエストが接続されているリモートアドレスを取得します。
`HttpServletRequestEE`	`servletRequest()` このリクエストが基づくサーブレットリクエストを取得します。
`HttpSessionEE`	`session()` このリクエストの Web セッションを取得します。
`URISE`	`uri()` リクエスト URI を取得します。
`UriBuilder`	`uriBuilder()` この `ServerRequest` に関連付けられた URI から `UriBuilderComponents` を取得します。

- メソッドの詳細
  - method
```
@Nullable
default HttpMethod method()
```
    HTTP メソッドを取得します。
    戻り値:
    HttpMethod 列挙値としての HTTP メソッド、または解決できない場合は null (たとえば非標準の HTTP メソッドの場合)
  - methodName
```
StringSE methodName()
```
    HTTP メソッドの名前を取得します。
    戻り値:
    文字列としての HTTP メソッド
  - uri
```
URISE uri()
```
    リクエスト URI を取得します。
  - uriBuilder
```
UriBuilder uriBuilder()
```
    この ServerRequest に関連付けられた URI から UriBuilderComponents を取得します。
    戻り値:
    URI ビルダー
  - path
```
default StringSE path()
```
    リクエストパスを取得します。
  - pathContainer
```
default PathContainer pathContainer()
```
    リクエストパスを PathContainer として取得します。
  - headers
```
ServerRequest.Headers headers()
```
    このリクエストのヘッダーを取得します。
  - cookies
```
MultiValueMap<StringSE,CookieEE> cookies()
```
    このリクエストの Cookie を取得します。
  - remoteAddress
```
OptionalSE<InetSocketAddressSE> remoteAddress()
```
    可能な場合、このリクエストが接続されているリモートアドレスを取得します。
  - messageConverters
```
ListSE<HttpMessageConverter<?>> messageConverters()
```
    このリクエストの本文の変換に使用されるリーダーを取得します。
  - body
```
<T> T body(ClassSE<T> bodyType)
    throws ServletExceptionEE,
           IOExceptionSE
```
    ボディを指定された型のオブジェクトとして抽出します。
    型パラメーター:
    T - ボディ型
    パラメーター:
    bodyType - 戻り値の型
    戻り値:
    体
    例外:
    ServletExceptionEE
    IOExceptionSE
  - body
```
<T> T body(ParameterizedTypeReference<T> bodyType)
    throws ServletExceptionEE,
           IOExceptionSE
```
    ボディを指定された型のオブジェクトとして抽出します。
    型パラメーター:
    T - ボディ型
    パラメーター:
    bodyType - 戻り値の型
    戻り値:
    体
    例外:
    ServletExceptionEE
    IOExceptionSE
  - attribute
```
default OptionalSE<ObjectSE> attribute(StringSE name)
```
    リクエスト属性値が存在する場合は取得します。
    パラメーター:
    name - 属性名
    戻り値:
    属性値
  - attributes
```
MapSE<StringSE,ObjectSE> attributes()
```
    リクエスト属性の可変マップを取得します。
    戻り値:
    リクエスト属性
  - param
```
default OptionalSE<StringSE> param(StringSE name)
```
    存在する場合、指定された名前の最初のパラメーターを取得します。サーブレットパラメーターは、クエリ文字列または投稿されたフォームデータに含まれます。
    パラメーター:
    name - パラメーター名
    戻り値:
    パラメーター値
    関連事項:
    ServletRequest.getParameter(String)EE
  - params
```
MultiValueMap<StringSE,StringSE> params()
```
    このリクエストのすべてのパラメーターを取得します。サーブレットパラメーターは、クエリ文字列または投稿されたフォームデータに含まれます。
    関連事項:
    ServletRequest.getParameterMap()EE
  - pathVariable
```
default StringSE pathVariable(StringSE name)
```
    指定された名前のパス変数があれば、それを取得します。
    パラメーター:
    name - 変数名
    戻り値:
    変数値
    例外:
    IllegalArgumentExceptionSE - 指定された名前のパス変数がない場合
  - pathVariables
```
MapSE<StringSE,StringSE> pathVariables()
```
    このリクエストのすべてのパス変数を取得します。
  - session
```
HttpSessionEE session()
```
    このリクエストの Web セッションを取得します。クライアントからリクエストされたセッション ID に一致するインスタンス、またはクライアントがインスタンスを指定しなかったため、または基になるセッションが期限切れになったために新しいセッション ID でインスタンスを返すことが常に保証されています。このメソッドを使用しても、セッションは自動的には作成されません。
  - principal
```
OptionalSE<PrincipalSE> principal()
```
    リクエストに対して認証されたユーザーを取得します（存在する場合）。
  - servletRequest
```
HttpServletRequestEE servletRequest()
```
    このリクエストが基づくサーブレットリクエストを取得します。
  - create
```
static ServerRequest create(HttpServletRequestEE servletRequest,
                            ListSE<HttpMessageConverter<?>> messageReaders)
```
    指定された HttpServletRequest およびメッセージコンバーターに基づいて新しい ServerRequest を作成します。
    パラメーター:
    servletRequest - リクエスト
    messageReaders - メッセージリーダー
    戻り値:
    作成された ServerRequest
  - from
```
static ServerRequest.Builder from(ServerRequest other)
```
    指定されたリクエストのステータス、ヘッダー、Cookie を使用してビルダーを作成します。
    パラメーター:
    other - ステータス、ヘッダー、Cookie をコピーするレスポンス
    戻り値:
    作成されたビルダー

インターフェース ServerRequest

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

メソッドのサマリー

メソッドの詳細

method

methodName

uri

uriBuilder

path

pathContainer

headers

cookies

remoteAddress

messageConverters

body

body

attribute

attributes

param

params

pathVariable

pathVariables

session

principal

servletRequest

create

from