パッケージ org.springframework.security.web.util.matcher

クラス AntPathRequestMatcher

java.lang.ObjectSE
org.springframework.security.web.util.matcher.AntPathRequestMatcher
実装されたすべてのインターフェース:
RequestMatcher, RequestVariablesExtractor
public final class AntPathRequestMatcher extends ObjectSE implements RequestMatcher, RequestVariablesExtractor
HttpServletRequest の URL（servletPath + pathInfo）に対して事前定義された ant スタイルのパターンを比較するマッチャー。URL のクエリ文字列は無視され、コンストラクターに渡される引数に応じて、大文字と小文字が区別されないか、大文字と小文字が区別されます。

/** または ** のパターン値を使用すると、すべてのリクエストに一致するユニバーサル一致として扱われます。/** で終わる（他のワイルドカードがない）パターンは、部分文字列の一致を使用して最適化されます。/aaa/** のパターンは、/aaa、/aaa/、/aaa/bbb/ccc などのサブディレクトリと一致します。

他のすべての場合、Spring の AntPathMatcher が一致の実行に使用されます。使用される構文の包括的な情報については、このクラスの Spring ドキュメントを参照してください。

導入:
3.1
関連事項:
  • AntPathMatcher

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

    インターフェース org.springframework.security.web.util.matcher.RequestMatcher から継承されたネストクラス / インターフェース

    RequestMatcher.MatchResult

  • コンストラクターのサマリー

    コンストラクター
    コンストラクター
    説明
    AntPathRequestMatcher(StringSE pattern)
    大文字と小文字を区別してすべての HTTP メソッドに一致する特定のパターンを持つマッチャーを作成します。
    AntPathRequestMatcher(StringSE pattern, StringSE httpMethod)
    大文字と小文字を区別する方法で、指定されたパターンと HTTP メソッドを使用してマッチャーを作成します。
    AntPathRequestMatcher(StringSE pattern, StringSE httpMethod, boolean caseSensitive)
    指定された Http メソッドに一致する提供されたパターンでマッチャーを作成します
    AntPathRequestMatcher(StringSE pattern, StringSE httpMethod, boolean caseSensitive, org.springframework.web.util.UrlPathHelper urlPathHelper)
    指定された Http メソッドに一致する提供されたパターンでマッチャーを作成します

  • 方法の概要

    修飾子と型
    メソッド
    説明
    static AntPathRequestMatcher
    antMatcher(StringSE pattern)
    大文字と小文字を区別してすべての HTTP メソッドに一致する特定のパターンを持つマッチャーを作成します。
    static AntPathRequestMatcher
    antMatcher(org.springframework.http.HttpMethod method)
    大文字と小文字を区別する方法で、提供された HTTP メソッドを使用してすべてのリクエストを照合するマッチャーを作成します。
    static AntPathRequestMatcher
    antMatcher(org.springframework.http.HttpMethod method, StringSE pattern)
    提供されたパターンと HTTP メソッドを使用して、大文字と小文字を区別してマッチャーを作成します。
    boolean
    equals(ObjectSE obj)
    MapSE<StringSE,StringSE>
    extractUriTemplateVariables(jakarta.servlet.http.HttpServletRequest request)
    使用すべきではありません。
    StringSE
    getPattern()
    int
    hashCode()
    RequestMatcher.MatchResult
    matcher(jakarta.servlet.http.HttpServletRequest request)
    この RequestMatcher に対して MatchResult を返します。デフォルトの実装では、RequestMatcher.MatchResult.getVariables() が呼び出されると Collections.emptyMap() が返されます。
    boolean
    matches(jakarta.servlet.http.HttpServletRequest request)
    設定されたパターン（および HTTP メソッド）が提供されたリクエストのパターンと一致する場合、true を返します。
    StringSE
    toString()

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, finalize, getClass, notify, notifyAll, wait, waitSE, waitSE

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

    • AntPathRequestMatcher

      public AntPathRequestMatcher(StringSE pattern)
      大文字と小文字を区別してすべての HTTP メソッドに一致する特定のパターンを持つマッチャーを作成します。
      パラメーター:
      pattern - マッチングに使用する ant パターン

    • AntPathRequestMatcher

      public AntPathRequestMatcher(StringSE pattern, StringSE httpMethod)
      大文字と小文字を区別する方法で、指定されたパターンと HTTP メソッドを使用してマッチャーを作成します。
      パラメーター:
      pattern - マッチングに使用する ant パターン
      httpMethod - HTTP メソッド。受信リクエストに同じメソッドがない場合、matches メソッドは false を返します。

    • AntPathRequestMatcher

      public AntPathRequestMatcher(StringSE pattern, StringSE httpMethod, boolean caseSensitive)
      指定された Http メソッドに一致する提供されたパターンでマッチャーを作成します
      パラメーター:
      pattern - マッチングに使用する ant パターン
      httpMethod - HTTP メソッド。matches メソッドは、受信リクエストに同じメソッドがない場合、false を返します。
      caseSensitive - マッチャーが大文字と小文字を区別する場合は true、そうでない場合は false

    • AntPathRequestMatcher

      public AntPathRequestMatcher(StringSE pattern, StringSE httpMethod, boolean caseSensitive, org.springframework.web.util.UrlPathHelper urlPathHelper)
      指定された Http メソッドに一致する提供されたパターンでマッチャーを作成します
      パラメーター:
      pattern - マッチングに使用する ant パターン
      httpMethod - HTTP メソッド。受信リクエストに同じメソッドがない場合、matches メソッドは false を返します。
      caseSensitive - マッチャーが大文字と小文字を区別する場合は true、そうでない場合は false
      urlPathHelper - NULL 以外の場合、HttpServletRequest からパスを抽出するために使用されます

  • メソッドの詳細

    • antMatcher

      public static AntPathRequestMatcher antMatcher(StringSE pattern)
      大文字と小文字を区別してすべての HTTP メソッドに一致する特定のパターンを持つマッチャーを作成します。
      パラメーター:
      pattern - マッチングに使用する ant パターン
      導入:
      5.8

    • antMatcher

      public static AntPathRequestMatcher antMatcher(org.springframework.http.HttpMethod method)
      大文字と小文字を区別する方法で、提供された HTTP メソッドを使用してすべてのリクエストを照合するマッチャーを作成します。
      パラメーター:
      method - HTTP メソッド。受信リクエストに同じメソッドがない場合、matches メソッドは false を返します。
      導入:
      5.8

    • antMatcher

      public static AntPathRequestMatcher antMatcher(org.springframework.http.HttpMethod method, StringSE pattern)
      提供されたパターンと HTTP メソッドを使用して、大文字と小文字を区別してマッチャーを作成します。
      パラメーター:
      method - HTTP メソッド。受信リクエストに同じメソッドがない場合、matches メソッドは false を返します。
      pattern - マッチングに使用する ant パターン
      導入:
      5.8

    • matches

      public boolean matches(jakarta.servlet.http.HttpServletRequest request)
      設定されたパターン（および HTTP メソッド）が提供されたリクエストのパターンと一致する場合、true を返します。
      次で指定:
      インターフェース RequestMatcher の matches 
      パラメーター:
      request - 照合するリクエスト。ant パターンは、リクエストの servletPath + pathInfo と照合されます。
      戻り値:
      リクエストが一致する場合は true、そうでない場合は false

    • extractUriTemplateVariables

      @DeprecatedSE public MapSE<StringSE,StringSE> extractUriTemplateVariables(jakarta.servlet.http.HttpServletRequest request)
      使用すべきではありません。
      インターフェースからコピーされた説明: RequestVariablesExtractor
      リクエストから URL テンプレート変数を抽出します。
      次で指定:
      インターフェース RequestVariablesExtractor の extractUriTemplateVariables 
      パラメーター:
      request - 変数を抽出する URL を取得する HttpServletRequest
      戻り値:
      URL 変数。変数が見つからない場合は空

    • matcher

      public RequestMatcher.MatchResult matcher(jakarta.servlet.http.HttpServletRequest request)
      インターフェースからコピーされた説明: RequestMatcher
      この RequestMatcher に対して MatchResult を返します。デフォルトの実装では、RequestMatcher.MatchResult.getVariables() が呼び出されると Collections.emptyMap() が返されます。
      次で指定:
      インターフェース RequestMatcher の matcher 
      戻り値:
      MatchResult は、この RequestMatcher を HttpServletRequest と比較します

    • getPattern

      public StringSE getPattern()

    • equals

      public boolean equals(ObjectSE obj)
      オーバーライド:
      クラス ObjectSE の equalsSE 

    • hashCode

      public int hashCode()
      オーバーライド:
      クラス ObjectSE の hashCode 

    • toString

      public StringSE toString()
      オーバーライド:
      クラス ObjectSE の toString