クラス RequestPredicates
java.lang.ObjectSE
org.springframework.web.reactive.function.server.RequestPredicates
パス、HTTP メソッドなどに基づくマッチングなど、さまざまな便利なリクエストマッチング操作を実装する
RequestPredicate
の実装。- 導入:
- 5.0
- 作成者:
- Arjen Poutsma
ネストされたクラスのサマリー
コンストラクターのサマリー
メソッドのサマリー
修飾子と型メソッド説明static RequestPredicate
static RequestPredicate
all()
常に一致するRequestPredicate
を返します。static RequestPredicate
contentType
(MediaType... mediaTypes) static RequestPredicate
リクエストの HTTP メソッドがDELETE
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
リクエストの HTTP メソッドがGET
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
リクエストの HTTP メソッドがHEAD
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
headers
(PredicateSE<ServerRequest.Headers> headersPredicate) 指定されたヘッダー述語に対してリクエストのヘッダーをテストするRequestPredicate
を返します。static RequestPredicate
method
(HttpMethod httpMethod) リクエストの HTTP メソッドが指定されたメソッドと等しい場合に一致するRequestPredicate
を返します。static RequestPredicate
methods
(HttpMethod... httpMethods) リクエストの HTTP メソッドが指定されたメソッドの 1 つと等しい場合に一致するRequestPredicate
を返します。static RequestPredicate
リクエストの HTTP メソッドがOPTIONS
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
リクエストの HTTP メソッドがPATCH
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
指定されたパスパターンに対してリクエストパスをテストするRequestPredicate
を返します。static RequestPredicate
pathExtension
(StringSE extension) リクエストのパスが指定された拡張子を持つ場合に一致するRequestPredicate
を返します。static RequestPredicate
pathExtension
(PredicateSE<StringSE> extensionPredicate) リクエストのパスが指定された述語と一致する場合に一致するRequestPredicate
を返します。static FunctionSE<StringSE,
RequestPredicate> pathPredicates
(PathPatternParser patternParser) 指定されたPathPatternParser
を使用して、パターン文字列から新しいパス一致RequestPredicates
を作成する関数を返します。static RequestPredicate
リクエストの HTTP メソッドがPOST
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
リクエストの HTTP メソッドがPUT
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。static RequestPredicate
queryParam
(StringSE name, StringSE value) 指定された名前のリクエストのクエリパラメーターが指定された値を持つ場合に一致するRequestPredicate
を返します。static RequestPredicate
queryParam
(StringSE name, PredicateSE<StringSE> predicate) 特定の述語に対して特定の名前のリクエストのクエリパラメーターをテストするRequestPredicate
を返します。
コンストラクターの詳細
RequestPredicates
public RequestPredicates()
メソッドの詳細
all
常に一致するRequestPredicate
を返します。- 戻り値:
- 常に一致する述語
method
リクエストの HTTP メソッドが指定されたメソッドと等しい場合に一致するRequestPredicate
を返します。- パラメーター:
httpMethod
- 照合する HTTP メソッド- 戻り値:
- 指定された HTTP メソッドに対してテストする述語
methods
リクエストの HTTP メソッドが指定されたメソッドの 1 つと等しい場合に一致するRequestPredicate
を返します。- パラメーター:
httpMethods
- 照合する HTTP メソッド- 戻り値:
- 指定された HTTP メソッドに対してテストする述語
- 導入:
- 5.1
path
指定されたパスパターンに対してリクエストパスをテストするRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパターン- 戻り値:
- 指定されたパスパターンに対してテストする述語
- 関連事項:
pathPredicates
指定されたPathPatternParser
を使用して、パターン文字列から新しいパス一致RequestPredicates
を作成する関数を返します。このメソッドは、パスパターンを解決するときに、デフォルト以外のカスタマイズされた
PathPatternParser
を指定するために使用できます。- パラメーター:
patternParser
- 返された関数に与えられたパターンを解析するために使用されるパーサー- 戻り値:
- パターン文字列をパスマッチング
RequestPredicates
インスタンスに解決する関数
headers
指定されたヘッダー述語に対してリクエストのヘッダーをテストするRequestPredicate
を返します。- パラメーター:
headersPredicate
- リクエストヘッダーに対してテストする述語- 戻り値:
- 指定されたヘッダー述語に対してテストする述語
contentType
- パラメーター:
mediaTypes
- リクエストのコンテンツ型を照合するメディア型- 戻り値:
- 指定されたメディア型に対してリクエストのコンテンツ型をテストする述語
accept
- パラメーター:
mediaTypes
- リクエストの Accept ヘッダーを照合するメディア型- 戻り値:
- 指定されたメディア型に対してリクエストの Accept ヘッダーをテストする述語
GET
リクエストの HTTP メソッドがGET
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが GET であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
HEAD
リクエストの HTTP メソッドがHEAD
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが HEAD であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
POST
リクエストの HTTP メソッドがPOST
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが POST であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
PUT
リクエストの HTTP メソッドがPUT
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが PUT であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
PATCH
リクエストの HTTP メソッドがPATCH
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが PATCH であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
DELETE
リクエストの HTTP メソッドがDELETE
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが DELETE であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
OPTIONS
リクエストの HTTP メソッドがOPTIONS
であり、指定されたpattern
がリクエストパスと一致する場合に一致するRequestPredicate
を返します。- パラメーター:
pattern
- 照合するパスパターン- 戻り値:
- リクエストメソッドが OPTIONS であり、指定されたパターンがリクエストパスと一致する場合に一致する述語
- 関連事項:
pathExtension
リクエストのパスが指定された拡張子を持つ場合に一致するRequestPredicate
を返します。- パラメーター:
extension
- 大文字と小文字を区別せずに照合するパス拡張子- 戻り値:
- リクエストのパスが指定されたファイル拡張子を持つ場合に一致する述語
pathExtension
リクエストのパスが指定された述語と一致する場合に一致するRequestPredicate
を返します。- パラメーター:
extensionPredicate
- リクエストパス拡張に対してテストする述語- 戻り値:
- 指定された述語がリクエストのパスファイル拡張子と一致する場合に一致する述語
queryParam
指定された名前のリクエストのクエリパラメーターが指定された値を持つ場合に一致するRequestPredicate
を返します。- パラメーター:
name
- テストするクエリパラメーターの名前value
- テストするクエリパラメーターの値- 戻り値:
- クエリパラメーターに指定された値がある場合に一致する述語
- 導入:
- 5.0.7
- 関連事項:
queryParam
特定の述語に対して特定の名前のリクエストのクエリパラメーターをテストするRequestPredicate
を返します。- パラメーター:
name
- テストするクエリパラメーターの名前predicate
- クエリパラメーター値に対してテストする述語- 戻り値:
- 指定された述語を指定された名前のクエリパラメーターと一致させる述語
- 関連事項: