Scripting Module リファレンス - Mule 4

Scripting Module v2.1

Scripting Module は、スクリプト言語で作成されたカスタムロジックを実行します。

設定


設定

デフォルト設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

操作

Execute

<scripting:execute>

エンジンと渡されたパラメーターに従ってスクリプトのコードを実行します。スクリプトでは、多くのバインド変数を使用できます。

名前 説明

payload (ペイロード)

Object (オブジェクト)

処理されたメッセージのペイロード。

dataType

メッセージペイロードのデータ型。

correlationId

String (文字列)

処理されたメッセージの correlationId。

属性

Map<String, Object>

処理された Mule メッセージの属性。

vars

Map<String, Object>

処理された現在の Mule イベントに設定されている変数。

メッセージ

処理されたメッセージ。

エラー

処理された Mule メッセージに関連付けられているエラー。

認証

認証に関する情報。

フロー

String (文字列)

現在のフローの名前。

log

ロガー

アプリケーションのログファイル ​MULE_HOME/logs/<app-name>.log​ に記録されるロガーオブジェクト。

結果

Object (オブジェクト)

スクリプトの実行結果を表す変数。

レジストリ

org.mule.runtime.api.artifact.Registry

レジストリオブジェクトを使用すると、Mule API 内の他のすべてのサービスにアクセスできます。

コードで暗黙的な結果が生成されない場合、実行結果で ​result​ 変数値を明示的に設定する必要があります。​「Scripting Module」​ドキュメントに記載されているように、​対象変数​を設定していない限り、ペイロードはこの値を使用して設定されます。

パラメーター

名前 説明 デフォルト値 必須

Code (コード)

String (文字列)

実行するスクリプトのソースコード。

x

Engine (エンジン)

String (文字列)

このスクリプトを実行するスクリプティングエンジンの名前。

x

Parameters (パラメーター)

Map<String, Object>

バインドとしてスクリプトに渡される変数。

Target Variable (対象変数)

String (文字列)

操作の出力を配置する変数の名前

Target Value (対象値)

String (文字列)

操作の出力に対して評価する式。この式の出力は対象変数に保存されます。

#[payload]

Scripting Module で使用するクラスをエクスポートする必要があります。そうしないと、​SCRIPTING:COMPILATION​ エラーで実行が失敗します。​「リソースのエクスポート方法」​を参照してください。

スロー

  • SCRIPTING:COMPILATION

  • SCRIPTING:UNKNOWN_ENGINE

  • SCRIPTING:EXECUTION

集約属性

項目 説明 デフォルト値 必須

Aggregation Id (集約 ID)

String (文字列)

イベントのメッセージの correlationId から取得される集約 ID。 アグリゲーターで correlationId 別に集約されない場合、この項目は、 現在の集約グループ。

x

First Item Arrival Time (最初の項目の到着時間)

Number (数値)

最初に集約された値が到着した時刻。

x

Last Item Arrival Time (最後の項目の到着時間)

Number (数値)

最後に集約された値が到着した時刻。

x

Is Aggregation Complete (集約完了)

Boolean (ブール)

集約の完了を示すブール値。

false

Redelivery Policy (再配信ポリシー)

エラーを生成する要求を実行するための再配信ポリシーを設定します。再配信ポリシーは、フロー内のあらゆる提供元に追加できます。

項目 説明 デフォルト値 必須

Max Redelivery Count (最大再配信数)

Number (数値)

​REDELIVERY_EXHAUSTED​ エラーが返されるまでに、再配信された要求が処理に失敗できる最大回数。

Use Secure Hash (セキュアハッシュを使用)

Boolean (ブール)

true​ の場合、再配信されたメッセージの識別にセキュアハッシュアルゴリズムが使用されます。

Message Digest Algorithm (メッセージダイジェストアルゴリズム)

String (文字列)

<b>[Use Secure Hash (セキュアハッシュを使用)]<b/> 項目が ​true​ の場合に使用するセキュアハッシュアルゴリズム。メッセージのペイロードが Java オブジェクトの場合、Mule ではこの値が無視され、ペイロードの ​hashCode()​ が返した値が返されます。

Id Expression (ID の式)

String (文字列)

メッセージがいつ再配信されたのかを判断する 1 つ以上の式。このプロパティは、<b>[Use Secure Hash (セキュアハッシュを使用)]</b> 項目が ​false​ の場合にのみ設定できます。

Object Store (オブジェクトストア)

各メッセージの再配信カウンターが保存されるオブジェクトストアを設定します。