クラス RequestHeaderRequestMatcher

java.lang.ObjectSE
org.springframework.security.web.util.matcher.RequestHeaderRequestMatcher
実装されたすべてのインターフェース:
RequestMatcher

public final class RequestHeaderRequestMatcher extends ObjectSE implements RequestMatcher
予想されるヘッダー名と予想される値を持つヘッダーを含むリクエストを照合するために使用できる RequestMatcher

例: 以下は、値が何であっても X-Requested-With という名前のヘッダーを含むリクエストに一致します。

 RequestMatcher matcher = new RequestHeaderRequestMatcher("X-Requested-With");
 
あるいは、RequestHeaderRequestMatcher はより正確で、特定の値を必要とする場合があります。たとえば、次のリクエストは、ヘッダー名が X-Requested-With で値が "XMLHttpRequest" である場合は一致しますが、ヘッダー名が "X-Requested-With" である場合は「その他」で一致しません。
 RequestMatcher matcher = new RequestHeaderRequestMatcher("X-Requested-With",
                "XMLHttpRequest");
 
比較に使用される値は最初のヘッダー値であるため、前の例では、ヘッダー "X-Requested-With" に値 "Other" および "XMLHttpRequest" が含まれている場合、一致しません。
導入:
3.2
  • ネストされたクラスのサマリー

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

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

    コンストラクター
    コンストラクター
    説明
    expectedHeaderName という名前のヘッダーが存在する場合に一致する新しいインスタンスを作成します。
    RequestHeaderRequestMatcher(StringSE expectedHeaderName, StringSE expectedHeaderValue)
    expectedHeaderName という名前のヘッダーが存在し、expectedHeaderValue が null でない場合、最初の値が同じである場合に一致する新しいインスタンスを作成します。
  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    boolean
    matches(jakarta.servlet.http.HttpServletRequest request)
    戦略によって実装されたルールが提供されたリクエストと一致するかどうかを決定します。

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

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

    インターフェース org.springframework.security.web.util.matcher.RequestMatcher から継承されたメソッド

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

    • RequestHeaderRequestMatcher

      public RequestHeaderRequestMatcher(StringSE expectedHeaderName)
      expectedHeaderName という名前のヘッダーが存在する場合に一致する新しいインスタンスを作成します。この場合、値は重要ではありません。
      パラメーター:
      expectedHeaderName - 存在する場合、リクエストが一致する期待されるヘッダーの名前。null にはできません。
    • RequestHeaderRequestMatcher

      public RequestHeaderRequestMatcher(StringSE expectedHeaderName, StringSE expectedHeaderValue)
      expectedHeaderName という名前のヘッダーが存在し、expectedHeaderValue が null でない場合、最初の値が同じである場合に一致する新しいインスタンスを作成します。
      パラメーター:
      expectedHeaderName - 予想されるヘッダーの名前。null にはできません
      expectedHeaderValue - 期待されるヘッダー値、または値が重要でない場合は null
  • メソッドの詳細

    • matches

      public boolean matches(jakarta.servlet.http.HttpServletRequest request)
      インターフェースからコピーされた説明: RequestMatcher
      戦略によって実装されたルールが提供されたリクエストと一致するかどうかを決定します。
      次で指定:
      インターフェース RequestMatchermatches 
      パラメーター:
      request - 一致を確認するリクエスト
      戻り値:
      リクエストが一致する場合は true、そうでない場合は false
    • toString

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