クラス RequestPredicates
java.lang.ObjectSE
org.springframework.web.servlet.function.RequestPredicates
パス、HTTP メソッドなどに基づくマッチングなど、さまざまな便利なリクエストマッチング操作を実装する
RequestPredicate の実装。- 導入:
- 5.2
- 作成者:
- Arjen Poutsma, Sam Brannen
ネストされたクラスの要約
ネストされたクラスコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明static RequestPredicatestatic RequestPredicateall()常に一致するRequestPredicateを返します。static RequestPredicatecontentType(MediaType... mediaTypes) static RequestPredicateリクエストの HTTP メソッドがDELETEであり、指定されたpatternがリクエストパスと一致する場合に一致するRequestPredicateを返します。static RequestPredicateリクエストの HTTP メソッドがGETであり、指定されたpatternがリクエストパスと一致する場合に一致するRequestPredicateを返します。static RequestPredicateリクエストの HTTP メソッドがHEADであり、指定されたpatternがリクエストパスと一致する場合に一致するRequestPredicateを返します。static RequestPredicateheaders(PredicateSE<ServerRequest.Headers> headersPredicate) 指定されたヘッダー述語に対してリクエストのヘッダーをテストするRequestPredicateを返します。static RequestPredicatemethod(HttpMethod httpMethod) リクエストの HTTP メソッドが指定されたメソッドと等しい場合に一致するRequestPredicateを返します。static RequestPredicatemethods(HttpMethod... httpMethods) リクエストの HTTP メソッドが指定されたメソッドの 1 つと等しい場合に一致するRequestPredicateを返します。static RequestPredicateリクエストの HTTP メソッドがOPTIONSであり、指定されたpatternがリクエストパスと一致する場合に一致するRequestPredicateを返します。static RequestPredicate指定された名前のリクエストのパラメーターが指定された値を持つ場合に一致するRequestPredicateを返します。static RequestPredicateparam(StringSE name, PredicateSE<StringSE> predicate) 特定の述語に対して特定の名前のリクエストのパラメーターをテストするRequestPredicateを返します。static RequestPredicateリクエストの HTTP メソッドがPATCHであり、指定されたpatternがリクエストパスと一致する場合に一致するRequestPredicateを返します。static RequestPredicate指定されたパスパターンに対してリクエストパスをテストするRequestPredicateを返します。static RequestPredicatepathExtension(StringSE extension) リクエストのパスが指定された拡張子を持つ場合に一致するRequestPredicateを返します。static RequestPredicatepathExtension(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を返します。
コンストラクターの詳細
RequestPredicates
public RequestPredicates()
メソッドの詳細
all
常に一致するRequestPredicateを返します。- 戻り値:
- 常に一致する述語
method
リクエストの HTTP メソッドが指定されたメソッドと等しい場合に一致するRequestPredicateを返します。- パラメーター:
httpMethod- 照合する HTTP メソッド- 戻り値:
- 指定された HTTP メソッドに対してテストする述語
methods
リクエストの HTTP メソッドが指定されたメソッドの 1 つと等しい場合に一致するRequestPredicateを返します。- パラメーター:
httpMethods- 照合する HTTP メソッド- 戻り値:
- 指定された HTTP メソッドに対してテストする述語
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- リクエストパス拡張に対してテストする述語- 戻り値:
- 指定された述語がリクエストのパスファイル拡張子と一致する場合に一致する述語
param
指定された名前のリクエストのパラメーターが指定された値を持つ場合に一致するRequestPredicateを返します。- パラメーター:
name- テストするパラメーターの名前value- テストするパラメーターの値- 戻り値:
- パラメーターが指定された値を持つ場合に一致する述語
- 関連事項:
param
特定の述語に対して特定の名前のリクエストのパラメーターをテストするRequestPredicateを返します。- パラメーター:
name- テストするパラメーターの名前predicate- パラメーター値に対してテストする述語- 戻り値:
- 指定された名前のパラメーターに対して指定された述語と一致する述語
- 関連事項: