クラス AbstractMockHttpServletRequestBuilder<B extends AbstractMockHttpServletRequestBuilder<B>>

メソッドの詳細

• self

  protected B self()

• uri

  public B uri(URISE uri)

  完全に構築された絶対 URISE を使用して URI を指定します。

• uri

  public B uri(StringSE uriTemplate, @Nullable ObjectSE... uriVariables)

  URI テンプレートと URI 変数を使用して、リクエストの URI を指定します。

• contextPath

  public B contextPath(StringSE contextPath)

  コンテキストパスを表す requestURI の部分を指定します。コンテキストパスを指定する場合、リクエスト URI の先頭に一致する必要があります。

  ほとんどの場合、requestURI からコンテキストパスを省略することでテストを作成できます。これは、ほとんどのアプリケーションが実際にデプロイされている名前に依存しないためです。ここで指定する場合、コンテキストパスは "/" で始まる必要があり、"/" で終わることはできません。

  関連事項:

  • HttpServletRequest.getContextPath()

• servletPath

  public B servletPath(StringSE servletPath)

  サーブレットがマップされるパスを表す requestURI の部分を指定します。これは通常、コンテキストパスの後の requestURI の一部です。

  ほとんどの場合、テストは requestURI からサーブレットパスを省略して記述できます。これは、ほとんどのアプリケーションがサーブレットがマップされるプレフィックスに実際には依存しないためです。たとえば、サーブレットが "/main/*" にマップされている場合、テストは requestURI "/main/accounts/1" ではなく "/accounts/1" を使用して記述できます。ここで指定する場合、servletPath は "/" で始まる必要があり、"/" で終わってはなりません。

  関連事項:

  • HttpServletRequest.getServletPath()

• pathInfo

  public B pathInfo(@Nullable StringSE pathInfo)

  pathInfo を表す requestURI の部分を指定します。

  指定しない場合 (推奨)、requestURI から contextPath と servletPath を削除し、残りの部分を使用して、pathInfo が自動的に導出されます。ここで指定する場合、pathInfo は "/" で始まる必要があります。

  指定した場合は、pathInfo がそのまま使用されます。

  関連事項:

  • HttpServletRequest.getPathInfo()

• secure

  public B secure(boolean secure)

  HTTPS などの安全なチャネルの使用を示す ServletRequest の secure プロパティを設定します。

  パラメーター:

  secure - リクエストが安全なチャネルを使用しているかどうか

• characterEncoding

  public B characterEncoding(CharsetSE encoding)

  リクエストの文字エンコーディングを設定します。

  パラメーター:

  encoding - 文字エンコーディング

  導入:

  5.3.10

  関連事項:

  • StandardCharsetsSE
  • characterEncoding(String)

• characterEncoding

  public B characterEncoding(StringSE encoding)

  リクエストの文字エンコーディングを設定します。

  パラメーター:

  encoding - 文字エンコーディング

• content

  public B content(byte[] content)

  リクエスト本文を設定します。

  コンテンツが提供され、contentType(MediaType) が application/x-www-form-urlencoded に設定されている場合、コンテンツは解析されて、request parameters マップを作成するために使用されます。

  パラメーター:

  content - ボディコンテンツ

• content

  public B content(StringSE content)

  リクエストの本文を UTF-8 文字列として設定します。

  コンテンツが提供され、contentType(MediaType) が application/x-www-form-urlencoded に設定されている場合、コンテンツは解析されて、request parameters マップを作成するために使用されます。

  パラメーター:

  content - ボディコンテンツ

• contentType

  public B contentType(MediaType contentType)

  リクエストの "Content-Type" ヘッダーを設定します。

  コンテンツが提供され、contentType が application/x-www-form-urlencoded に設定されている場合、コンテンツは解析され、request parameters マップを作成するために使用されます。

  パラメーター:

  contentType - コンテンツ型

• contentType

  public B contentType(StringSE contentType)

  リクエストの "Content-Type" ヘッダーを生の文字列値として設定します。これは、（テスト目的で）整形式ではない可能性があります。

  パラメーター:

  contentType - コンテンツ型

  導入:

  4.1.2

• accept

  public B accept(MediaType... mediaTypes)

  'Accept' ヘッダーを指定されたメディア型に設定します。

  パラメーター:

  mediaTypes - 1 つ以上のメディア型

• accept

  public B accept(StringSE... mediaTypes)

  生の文字列値を使用して Accept ヘッダーを設定しますが、（テスト目的で）整形式ではない可能性があります。

  パラメーター:

  mediaTypes - 1 つ以上のメディア型。カンマ区切りの文字列として内部的に結合されます

• acceptCharset

  public B acceptCharset(CharsetSE... acceptableCharsets)

  Accept-Charset ヘッダーで指定されているように、受け入れ可能な文字SEセットのリストを設定します。

  パラメーター:

  acceptableCharsets - 許容される文字セット

  導入:

  7.0

• ifModifiedSince

  public B ifModifiedSince(ZonedDateTimeSE ifModifiedSince)

  If-Modified-Since ヘッダーの値を設定します。

  パラメーター:

  ifModifiedSince - ヘッダーの新しい値

  導入:

  7.0

• ifNoneMatch

  public B ifNoneMatch(StringSE... ifNoneMatches)

  If-None-Match ヘッダーの値を設定します。

  パラメーター:

  ifNoneMatches - ヘッダーの新しい値

  導入:

  7.0

• header

  public B header(StringSE name, ObjectSE... values)

  リクエストにヘッダーを追加します。値は常に追加されます。

  パラメーター:

  name - ヘッダー名

  values - 1 つ以上のヘッダー値

• headers

  public B headers(HttpHeaders httpHeaders)

  すべてのヘッダーをリクエストに追加します。値は常に追加されます。

  パラメーター:

  httpHeaders - 追加するヘッダーと値

• headers

  public B headers(ConsumerSE<HttpHeaders> headersConsumer)

  これまでに宣言されたすべてのヘッダーへのアクセスを提供し、値を追加、置換、削除できます。

  パラメーター:

  headersConsumer - アクセスを提供するコンシューマー

  戻り値:

  このビルダー

  導入:

  7.0

• param

  public B param(StringSE name, StringSE... values)

  リクエストパラメーターを MockHttpServletRequest.getParameterMap() に追加します。

  Servlet API では、リクエスト文字列および / または application/x-www-form-urlencoded リクエストのボディからリクエストパラメーターを解析できます。このメソッドは、リクエストパラメーターマップに追加するだけです。次のいずれかを使用してクエリまたはフォームデータを指定することにより、サーブレットリクエストパラメーターの追加を使用することもできます。

  • MockMvcRequestBuilders へのクエリを含む URL を指定します。
  • queryParam(String, String...) または queryParams を介してクエリパラメーターを追加します。
  • content に contentType application/x-www-form-urlencoded を提供します。

  パラメーター:

  name - パラメーター名

  values - 1 つ以上の値

• params

  public B params(MultiValueMap<StringSE,StringSE> params)

  MultiValueMap を使用した param(String, String...) のバリアント。

  パラメーター:

  params - 追加するパラメーター

  導入:

  4.2.4

• queryParam

  public B queryParam(StringSE name, StringSE... values)

  クエリ文字列に追加し、request parameters マップにも追加します。パラメーター名と値は、クエリ文字列に追加されるときにエンコードされます。

  パラメーター:

  name - パラメーター名

  values - 1 つ以上の値

  導入:

  5.2.2

• queryParams

  public B queryParams(MultiValueMap<StringSE,StringSE> params)

  クエリ文字列に追加し、request parameters マップにも追加します。パラメーター名と値は、クエリ文字列に追加されるときにエンコードされます。

  パラメーター:

  params - 追加するパラメーター

  導入:

  5.2.2

• formField

  public B formField(StringSE name, StringSE... values)

  指定された値を指定されたフォームフィールドに追加し、リクエストパラメーターマップにも追加します。

  パラメーター:

  name - フィールド名

  values - 1 つ以上の値

  導入:

  6.1.7

• formFields

  public B formFields(MultiValueMap<StringSE,StringSE> formFields)

  MultiValueMap を使用した formField(String, String...) のバリアント。

  パラメーター:

  formFields - 追加するフォームフィールド

  導入:

  6.1.7

• cookie

  public B cookie(jakarta.servlet.http.Cookie... cookies)

  指定された Cookie をリクエストに追加します。Cookie は常に追加されます。

  パラメーター:

  cookies - 追加するクッキー

• locale

  public B locale(LocaleSE... locales)

  指定されたロケールを優先リクエストロケールとして追加します。

  パラメーター:

  locales - 追加するロケール

  導入:

  4.3.6

  関連事項:

  • locale(Locale)

• locale

  public B locale(@Nullable LocaleSE locale)

  リクエストのロケールを設定し、以前のロケールを上書きします。

  パラメーター:

  locale - ロケール、またはそれをリセットする null 

  関連事項:

  • locale(Locale...)

• apiVersion

  public B apiVersion(ObjectSE version)

  リクエストの API バージョンを設定します。バージョンは configured ApiVersionInserter によってリクエストに挿入されます。

  パラメーター:

  version - リクエストの API バージョン。これは、文字列、または ApiVersionFormatter などを使用して挿入子でフォーマットできるオブジェクトになります。

  導入:

  7.0

• apiVersionInserter

  public B apiVersionInserter(@Nullable ApiVersionInserter versionInserter)

  ApiVersionInserter を設定することで、apiVersion(Object) で指定された API バージョンがリクエストに挿入される方法を抽象化できます。挿入子は通常、ConfigurableMockMvcBuilder.defaultRequest(RequestBuilder) または ConfigurableMockMvcBuilder.apiVersionInserter(ApiVersionInserter) を介して（より集中的に）一度だけ設定されます。

  ApiVersionInserter は、いくつかの組み込みインサータ実装型に対してショートカットメソッドを公開しています。選択肢のリストについては、ApiVersionInserter のクラスレベルの Javadoc を参照してください。

  パラメーター:

  versionInserter - 使用するインサーター

  導入:

  7.0

• requestAttr

  public B requestAttr(StringSE name, ObjectSE value)

  リクエスト属性を設定します。

  パラメーター:

  name - 属性名

  value - 属性値

• sessionAttr

  public B sessionAttr(StringSE name, ObjectSE value)

  セッション属性を設定します。

  パラメーター:

  name - セッション属性名

  value - セッション属性値

• sessionAttrs

  public B sessionAttrs(MapSE<StringSE,ObjectSE> sessionAttributes)

  セッション属性を設定します。

  パラメーター:

  sessionAttributes - セッション属性

• flashAttr

  public B flashAttr(StringSE name, ObjectSE value)

  「入力」フラッシュ属性を設定します。

  パラメーター:

  name - フラッシュ属性名

  value - フラッシュ属性値

• flashAttrs

  public B flashAttrs(MapSE<StringSE,ObjectSE> flashAttributes)

  フラッシュ属性を設定します。

  パラメーター:

  flashAttributes - フラッシュ属性

• session

  public B session(MockHttpSession session)

  使用する HTTP セッションを設定します。リクエスト間で再利用される場合があります。

  sessionAttr(String, Object) を介して提供される個々の属性は、ここで提供されるセッションのコンテンツをオーバーライドします。

  パラメーター:

  session - HTTP セッション

• principal

  public B principal(PrincipalSE principal)

  リクエストのプリンシパルを設定します。

  パラメーター:

  principal - 校長

• remoteAddress

  public B remoteAddress(StringSE remoteAddress)

  リクエストのリモートアドレスを設定します。

  パラメーター:

  remoteAddress - リモートアドレス (IP)

  導入:

  6.0.10

• with

  public B with(RequestPostProcessor postProcessor)

  MockHttpServletRequestBuilder に直接組み込まれていない方法で MockHttpServletRequest をさらに初期化するための拡張ポイント。このインターフェースの実装には、ビルダースタイルのメソッド自体を含めることができ、静的ファクトリメソッドを介してアクセス可能にすることができます。

  次で指定:

  インターフェース ConfigurableSmartRequestBuilder<B extends AbstractMockHttpServletRequestBuilder<B>> の with 

  パラメーター:

  postProcessor - 追加するポストプロセッサー

• isMergeEnabled

  public boolean isMergeEnabled()

  この特定のインスタンスに対してマージが有効になっていますか？

  次で指定:

  インターフェース Mergeable の isMergeEnabled 

  戻り値:

  常に true を返します。

• merge

  public ObjectSE merge(@Nullable ObjectSE parent)

  "this" インスタンスにまだ設定されていない場合にのみ、値を受け入れる「親」RequestBuilder のプロパティをマージします。

  次で指定:

  インターフェース Mergeable の merge 

  パラメーター:

  parent - プロパティを継承する親 RequestBuilder 

  戻り値:

  マージの結果

• buildRequest

  public final MockHttpServletRequest buildRequest(jakarta.servlet.ServletContext servletContext)

  MockHttpServletRequest を構築します。

  次で指定:

  インターフェース RequestBuilder の buildRequest 

  パラメーター:

  servletContext - リクエストを作成するために使用する ServletContext 

  戻り値:

  リクエスト

• createServletRequest

  protected MockHttpServletRequest createServletRequest(jakarta.servlet.ServletContext servletContext)

  提供された ServletContext に基づいて新しい MockHttpServletRequest を作成します。

  サブクラスでオーバーライドできます。

• postProcessRequest

  public MockHttpServletRequest postProcessRequest(MockHttpServletRequest request)

  インターフェースからコピーされた説明: SmartRequestBuilder

  リクエストの後処理を適用します。通常、これは 1 つ以上の org.springframework.test.web.servlet.request.RequestPostProcessors を呼び出すことを意味します。

  次で指定:

  インターフェース SmartRequestBuilder の postProcessRequest 

  パラメーター:

  request - 初期化するリクエスト

  戻り値:

  使用するリクエスト。渡されたリクエストまたはラップされたリクエスト