Validation Module ドキュメントリファレンス
Validation Module v2.0
Validation Module は、Mule フローのメッセージの内容が特定の条件と一致するかどうかを検証します。このモジュールは、フロー内での例外の原因に関する明示的なメッセージを提供します。検証する特定のデータに基づいて、ログに表示される例外メッセージをカスタマイズできます。
データ検証を実行するモジュール。検証に失敗すると、エラーがスローされます。エラー種別はさまざまですが、常に VALIDATION:VALIDATION の子になります。
メッセージが定義されている検証条件を満たさないと、検証が失敗し、VALIDATION エラー (例: VALIDATION:INVALID_URL) が返され、ValidationException となります。デフォルトでは、このメッセージは意味のある内容となっており、カスタマイズ可能です。
リリースノート: Validation Module リリースノート
設定
設定
デフォルト設定
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Name (名前) |
String (文字列) |
この設定の名前。コネクタはこの名前の設定を参照します。 |
x |
|
I18n |
I18n |
I18n を標準エラーメッセージに合わせて設定します。 |
||
Name (名前) |
String (文字列) |
この設定の参照に使用される ID。 |
x |
|
Expiration Policy (有効期限ポリシー) |
動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。 |
Is Allowed Ip
<validation:is-allowed-ip>
IP アドレスが IP リストに含まれていることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Ip Address (IP アドレス) |
String (文字列) |
検証するアドレス。 |
x |
|
Allow List (許可リスト) |
許可されているアドレスのリスト。 |
x |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Blank String
<validation:is-blank-string>
値が空白の文字列であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
String (文字列) |
チェックする値。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Elapsed
<validation:is-elapsed>
指定された初期時刻から特定の時間が経過していることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Time (時刻) |
Number (数値) |
経過時間。 |
x |
|
Time Unit (時間単位) |
Enumeration (列挙)。次のいずれかになります。
|
時間の単位 (TimeUnit)。 |
x |
|
Since (以降) |
DateTime |
検証する時刻。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Email
<validation:is-email>
メールアドレスが有効であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Email (メール) |
String (文字列) |
メールアドレス。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Empty Collection
<validation:is-empty-collection>
値が空白のコレクションであることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Values (値) |
Any の配列 |
チェックする値。 |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is False
<validation:is-false>
指定された値が false であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Expression (式) |
Boolean (ブール) |
テストするブール式。 |
false |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is IP
<validation:is-ip>
文字列として表現されている IP アドレスが有効であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Ip |
String (文字列) |
検証する IP アドレス。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Not Blank String
<validation:is-not-blank-string>
値が空白の文字列ではないことを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
String (文字列) |
チェックする文字列。 |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Not Denied Ip
<validation:is-not-denied-ip>
IP アドレスが IP リストに含まれていないことを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Ip Address (IP アドレス) |
String (文字列) |
検証するアドレス。 |
x |
|
Deny List (拒否リスト) |
拒否されているアドレスのリスト。 |
x |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Not Elapsed
<validation:is-not-elapsed>
指定された初期時刻から特定の時間が経過していないことを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Time (時刻) |
Number (数値) |
Interval size (経過時間) |
x |
|
Time Unit (時間単位) |
Enumeration (列挙)。次のいずれかになります。
|
時間の単位 (TimeUnit)。 |
x |
|
Since (以降) |
DateTime |
検証する時刻。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Not Empty Collection
<validation:is-not-empty-collection>
値が空白のコレクションではないことを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Values (値) |
Any の配列 |
チェックする値。 |
#[payload] |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Not Null
<validation:is-not-null>
指定された値が null ではないことを検証します。null の定義は、mimeType 値によって異なります。たとえば、application/java mimeType の場合、null は空白のポインターを意味します。ただし、mimeType が application/json の場合、文字列 null は null 値でもあります。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
Any (いずれか) |
テストする値。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Null
<validation:is-null>
指定された値が null であることを検証します。null の定義は、mimeType 値によって異なります。たとえば、application/java mimeType の場合、null は空白のポインターを意味します。ただし、mimeType が application/json の場合、文字列 null は null 値でもあります。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
Any (いずれか) |
テストする値。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Number
<validation:is-number>
数値を文字列として受け取り、numberType のルールで解析できることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
String (文字列) |
テストする値。 |
x |
|
Locale (ロケール) |
String (文字列) |
形式で使用するロケール。指定しなかった場合のデフォルトはシステムロケール。 |
||
Pattern (パターン) |
String (文字列) |
値の書式設定に使用するパターン。 |
||
Min Value (最小値) |
String (文字列) |
指定した場合は、解析された値がこの値以上であることを検証します。 |
||
Max Value (最大値) |
String (文字列) |
指定した場合は、解析された値がこの値以下であることを検証します。 |
||
Number Type (数値種別) |
Enumeration (列挙)。次のいずれかになります。
|
値をテストする数値型。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is Time
<validation:is-time>
文字列形式の時刻が指定されたパターンとロケールに対して有効であることを検証します。パターンが指定されていない場合は、ロケールのデフォルトが使用されます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Time (時刻) |
String (文字列) |
文字列形式の日付。 |
x |
|
Locale (ロケール) |
String (文字列) |
文字列のロケール。 |
||
Pattern (パターン) |
String (文字列) |
日付のパターン。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is True
<validation:is-true>
指定された値が true であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Expression (式) |
Boolean (ブール) |
テストするブール。 |
false |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Is URL
<validation:is-url>
URL が有効であることを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
URL |
String (文字列) |
文字列として検証する URL。 |
x |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Matches Regex
<validation:matches-regex>
値が正規表現式と一致することを検証します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
String (文字列) |
チェックする値。 |
x |
|
Regex (正規表現) |
String (文字列) |
値に対してチェックする正規表現。 |
x |
|
Case Sensitive (大文字と小文字を区別) |
Boolean (ブール) |
|
true |
|
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Validate Size
<validation:validate-size>
値が指定された上限と下限 (両端を含む) の間にあることを検証します。バリデーターは、文字列、コレクション、マップ、および配列のインスタンスを処理できます。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Configuration (設定) |
String (文字列) |
使用する設定の名前。 |
x |
|
Value (値) |
Any (いずれか) |
検証する値。 |
x |
|
Min (最小) |
Number (数値) |
予想される最小長 (この値を含み、デフォルトは 0)。 |
0 |
|
Max (最大) |
Number (数値) |
予想される最大長 (この値を含む)。最大値を制限しない場合は、このパラメーターを指定しないか、または null を指定します。 |
||
Config Ref (設定参照) |
ConfigurationProvider |
このコンポーネントを実行するために使用する設定の名前。 |
||
Message (メッセージ) |
String (文字列) |
検証に失敗した場合にユーザーに通知するメッセージを指定します。検証に成功し、メッセージが不要な場合に式の評価に集中できるように、メッセージが動的ではないとしてマークされています。この値をコンシュームするコンポーネントでは、これが式かどうかをチェックし、検証に失敗した場合に式を評価します。 |
||
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
すべて
<validation:all>
ネストされた検証操作のリストを実行し、エラーがあった場合はすべてのエラーを要約した VALIDATION:MULTIPLE エラーを 1 つだけ返します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
Any (いずれか)
<validation:any>
ネストされた検証操作のリストを実行し、すべて失敗した場合はすべてのエラーを要約した VALIDATION:MULTIPLE エラーを 1 つだけ返します。
パラメーター
| 名前 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
エラーのマッピング |
エラーのマッピング の配列 |
エラーのマッピングのセット。 |
型
I18n
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Bundle Path (バンドルパス) |
String (文字列) |
メッセージを含むバンドルファイルへのパス。null の場合は、プラットフォームによってデフォルトのパスが選択されます。 |
x |
|
Locale (ロケール) |
String (文字列) |
プラットフォームのロケール。null の場合はプラットフォームによってシステムのデフォルトが選択されます。 |
Expiration Policy (有効期限ポリシー)
有効期限ポリシー戦略を設定します。
| 項目 | 型 | 説明 | デフォルト値 | 必須 |
|---|---|---|---|---|
Max Idle Time (最大アイドル時間) |
Number (数値) |
動的設定インスタンスがアイドル状態を続けられる最大時間を設定します。この時間が経過すると、Mule Runtime で期限切れに相当するとみなされます。 |
||
Time Unit (時間単位) |
Enumeration (列挙)。次のいずれかになります。
|
[Max Idle Time (最大アイドル時間)] 項目の時間単位。 |