クラス RequestPredicates

メソッドの詳細

• all

  public static RequestPredicate all()

  常に一致する RequestPredicate を返します。

  戻り値:

  常に一致する述語

• method

  public static RequestPredicate method(HttpMethod httpMethod)

  リクエストの HTTP メソッドが指定されたメソッドと等しい場合に一致する RequestPredicate を返します。

  パラメーター:

  httpMethod - 照合する HTTP メソッド

  戻り値:

  指定された HTTP メソッドに対してテストする述語

• methods

  public static RequestPredicate methods(HttpMethod... httpMethods)

  リクエストの HTTP メソッドが指定されたメソッドの 1 つと等しい場合に一致する RequestPredicate を返します。

  パラメーター:

  httpMethods - 照合する HTTP メソッド

  戻り値:

  指定された HTTP メソッドに対してテストする述語

• path

  public static RequestPredicate path(StringSE pattern)

  指定されたパスパターンに対してリクエストパスをテストする RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパターン

  戻り値:

  指定されたパスパターンに対してテストする述語

  関連事項:

  • PathPattern

• pathPredicates

  public static FunctionSE<StringSE, RequestPredicate> pathPredicates(PathPatternParser patternParser)

  指定された PathPatternParser を使用して、パターン文字列から新しいパス一致 RequestPredicates を作成する関数を返します。

  このメソッドは、パスパターンを解決するときに、デフォルト以外のカスタマイズされた PathPatternParser を指定するために使用できます。

  パラメーター:

  patternParser - 返された関数に与えられたパターンを解析するために使用されるパーサー

  戻り値:

  パターン文字列をパスマッチング RequestPredicates インスタンスに解決する関数

• headers

  public static RequestPredicate headers(PredicateSE<ServerRequest.Headers> headersPredicate)

  指定されたヘッダー述語に対してリクエストのヘッダーをテストする RequestPredicate を返します。

  パラメーター:

  headersPredicate - リクエストヘッダーに対してテストする述語

  戻り値:

  指定されたヘッダー述語に対してテストする述語

• contentType

  public static RequestPredicate contentType(MediaType... mediaTypes)

  リクエストのコンテンツ型が特定のメディア型のいずれかに含まれているかどうかをテストする RequestPredicate を返します。

  パラメーター:

  mediaTypes - リクエストのコンテンツ型を照合するメディア型

  戻り値:

  指定されたメディア型に対してリクエストのコンテンツ型をテストする述語

• accept

  public static RequestPredicate accept(MediaType... mediaTypes)

  リクエストの accept ヘッダーが指定されたメディア型のいずれかと互換性があるかどうかをテストする RequestPredicate を返します。

  パラメーター:

  mediaTypes - リクエストの Accept ヘッダーを照合するメディア型

  戻り値:

  指定されたメディア型に対してリクエストの Accept ヘッダーをテストする述語

• version

  public static RequestPredicate version(ObjectSE version)

  構成された ApiVersionStrategy から抽出され解析されたリクエスト API バージョンと一致する RequestPredicate。

  バージョンは次のいずれかになります。

  • 修正バージョン ("1.2") - このバージョンのみに一致します。
  • ベースラインバージョン ("1.2+") - このバージョンと後続のバージョンに一致します。

  ベースラインバージョンでは、互換性のない変更によって最終的に新しいルートが作成されるまでは、エンドポイントルートが互換性を維持している限り、後続のバージョンでも引き続き機能することができます。

  パラメーター:

  version - 使用するバージョン

  戻り値:

  作成された述語インスタンス

  導入:

  7.0

• GET

  public static RequestPredicate GET(StringSE pattern)

  リクエストの HTTP メソッドが GET であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが GET であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• HEAD

  public static RequestPredicate HEAD(StringSE pattern)

  リクエストの HTTP メソッドが HEAD であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが HEAD であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• POST

  public static RequestPredicate POST(StringSE pattern)

  リクエストの HTTP メソッドが POST であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが POST であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• PUT

  public static RequestPredicate PUT(StringSE pattern)

  リクエストの HTTP メソッドが PUT であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが PUT であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• PATCH

  public static RequestPredicate PATCH(StringSE pattern)

  リクエストの HTTP メソッドが PATCH であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが PATCH であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• DELETE

  public static RequestPredicate DELETE(StringSE pattern)

  リクエストの HTTP メソッドが DELETE であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが DELETE であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• OPTIONS

  public static RequestPredicate OPTIONS(StringSE pattern)

  リクエストの HTTP メソッドが OPTIONS であり、指定された pattern がリクエストパスと一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  pattern - 照合するパスパターン

  戻り値:

  リクエストメソッドが OPTIONS であり、指定されたパターンがリクエストパスと一致する場合に一致する述語

  関連事項:

  • PathPattern

• pathExtension

  @DeprecatedSE(since="7.0", forRemoval=true) public static RequestPredicate pathExtension(StringSE extension)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  リクエストマッピングとコンテンツネゴシエーションのためのパス拡張の使用を控えるために、代替案はありません（アノテーション付きコントローラーにはすでに同様の廃止と削除が適用されています）。詳細については、課題 #24179 を参照してください。

  リクエストのパスが指定された拡張子を持つ場合に一致する RequestPredicate を返します。

  パラメーター:

  extension - 大文字と小文字を区別せずに照合するパス拡張子

  戻り値:

  リクエストのパスが指定されたファイル拡張子を持つ場合に一致する述語

• pathExtension

  @DeprecatedSE(since="7.0", forRemoval=true) public static RequestPredicate pathExtension(PredicateSE<StringSE> extensionPredicate)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  リクエストマッピングとコンテンツネゴシエーションのためのパス拡張の使用を控えるために、代替案はありません（アノテーション付きコントローラーにはすでに同様の廃止と削除が適用されています）。詳細については、課題 #24179 を参照してください。

  リクエストのパスが指定された述語と一致する場合に一致する RequestPredicate を返します。

  パラメーター:

  extensionPredicate - リクエストパス拡張に対してテストする述語

  戻り値:

  指定された述語がリクエストのパスファイル拡張子と一致する場合に一致する述語

• param

  public static RequestPredicate param(StringSE name, StringSE value)

  指定された名前のリクエストのパラメーターが指定された値を持つ場合に一致する RequestPredicate を返します。

  パラメーター:

  name - テストするパラメーターの名前

  value - テストするパラメーターの値

  戻り値:

  パラメーターが指定された値を持つ場合に一致する述語

  関連事項:

  • ServerRequest.param(String)

• param

  public static RequestPredicate param(StringSE name, PredicateSE<StringSE> predicate)

  特定の述語に対して特定の名前のリクエストのパラメーターをテストする RequestPredicate を返します。

  パラメーター:

  name - テストするパラメーターの名前

  predicate - パラメーター値に対してテストする述語

  戻り値:

  指定された名前のパラメーターに対して指定された述語と一致する述語

  関連事項:

  • ServerRequest.param(String)