Anypoint MQ Connector リファレンス - Mule 4

サポートされるバージョン: Select

Anypoint MQ Connector のバージョン 3.x

Anypoint MQ は、顧客がアプリケーション間で高度な非同期メッセージングを実行できる、マルチテナントのクラウドメッセージングサービスです。

設定


設定

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定する接続型を指定します。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime でパージに相当するとみなされます。必要に応じて、期限切れのインスタンスがパージされてリソースが解放されます。

接続種別

Connection (接続)
パラメーター
名前 説明 デフォルト値 必須

URL

String (文字列)

[Anypoint Platform] > [MQ]​ コンソールからのキューのリージョン URL。

https://mq-us-east-1.anypoint.mulesoft.com/api/v1

Client App ID (クライアントアプリケーション ID)

String (文字列)

[Anypoint Platform] > [MQ] > [Client Apps (クライアントアプリケーション)]​ からの [Client App ID (クライアントアプリケーション ID)]。

x

Client Secret (クライアントシークレット)

String (文字列)

[Anypoint Platform] > [MQ] > [Client Apps (クライアントアプリケーション)]​ からの [Client Secret (クライアントシークレット)] 項目。

x

TLS Context

TLS

Host (ホスト)

String (文字列)

プロキシ要求の宛先ホスト。

Port (ポート)

Number (数値)

プロキシ要求の宛先ポート。

Username (ユーザー名)

String (文字列)

プロキシに対して認証するユーザー名。

Password (パスワード)

String (文字列)

プロキシに対して認証するパスワード。

Send Buffer Size (送信バッファサイズ)

Number (数値)

データ送信時に使用するバッファのサイズ (バイト) で、ソケット自体に設定されます。

Receive Buffer Size (受信バッファサイズ)

Number (数値)

データ受信時に使用するバッファのサイズ (バイト)。

Client Timeout (クライアントタイムアウト)

Number (数値)

ソケットの ​SO_TIMEOUT​ 値。ブロック操作で失敗するまでにソケットが待機する時間 (ミリ秒) を示します。 値が 0 (デフォルト) の場合、無限に待機します。

Send TCP With No Delay (遅延なく TCP を送信)

Boolean (ブール)

設定した場合、送信データはグループ化されず、即時に送信されます。 デフォルトは true です。

true

Linger (延長)

Number (数値)

SO_LINGER​ 値。これは、残りのデータが正しく送信されるように、ソケットが閉じるまでにかかる時間 (ミリ秒) を決定します。

Keep Alive (キープアライブ)

Boolean (ブール)

開いているソケットの ​SO_KEEPALIVE​ 動作。接続が使用できなくなった場合、開いていて長時間使用されていないソケット接続を自動的にチェックして閉じます。これはソケット自体のプロパティであり、サーバーへの接続がリサイクルされるまでキープアライブで維持されるかどうかを制御するためにサーバーソケットで使用します。

false

Connection Timeout (接続タイムアウト)

Number (数値)

タイムアウトで失敗する前に、リモートサーバーへのアウトバウンド接続が正常に作成されるまで待機するミリ秒数。デフォルトは 30 秒です。

30000

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、各コネクタへのデプロイメント接続テストに失敗すると、デプロイメントが失敗します。

操作

関連付けられたソース

Ack

<anypoint-mq:ack>

メッセージが適切にコンシュームされたことを示す肯定応答を実行し、インフライト状況からメッセージを削除します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ack Token (Ack トークン)

String (文字列)

MANUAL モードでのみ、手動 ACK および NACK 操作を実行するために使用される肯定応答トークン。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

次の設定の場合

スロー

  • ANYPOINT-MQ:ACKING

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:DESTINATION_NOT_FOUND

  • ANYPOINT-MQ:RETRY_EXHAUSTED

Consume

<anypoint-mq:consume>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue (キュー)

String (文字列)

メッセージのフェッチ元であるキューまたはエクスチェンジの名前。

x

Acknowledgment Mode (肯定応答モード)

Enumeration (列挙)。次のいずれかになります。

  • IMMEDIATE

  • MANUAL

取得したメッセージに使用する肯定応答モード。

IMMEDIATE

肯定応答タイムアウト

Number (数値)

肯定応答または否定応答を待機しているコンシューマーによってメッセージが保持される期間。その期間が経過した後、任意のコンシューマーがメッセージを再び利用できるようになります。

0

Acknowledgment Timeout Unit (肯定応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

acknowledgmentTimeout 設定に使用する時間単位。

MILLISECONDS (ミリ秒)

Polling Time (ポーリング時間)

Number (数値)

コンシュームの準備が完了する前にメッセージを待機する時間 (0-20000)。

  • この値が 0 より大きく、メッセージが到着しない場合、コネクタは ​ANYPOINT-MQ:TIMEOUT​ 例外をスローします。

  • この値が 0 でメッセージが到着しない場合、コネクタは ​NULL​ を返し、​ANYPOINT-MQ:TIMEOUT​ 例外をスローしません。

10000

Polling Time Unit (ポーリング時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

pollingTime 設定に使用する時間単位。

MILLISECONDS (ミリ秒)

Output Mime Type (出力 MIME タイプ)

String (文字列)

操作の出力の MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

操作の出力のエンコード。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

出力

Binary (バイナリ)

Attributes Type (属性型)

次の設定の場合

スロー

  • ANYPOINT-MQ:ACKING

  • ANYPOINT-MQ:CONSUMING

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:TIMEOUT

  • ANYPOINT-MQ:DESTINATION_NOT_FOUND

  • ANYPOINT-MQ:RETRY_EXHAUSTED

Nack

<anypoint-mq:nack>

否定応答を実行し、メッセージの状況を「In Flight (インフライト)」から「In Queue (キュー待機中)」に変更し、サブスクライバーがコンシュームできるようにします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Ack Token (Ack トークン)

String (文字列)

MANUAL モードでのみ、手動 ACK および NACK 操作を実行するために使用される肯定応答トークン。

x

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

次の設定の場合

スロー

  • ANYPOINT-MQ:NACKING

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:DESTINATION_NOT_FOUND

  • ANYPOINT-MQ:RETRY_EXHAUSTED

Publish

<anypoint-mq:publish>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージのフェッチ元であるキューまたはエクスチェンジの名前。

x

Output Mime Type (出力 MIME タイプ)

String (文字列)

操作の出力の MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

操作の出力のエンコード。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用します。

Body (本文)

Binary (バイナリ)

送信メッセージの本文。JSON メッセージの一部の文字列として送信されます。パブリッシュされるコンテンツは、文字列形式の逐次化と並列化を実行できる必要があります。文字列が適切に逐次化されていないオブジェクトを送信すると、受信側でメッセージが読めなくなります。

#[payload]

User Properties (ユーザープロパティ)

Object (オブジェクト)

メッセージに設定されたカスタムユーザープロパティ。

Message Id (メッセージ ID)

String (文字列)

送信メッセージの有効なカスタムユーザー ID。指定されていない場合、ブローカーによって作成されます。

Message Group Id (メッセージグループ ID)

String (文字列)

パブリッシュされたメッセージが属するメッセージグループの ID。FIFO キューでのみ指定します。

メッセージグループ ID には最大 128 文字の英数字 (a-z, A-Z、0-9) および句読点 (! " # $ % & ' ( ) * + , - . / : ; < = > ? @ [ ] \ ^ _ ` { } | ~) を含めることができます。

Delivery Delay (配信遅延)

Number (数値)

コンシュームする前にメッセージの配信を延期する時間 (0 ~ 15 分)。

MILLISECONDS (ミリ秒)

Delivery Delay Unit (配信遅延単位)

Enumeration (列挙)

Delivery Delay​ パラメーターで使用する時間単位。

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

MILLISECONDS (ミリ秒)

Send Content-Type (コンテンツタイプの送信)

Boolean (ブール)

本文種別が Anypoint MQ メッセージプロパティとして送信される場合は true に設定します。

true

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

次の設定の場合

スロー

  • ANYPOINT-MQ:PUBLISHING

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:ILLEGAL_BODY

  • ANYPOINT-MQ:DESTINATION_NOT_FOUND

  • ANYPOINT-MQ:RETRY_EXHAUSTED

ソース

Subscriber

<anypoint-mq:subscriber>

Anypoint MQ Subscriber メッセージソースは、指定された宛先名からメッセージを取得します。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Queue (キュー)

String (文字列)

メッセージの取得元のキューの名前。

x

Subscriber Type (サブスクライバー種別)

次のいずれかになります。

サービスからメッセージにサブスクライブするときに使用する戦略。

Acknowledgment Mode (肯定応答モード)

Enumeration (列挙)。次のいずれかになります。

  • IMMEDIATE

  • AUTO

  • MANUAL

取得したメッセージに使用する肯定応答モード。

AUTO

肯定応答タイムアウト

Number (数値)

サブスクライバーが使用可能になる前に、肯定応答または否定応答を待機しているブローカーによってメッセージが保持される期間。上書きされていない場合のすべての Subscriber ソースのデフォルトの ​acknowledgmentTimeout​ 値を指定します。 このパラメーターの最大値は 12 時間です。

acknowledgementTimeout​ が設定されていない場合 (デフォルト)、コネクタでは少なくとも 2 分の TTL 値が使用されます。

Acknowledgment Timeout Unit (肯定応答タイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

acknowledgmentTimeout 設定に使用する時間単位。

MILLISECONDS (ミリ秒)

サーキットブレーカー

Output Mime Type (出力 MIME タイプ)

String (文字列)

操作の出力の MIME タイプ。

Output Encoding (出力エンコード)

String (文字列)

操作の出力のエンコード。

Primary Node Only (プライマリノードのみ)

Boolean (ブール)

クラスターでの実行時、このソースをプライマリノード上でのみ実行する必要があるかどうか。

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用します。

Redelivery Policy (再配信ポリシー)

メッセージ再配信ポリシー。

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

出力

Binary (バイナリ)

Attributes Type (属性型)

次の設定の場合

TLS

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

Enabled Protocols (有効化されたプロトコル)

String (文字列)

このコンテキストで有効化されたプロトコルのカンマ区切りリスト。

Enabled Cipher Suites (有効化された暗号化スイート)

String (文字列)

このコンテキストで有効化された暗号化スイートのカンマ区切りリスト。

トラストストア

Key Store (キーストア)

Revocation Check (取り消し確認)

トラストストア

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

Path (パス)

String (文字列)

トラストストアの場所。可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Password (パスワード)

String (文字列)

トラストストアを保護するために使用するパスワード。

Type (型)

String (文字列)

使用するストアの型。

Algorithm (アルゴリズム)

String (文字列)

トラストストアで使用するアルゴリズム。

Insecure (安全ではない)

Boolean (ブール)

true の場合、証明書の検証が行われず、攻撃に対して脆弱な接続がレンダリングされます。各自の責任で使用してください。

Key Store (キーストア)

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

Path (パス)

String (文字列)

キーストアの場所。可能であれば、現在のクラスパスとファイルシステムに対して解決されます。

Type (型)

String (文字列)

使用するストアの型。

Alias (別名)

String (文字列)

キーストアに多数の非公開キーがある場合、使用する鍵の別名を示します。定義しない場合、ファイルにある最初のキーがデフォルトで使用されます。

Key Password (キーパスワード)

String (文字列)

非公開キーを保護するために使用するパスワード。

Password (パスワード)

String (文字列)

キーストアを保護するために使用するパスワード。

Algorithm (アルゴリズム)

String (文字列)

キーストアで使用するアルゴリズム。

Standard Revocation Check (標準の取り消し確認)

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

Only End Entities (最後のエンティティのみ)

Boolean (ブール)

証明書チェーンの最後の要素のみを確認します。

Prefer Crls (CRL を優先)

Boolean (ブール)

OCSP 証明証明書を使用する前に、CRL 署名証明書を使用します。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 ([Prefer Crls (CRL を優先)] で選択されていない方法) を使用しません。

Soft Fail (ソフトフェール)

Boolean (ブール)

取り消しサーバーに到達できない場合や取り消しサーバーが混雑している場合に検証エラーを回避します。

Custom OCSP Responder (カスタム OCSP レスポンダー)

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

Url

String (文字列)

OCSP レスポンダーの URL。

Cert Alias (証明書の別名)

String (文字列)

OCSP 応答の署名証明書の別名 (存在する場合)。署名証明書がトラストストア内にある必要があります。

CRL File (CRL ファイル)

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

Path (パス)

String (文字列)

CRL ファイルへのパス。

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、各コネクタへのデプロイメント接続テストに失敗すると、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。

Reconnect (再接続)

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。
項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続を試みる回数

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

Anypoint MQ Connector ではこのパラメーターはサポートされていません。 詳細は、​「Anypoint MQ Connector で再試行戦略を使用できますか?」​を参照してください。
項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Expiration Policy (有効期限ポリシー)

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

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

Anypoint MQ メッセージの属性

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

Destination (宛先)

String (文字列)

メッセージの宛先。

x

Headers (ヘッダー)

Object (オブジェクト)

メッセージヘッダー。

x

Properties (プロパティ)

Object (オブジェクト)

メッセージプロパティ。

x

Message Id (メッセージ ID)

String (文字列)

メッセージの ID。

x

Delivery Count (配信数)

Number (数値)

メッセージが配信された回数。

x

Content Type (コンテンツタイプ)

String (文字列)

メッセージ本文のコンテンツタイプ。

Ack Token (Ack トークン)

String (文字列)

MANUAL モードでのみ、手動 ACK および NACK 操作を実行するために使用される肯定応答トークン。

サーキットブレーカー

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

On Error Types (エラー時種別)

String (文字列)

フローの実行中に発生したサーキットの障害と同等のエラー種別。デフォルトでは、すべてのエラーが障害とみなされます。

Errors Threshold (エラーしきい値)

Number (数値)

サーキットで考慮される、サーキットがオープンになるのに発生する必要があるエラーの回数。

x

Trip Timeout (トリップタイムアウト)

Number (数値)

errorsThreshold​ に達してからサーキットがオープンのままである期間。

x

Trip Timeout Unit (トリップタイムアウト単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

tripTimeout 値にバインドされる時間単位。

MILLISECONDS (ミリ秒)

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

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

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームしてランダムにアクセスするために割り当てられるメモリ量。ストリームのデータ量がこのバッファサイズを超える場合は、bufferSizeIncrement 属性に従って、maxInMemorySize を上限としてバッファが拡張されます。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズをどれだけ拡張できるか。0 以下に設定した場合、バッファがフルになると ​STREAM_MAXIMUM_SIZE_EXCEEDED​ が発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

STREAM_MAXIMUM_SIZE_EXCEEDED​ が発生する前に使用できるメモリの最大量。0 以下に設定した場合、メモリは無制限になります。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

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

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

コンテンツがディスクにバッファされる前にストリームがローカルに保持できるメモリの最大量。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE

  • KB

  • MB

  • GB

maxInMemorySize で表される単位。

Redelivery Policy (再配信ポリシー)

再配信ポリシーについての詳細は、​「再配信ポリシーの設定」​を参照してください。

Anypoint MQ Message Publish Attributes (Anypoint MQ メッセージのパブリッシュ属性)

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

Message Id (メッセージ ID)

String (文字列)

パブリッシュされたメッセージの ID。

x

プリフェッチ

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

Max Local Messages (最大ローカルメッセージ数)

Number (数値)

サービスからプリフェッチされ、フローにディスパッチされる前にローカルに保持されるメッセージの最大数。

30

ポーリング

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

Fetch size (フェッチサイズ)

Number (数値)

ポーリングの実行ごとにフェッチするメッセージの最大数 (1 ~ 10)。

10 よりも大きい値を設定すると、エラーが発生します。

10

Scheduling Strategy (スケジュール戦略)

scheduling-strategy

サービスからのメッセージのフェッチをトリガーするスケジュール戦略。

x

一定間隔

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

Frequency (頻度)

Number (数値)

Polling frequency (ポーリング頻度)

1000ms

(1 秒)

Start delay (開始遅延)

Number (数値)

開始前にスケジューラーが待機する時間。

10

Time unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • DAYS (日)

  • HOURS (時間)

  • MINUTES (分)

  • SECONDS (秒)

  • MILLISECONDS (ミリ秒)

startDelay​ 設定で使用する時間単位。

MILLISECONDS (ミリ秒)

Cron

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

Expression (式)

Cron 式

x

Time Zone (タイムゾーン)

String (文字列)

式が基づくタイムゾーンの ID。

関連情報