パッケージ org.springframework.test.web.client.match

クラス MockRestRequestMatchers

java.lang.ObjectSE
org.springframework.test.web.client.match.MockRestRequestMatchers
public abstract class MockRestRequestMatchers extends ObjectSE
RequestMatcher クラスの静的ファクトリメソッド。通常、MockRestServiceServer.expect(RequestMatcher) に入力を提供するために使用されます。

Eclipse ユーザー

このクラスを Java エディターのお気に入りとして追加することを検討してください。この設定に移動するには、設定を開き、「お気に入り」と入力します。

導入:
3.2
作成者:
Craig Walls, Rossen Stoyanchev, Sam Brannen, Simon Basl é

  • コンストラクターの詳細

    • MockRestRequestMatchers

      public MockRestRequestMatchers()

  • メソッドの詳細

    • anything

      public static RequestMatcher anything()
      どんなリクエストにもマッチします。

    • method

      public static RequestMatcher method(HttpMethod method)
      リクエストの HttpMethod をアサートします。
      パラメーター:
      method - HTTP メソッド
      戻り値:
      リクエストマッチャー

    • requestTo

      public static RequestMatcher requestTo(Matcher<? super StringSE> matcher)
      指定された Hamcrest マッチャーでリクエスト URI 文字列をアサートします。
      パラメーター:
      matcher - 予想される URI の文字列マッチャー
      戻り値:
      リクエストマッチャー

    • requestTo

      public static RequestMatcher requestTo(StringSE expectedUri)
      指定された文字列に一致するリクエスト URI をアサートします。
      パラメーター:
      expectedUri - 期待される URI
      戻り値:
      リクエストマッチャー

    • requestToUriTemplate

      public static RequestMatcher requestToUriTemplate(StringSE expectedUri, ObjectSE... uriVars)
      エンコーディングを含む UriComponentsBuilder を介して URI テンプレートとオプション変数から URI を準備する requestTo(URI) のバリアント。
      パラメーター:
      expectedUri - 予想される URI テンプレート
      uriVars - 予期される URI を設定するための 0 個以上の URI 変数
      戻り値:
      リクエストマッチャー

    • requestTo

      public static RequestMatcher requestTo(URISE uri)
      指定された URI へのリクエストを期待します。
      パラメーター:
      uri - 期待される URI
      戻り値:
      リクエストマッチャー

    • queryParamList

      public static RequestMatcher queryParamList(StringSE name, Matcher<? super ListSE<StringSE>> matcher)
      値の ListSE 全体で一致する、指定された Hamcrest マッチャーでリクエストクエリパラメーター値をアサートします。

      例: これを使用して、クエリパラメーター値のリストに特定の Hamcrest マッチャー ( Matchers.hasItem(Matcher) など) に一致する値が少なくとも 1 つあること、リスト内のすべての値が共通の条件 ( Matchers.everyItem(Matcher) など) に一致すること、各値がリストは、対応する専用条件 ( Matchers.contains(Matcher[]) など) などと一致します。

      パラメーター:
      name - 値がアサートされるクエリパラメーターの名前
      matcher - 指定されたクエリパラメーターの値のリスト全体に適用する Hamcrest マッチャー
      導入:
      5.3.27
      関連事項:

    • queryParam

      @SafeVarargsSE public static RequestMatcher queryParam(StringSE name, Matcher<? super StringSE>... matchers)
      指定された Hamcrest マッチャーでリクエストクエリパラメーター値をアサートします。

      クエリパラメーター値リストが提供された matchers の数よりも大きい場合、追加のクエリパラメーター値にマッチャーは適用されず、追加のパラメーター値は事実上無視されます。指定された matchers の数がクエリパラメーター値の数を超えると、AssertionErrorSE がスローされて不一致が通知されます。

      個々の値のみに適用するのではなく、値のリスト全体に適用する Matcher を受け入れるバリアントについては、queryParamList(String, Matcher) を参照してください。

      パラメーター:
      name - 値がアサートされるクエリパラメーターの名前
      matchers - 個々のクエリパラメーター値に適用する Hamcrest マッチャー。n 番目のマッチャーが n 番目のクエリパラメーター値に適用されます
      関連事項:

    • queryParam

      public static RequestMatcher queryParam(StringSE name, StringSE... expectedValues)
      リクエストクエリパラメーター値をアサートします。

      クエリパラメーター値リストが expectedValues の数よりも大きい場合、追加のクエリパラメーター値にアサーションは適用されず、追加のパラメーター値は事実上無視されます。expectedValues の数がクエリパラメーター値の数を超えると、AssertionErrorSE がスローされて不一致が通知されます。

      個々の値のみをアサートするのではなく、値のリスト全体に適用される Hamcrest Matcher を受け入れるバリアントについては、queryParamList(String, Matcher) を参照してください。

      パラメーター:
      name - 値がアサートされるクエリパラメーターの名前
      expectedValues - 個々のクエリパラメーター値の期待値。n 番目の期待値が n 番目のクエリパラメーター値と比較されます
      関連事項:

    • headerList

      public static RequestMatcher headerList(StringSE name, Matcher<? super ListSE<StringSE>> matcher)
      値の ListSE 全体で一致する、指定された Hamcrest マッチャーでリクエストヘッダー値をアサートします。

      例: これを使用して、ヘッダー値のリストに特定の Hamcrest マッチャー ( Matchers.hasItem(Matcher) など) に一致する値が少なくとも 1 つあること、リスト内のすべての値が共通の条件 ( Matchers.everyItem(Matcher) など) に一致すること、リストは、対応する専用の条件 ( Matchers.contains(Matcher[]) など) などと一致します。

      パラメーター:
      name - 値がアサートされるヘッダーの名前
      matcher - 指定されたヘッダーの値のリスト全体に適用する Hamcrest マッチャー
      導入:
      5.3.27
      関連事項:

    • header

      @SafeVarargsSE public static RequestMatcher header(StringSE name, Matcher<? super StringSE>... matchers)
      指定された Hamcrest マッチャーでリクエストヘッダー値をアサートします。

      ヘッダー値リストが提供された matchers の数よりも大きい場合、マッチャーは追加のヘッダー値に適用されず、追加のヘッダー値は効果的に無視されます。提供された matchers の数がヘッダー値の数を超える場合、AssertionErrorSE がスローされて不一致が通知されます。

      個々の値のみに適用するのではなく、値のリスト全体に適用する Hamcrest Matcher を受け入れるバリアントについては、headerList(String, Matcher) を参照してください。

      パラメーター:
      name - 値がアサートされるヘッダーの名前
      matchers - 個々のヘッダー値に適用する Hamcrest マッチャー。n 番目のマッチャーが n 番目のヘッダー値に適用されます
      関連事項:

    • header

      public static RequestMatcher header(StringSE name, StringSE... expectedValues)
      リクエストヘッダー値をアサートします。

      ヘッダー値リストが expectedValues の数よりも大きい場合、追加のヘッダー値にマッチャーは適用されず、追加のヘッダー値は効果的に無視されます。expectedValues の数がヘッダー値の数を超えると、AssertionErrorSE がスローされて不一致が通知されます。

      個々の値のみに適用するのではなく、値のリスト全体に適用する Hamcrest Matcher を受け入れるバリアントについては、headerList(String, Matcher) を参照してください。

      パラメーター:
      name - 値がアサートされるヘッダーの名前
      expectedValues - 個々のヘッダー値の期待値 ; n 番目の期待値が n 番目のヘッダー値と比較されます
      関連事項:

    • headerDoesNotExist

      public static RequestMatcher headerDoesNotExist(StringSE name)
      指定されたリクエストヘッダーが存在しないことをアサートします。
      導入:
      5.2

    • content

      public static ContentRequestMatchers content()
      ボディマッチャーをリクエストするためのアクセス。

    • jsonPath

      public static JsonPathRequestMatchers jsonPath(StringSE expression, ObjectSE... args)
      ボディの特定のサブセットをインスペクションするために JsonPath 式を使用してボディマッチャーをリクエストするアクセス。JSON パス式は、String.format(String, Object...)SE で定義されているフォーマット指定子を使用してパラメーター化された文字列にすることができます。
      パラメーター:
      expression - オプションで引数でパラメーター化された JSON パス
      args - JSON パス式をパラメーター化する引数

    • jsonPath

      public static <T> RequestMatcher jsonPath(StringSE expression, Matcher<? super T> matcher)
      JsonPath 式を使用してボディの特定のサブセットをインスペクションし、JSON パスで見つかった値をアサートするための Hamcrest 一致を使用して、ボディマッチャーをリクエストするアクセス。
      パラメーター:
      expression - JSON パス式
      matcher - JSON パスで期待される値のマッチャー

    • xpath

      public static XpathRequestMatchers xpath(StringSE expression, ObjectSE... args) throws XPathExpressionExceptionSE
      XPath を使用してボディマッチャーをリクエストし、ボディの特定のサブセットをインスペクションするためのアクセス権。XPath 式は、String.format(String, Object...)SE で定義されているフォーマット指定子を使用してパラメーター化された文字列にすることができます。
      パラメーター:
      expression - オプションで引数でパラメーター化された XPath
      args - XPath 式をパラメーター化する引数
      例外:
      XPathExpressionExceptionSE

    • xpath

      public static XpathRequestMatchers xpath(StringSE expression, MapSE<StringSE,StringSE> namespaces, ObjectSE... args) throws XPathExpressionExceptionSE
      XPath を使用して本文の特定のサブセットをインスペクションするレスポンスの本文マッチャーへのアクセス。XPath 式は、String.format(String, Object...)SE で定義されているフォーマット指定子を使用してパラメーター化された文字列にすることができます。
      パラメーター:
      expression - オプションで引数でパラメーター化された XPath
      namespaces - XPath 式で参照される名前空間
      args - XPath 式をパラメーター化する引数
      例外:
      XPathExpressionExceptionSE