クラス MockHttpServletRequestBuilder
- 実装されたすべてのインターフェース:
Mergeable
、ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>
、RequestBuilder
、SmartRequestBuilder
- 既知の直属サブクラス
MockMultipartHttpServletRequestBuilder
MockHttpServletRequest
のデフォルトビルダーは、MockMvc
でリクエストを実行するための入力として必要です。 通常、アプリケーションテストは、MockMvcRequestBuilders
の静的ファクトリメソッドを介してこのビルダーにアクセスします。
このクラスは拡張用に開かれていません。作成された MockHttpServletRequest
にカスタム初期化を適用するには、with(RequestPostProcessor)
拡張ポイントを使用してください。
- 導入:
- 3.2
- 作成者:
- Rossen Stoyanchev, Juergen Hoeller, Arjen Poutsma, Sam Brannen, Kamill Sokol
方法の概要
修飾子と型メソッド説明生の文字列値を使用してAccept
ヘッダーを設定しますが、(テスト目的で)整形式ではない可能性があります。'Accept' ヘッダーを指定されたメディア型に設定します。characterEncoding
(StringSE encoding) リクエストの文字エンコーディングを設定します。characterEncoding
(CharsetSE encoding) リクエストの文字エンコーディングを設定します。content
(byte[] content) リクエスト本文を設定します。リクエストの本文を UTF-8 文字列として設定します。contentType
(StringSE contentType) リクエストの "Content-Type" ヘッダーを生の文字列値として設定します。これは、(テスト目的で)整形式ではない可能性があります。contentType
(MediaType contentType) リクエストの "Content-Type" ヘッダーを設定します。contextPath
(StringSE contextPath) コンテキストパスを表す requestURI の部分を指定します。指定された Cookie をリクエストに追加します。「入力」フラッシュ属性を設定します。flashAttrs
(MapSE<StringSE, ObjectSE> flashAttributes) フラッシュ属性を設定します。指定された値を指定されたフォームフィールドに追加し、リクエストパラメーターマップにも追加します。formFields
(MultiValueMap<StringSE, StringSE> formFields) リクエストにヘッダーを追加します。headers
(HttpHeaders httpHeaders) すべてのヘッダーをリクエストに追加します。リクエストのロケールを設定し、以前のロケールを上書きします。指定されたロケールを優先リクエストロケールとして追加します。リクエストパラメーターをMockHttpServletRequest.getParameterMap()
に追加します。params
(MultiValueMap<StringSE, StringSE> params) pathInfo を表す requestURI の部分を指定します。principal
(PrincipalSE principal) リクエストのプリンシパルを設定します。queryParam
(StringSE name, StringSE... values) クエリ文字列に追加し、request parameters
マップにも追加します。queryParams
(MultiValueMap<StringSE, StringSE> params) クエリ文字列に追加し、request parameters
マップにも追加します。remoteAddress
(StringSE remoteAddress) リクエストのリモートアドレスを設定します。requestAttr
(StringSE name, ObjectSE value) リクエスト属性を設定します。secure
(boolean secure) HTTPS などのセキュアチャネルの使用を示すServletRequest
EE のセキュアプロパティを設定します。servletPath
(StringSE servletPath) サーブレットがマップされるパスを表す requestURI の部分を指定します。session
(MockHttpSession session) 使用する HTTP セッションを設定します。リクエスト間で再利用される場合があります。sessionAttr
(StringSE name, ObjectSE value) セッション属性を設定します。sessionAttrs
(MapSE<StringSE, ObjectSE> sessionAttributes) セッション属性を設定します。URI テンプレートと URI 変数を使用して、リクエストの URI を指定します。完全に構築された絶対URI
SE を使用して URI を指定します。with
(RequestPostProcessor postProcessor) MockHttpServletRequestBuilder
に直接組み込まれていない方法でMockHttpServletRequest
をさらに初期化するための拡張ポイント。クラス org.springframework.test.web.servlet.request.AbstractMockHttpServletRequestBuilder から継承されたメソッド
buildRequest, createServletRequest, isMergeEnabled, merge, postProcessRequest, self
メソッドの詳細
uri
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
完全に構築された絶対URI
SE を使用して URI を指定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のuri
uri
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
URI テンプレートと URI 変数を使用して、リクエストの URI を指定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のuri
contextPath
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
コンテキストパスを表す requestURI の部分を指定します。コンテキストパスを指定する場合、リクエスト URI の先頭に一致する必要があります。ほとんどの場合、requestURI からコンテキストパスを省略することでテストを作成できます。これは、ほとんどのアプリケーションが実際にデプロイされている名前に依存しないためです。ここで指定する場合、コンテキストパスは "/" で始まる必要があり、"/" で終わることはできません。
servletPath
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
サーブレットがマップされるパスを表す requestURI の部分を指定します。これは通常、コンテキストパスの後の requestURI の一部です。ほとんどの場合、テストは requestURI からサーブレットパスを省略して記述できます。これは、ほとんどのアプリケーションがサーブレットがマップされるプレフィックスに実際には依存しないためです。たとえば、サーブレットが
"/main/*"
にマップされている場合、テストは requestURI"/main/accounts/1"
ではなく"/accounts/1"
を使用して記述できます。ここで指定する場合、servletPath は "/" で始まる必要があり、"/" で終わってはなりません。pathInfo
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
pathInfo を表す requestURI の部分を指定します。指定しない場合 (推奨)、requestURI から contextPath と servletPath を削除し、残りの部分を使用して、pathInfo が自動的に導出されます。ここで指定する場合、pathInfo は "/" で始まる必要があります。
指定した場合は、pathInfo がそのまま使用されます。
secure
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
HTTPS などのセキュアチャネルの使用を示すServletRequest
EE のセキュアプロパティを設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のsecure
- パラメーター:
secure
- リクエストが安全なチャネルを使用しているかどうか
characterEncoding
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストの文字エンコーディングを設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcharacterEncoding
- パラメーター:
encoding
- 文字エンコーディング- 関連事項:
characterEncoding
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストの文字エンコーディングを設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcharacterEncoding
- パラメーター:
encoding
- 文字エンコーディング
content
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエスト本文を設定します。コンテンツが提供され、
AbstractMockHttpServletRequestBuilder.contentType(MediaType)
がapplication/x-www-form-urlencoded
に設定されている場合、コンテンツは解析されて、request parameters
マップを作成するために使用されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcontent
- パラメーター:
content
- ボディコンテンツ
content
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストの本文を UTF-8 文字列として設定します。コンテンツが提供され、
AbstractMockHttpServletRequestBuilder.contentType(MediaType)
がapplication/x-www-form-urlencoded
に設定されている場合、コンテンツは解析されて、request parameters
マップを作成するために使用されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcontent
- パラメーター:
content
- ボディコンテンツ
contentType
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストの "Content-Type" ヘッダーを設定します。コンテンツが提供され、
contentType
がapplication/x-www-form-urlencoded
に設定されている場合、コンテンツは解析され、request parameters
マップを作成するために使用されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcontentType
- パラメーター:
contentType
- コンテンツ型
contentType
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストの "Content-Type" ヘッダーを生の文字列値として設定します。これは、(テスト目的で)整形式ではない可能性があります。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcontentType
- パラメーター:
contentType
- コンテンツ型
accept
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
'Accept' ヘッダーを指定されたメディア型に設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のaccept
- パラメーター:
mediaTypes
- 1 つ以上のメディア型
accept
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
生の文字列値を使用してAccept
ヘッダーを設定しますが、(テスト目的で)整形式ではない可能性があります。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のaccept
- パラメーター:
mediaTypes
- 1 つ以上のメディア型。カンマ区切りの文字列として内部的に結合されます
header
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストにヘッダーを追加します。値は常に追加されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のheader
- パラメーター:
name
- ヘッダー名values
- 1 つ以上のヘッダー値
headers
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
すべてのヘッダーをリクエストに追加します。値は常に追加されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のheaders
- パラメーター:
httpHeaders
- 追加するヘッダーと値
param
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストパラメーターをMockHttpServletRequest.getParameterMap()
に追加します。Servlet API では、リクエスト文字列および / または
application/x-www-form-urlencoded
リクエストのボディからリクエストパラメーターを解析できます。このメソッドは、リクエストパラメーターマップに追加するだけです。次のいずれかを使用してクエリまたはフォームデータを指定することにより、サーブレットリクエストパラメーターの追加を使用することもできます。MockMvcRequestBuilders
へのクエリを含む URL を指定します。AbstractMockHttpServletRequestBuilder.queryParam(java.lang.String, java.lang.String...)
またはAbstractMockHttpServletRequestBuilder.queryParams
を介してクエリパラメーターを追加します。AbstractMockHttpServletRequestBuilder.content
にAbstractMockHttpServletRequestBuilder.contentType
application/x-www-form-urlencoded
を提供します。
- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のparam
- パラメーター:
name
- パラメーター名values
- 1 つ以上の値
params
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のparams
- パラメーター:
params
- 追加するパラメーター
queryParam
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
クエリ文字列に追加し、request parameters
マップにも追加します。パラメーター名と値は、クエリ文字列に追加されるときにエンコードされます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のqueryParam
- パラメーター:
name
- パラメーター名values
- 1 つ以上の値
queryParams
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
クエリ文字列に追加し、request parameters
マップにも追加します。パラメーター名と値は、クエリ文字列に追加されるときにエンコードされます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のqueryParams
- パラメーター:
params
- 追加するパラメーター
formField
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
指定された値を指定されたフォームフィールドに追加し、リクエストパラメーターマップにも追加します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のformField
- パラメーター:
name
- フィールド名values
- 1 つ以上の値
formFields
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のformFields
- パラメーター:
formFields
- 追加するフォームフィールド
cookie
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
指定された Cookie をリクエストに追加します。Cookie は常に追加されます。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のcookie
- パラメーター:
cookies
- 追加するクッキー
locale
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
指定されたロケールを優先リクエストロケールとして追加します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のlocale
- パラメーター:
locales
- 追加するロケール- 関連事項:
locale
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストのロケールを設定し、以前のロケールを上書きします。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のlocale
- パラメーター:
locale
- ロケール、またはそれをリセットするnull
- 関連事項:
requestAttr
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエスト属性を設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のrequestAttr
- パラメーター:
name
- 属性名value
- 属性値
sessionAttr
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
セッション属性を設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のsessionAttr
- パラメーター:
name
- セッション属性名value
- セッション属性値
sessionAttrs
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
セッション属性を設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のsessionAttrs
- パラメーター:
sessionAttributes
- セッション属性
flashAttr
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
「入力」フラッシュ属性を設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のflashAttr
- パラメーター:
name
- フラッシュ属性名value
- フラッシュ属性値
flashAttrs
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
フラッシュ属性を設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のflashAttrs
- パラメーター:
flashAttributes
- フラッシュ属性
session
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
使用する HTTP セッションを設定します。リクエスト間で再利用される場合があります。AbstractMockHttpServletRequestBuilder.sessionAttr(String, Object)
を介して提供される個々の属性は、ここで提供されるセッションのコンテンツをオーバーライドします。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のsession
- パラメーター:
session
- HTTP セッション
principal
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストのプリンシパルを設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のprincipal
- パラメーター:
principal
- 校長
remoteAddress
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
リクエストのリモートアドレスを設定します。- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のremoteAddress
- パラメーター:
remoteAddress
- リモートアドレス (IP)
with
クラスからコピーされた説明:AbstractMockHttpServletRequestBuilder
MockHttpServletRequestBuilder
に直接組み込まれていない方法でMockHttpServletRequest
をさらに初期化するための拡張ポイント。このインターフェースの実装には、ビルダースタイルのメソッド自体を含めることができ、静的ファクトリメソッドを介してアクセス可能にすることができます。- 次で指定:
- インターフェース
ConfigurableSmartRequestBuilder<MockHttpServletRequestBuilder>
のwith
- オーバーライド:
- クラス
AbstractMockHttpServletRequestBuilder<MockHttpServletRequestBuilder>
のwith
- パラメーター:
postProcessor
- 追加するポストプロセッサー