Anypoint MQ コネクタリファレンス

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

Anypoint MQ コネクタのバージョン 2.0.5

2018 年 11 月 2 日

設定


デフォルトのサブスクライバ

パラメータ

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

Name (名前)

String (文字列)

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

x

Connection (接続)

この設定に指定できる接続種別。

x

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

ランタイムで有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最小時間を設定します。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。必要に応じてインスタンスが実際にパージされます。

Acknowledgement Mode (肯定応答モード)

Enumeration (列挙)、​SubscriberAckMode:

  • IMMEDIATE (即時)

  • AUTO (自動)

  • MANUAL (手動)

サブスクライバによって取得されたメッセージに使用する肯定応答モード。これは、Subscriber ソースにのみ影響し、コンシューム操作には関係ありません。各戦略の詳細は、「SubscriberAckMode」を参照してください。

AUTO (自動)

Acknowledgement Timeout (肯定応答タイムアウト)

Number (数値)

肯定応答または否定応答を待機しているブローカーによってメッセージが保持される期間を示します。タイムアウトを超える前に ACK と NACK のどちらも発生しなければ、メッセージは自動的にブローカーによって宛先に戻され、任意のサブスクライバに再配信できるようになります。デフォルトでは、このタイムアウトは使用される戦略に応じてサブスクライバが決定します。ポーリングを行っている場合、ACK タイムアウトはキューで設定されたものになります。プリフェッチ戦略を使用している場合、メッセージはフローにディスパッチされるまでローカルバッファ内で保持されます。メッセージが除去されるのを避けるために存続期間 (TTL) を更新することができます。デフォルトでは、メッセージは最低 2 分間の TTL でフェッチされます。

0

Polling Time (ポーリング時間)

Number (数値)

プリフェッチが無効になっている場合、ポーリング時間はサブスクライバが新規メッセージをチェックする頻度を定義します。デフォルトでは、メッセージは 1 秒毎にチェックされます (プリフェッチが無効の場合のみ)。このパラメータの値はミリ秒で定義されます。

1000

Max Redelivery (最大再配信数)

Number (数値)

特定のメッセージで受け入れられる再配信の数。メッセージの再配信数がこのしきい値を超えると、サブスクライバによってメッセージは無視され、フローにディスパッチされません。キューからメッセージが削除されるようにするには、管理コンソールからキューにデッドレターキューを設定する必要があります。

-1

Fetch Size (フェッチサイズ)

Number (数値)

各要求で受信するメッセージの最大数。対象のキューの負荷に応じて、応答にはこの数値より少ない数のメッセージを含めることができます。また、この数値はプリフェッチされたメッセージのローカルバッファにも影響します。この fetchSize を 0 に設定すると、メッセージのプリフェッチが無効になります。プリフェッチバッファの目標サイズは fetchSize の 3 倍です。つまり、メッセージを取得する要求は、ローカルバッファがいっぱいにならない限り続きます。バッファ制限に達するのは、Mule Runtime に要求の処理に使用できるスレッドがなくなるような、処理の遅いコンシューマのみです。メッセージ配信で高いパフォーマンスが必要な場合は、最大スループットでプリフェッチを有効にします。メッセージ取得を制御する必要がある場合は、プリフェッチを無効にし、固定ポーリング設定を使用することができます。デフォルトでは、1 つの要求で最大 10 個のメッセージのフェッチを試みます。

10

Fetch Timeout (フェッチタイムアウト)

Number (数値)

必要量のメッセージを待機する最大期間 (ミリ秒)。この期間が経過すると、期間中に受信した数のメッセージを含む応答が送信されます。

1000

Frequency (頻度)

Number (数値)

ローカルに処理するメッセージがなくなったときにメッセージの取得を試みる固定頻度 (ミリ秒)。キューが空で、取得したメッセージがすでにすべて処理されている場合、この頻度は追加メッセージの取得を試みるまでの待機期間を定義します。デフォルトでは、この頻度は 5 秒 (5000 ミリ秒) です。

5000

接続種別

Connection (接続)

パラメータ

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

URL

String (文字列)

キューが配置されるリージョンの URL。この URL は、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)] 項目で [Copy (コピー)] をクリックします。この値を Anypoint Studio の [Client App ID (クライアントアプリケーション ID)] 項目に貼り付けます。

x

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

String (文字列)

Anypoint Platform の [MQ] > [Client Apps (クライアントアプリケーション)] で、アプリケーション名をクリック (または新しいアプリケーションを作成) して、[Client Secret (クライアントシークレット)] 項目で [Copy (コピー)] をクリックします。この値を Studio の [Client Secret (クライアントシークレット)] 項目に貼り付けます。

x

Proxy Config (プロキシ設定)

TCP Client Socket Properties (TCP クライアントソケットのプロパティ)

TLS Context (TLS コンテキスト)

TLS

Reconnection (再接続)

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。trure に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

関連操作

関連付けられたソース

操作

Ack

<anypoint-mq:ack>

特定の Anypoint MQ Message Context (Anypoint MQ メッセージコンテキスト) に対して、メッセージが適切にコンシュームされたことを示す肯定応答 (ack) を実行し、In Flight (インフライト) 状況からメッセージを削除します。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Message Context (メッセージコンテキスト)

受信されたメッセージを表す AnypointMQMessageContext。

x

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略。

スロー

  • ANYPOINT-MQ:UNKNOWN

  • ANYPOINT-MQ:RETRY_EXHAUSTED

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:RESOURCE_NOT_FOUND

Consume

<anypoint-mq:consume>

Anypoint MQ キューからメッセージをコンシュームします。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージのフェッチ元であるキューまたはメッセージ交換の名前。

x

Acknowledgement Mode (肯定応答モード)

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

  • IMMEDIATE (即時)

  • MANUAL (手動)

このサブスクライバから取得したメッセージに使用する肯定応答モード。指定できるのは 'MANUAL' か 'NONE’ のみです。

MANUAL (手動)

Polling Time (ポーリング時間)

Number (数値)

要求したメッセージをコンシュームする準備ができていない場合に待機する期間 (ミリ秒)。

10000

Acknowledgement Timeout (肯定応答タイムアウト)

Number (数値)

肯定応答 (ack) または否定応答 (nack) を待機しているブローカーによってメッセージが保持される期間。その期間の期限が切れた後、任意のサブスクライバがメッセージを再び利用できるようになります。

0

Output Mime Type (出力 Mime の種類)

String (文字列)

この操作で出力されるペイロードの MIME の種類。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

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

繰り返し可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略。

スロー

  • ANYPOINT-MQ:UNKNOWN

  • ANYPOINT-MQ:RETRY_EXHAUSTED

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:RESOURCE_NOT_FOUND

Nack

<anypoint-mq:nack>

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

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Message Context (メッセージコンテキスト)

受信されたメッセージを表す AnypointMQMessageContext。

x

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略。

スロー

  • ANYPOINT-MQ:UNKNOWN

  • ANYPOINT-MQ:RETRY_EXHAUSTED

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:RESOURCE_NOT_FOUND

Publish

<anypoint-mq:publish>

Anypoint MQ キューまたはメッセージ交換にメッセージをパブリッシュします。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージのフェッチ元であるキューまたはメッセージ交換の名前。

x

Body (本文)

Binary (バイナリ)

メッセージの本文。

#[payload]

Message Id (メッセージ ID)

String (文字列)

パブリッシュするメッセージの ID。

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

Boolean (ブール)

Mule メッセージのコンテンツタイプを添付するかどうかを示します。

true

Properties (プロパティ)

Object (オブジェクト)

メッセージ内で送信される追加のプロパティ。

Output Mime Type (出力 Mime の種類)

String (文字列)

この操作で出力されるペイロードの MIME の種類。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

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

繰り返し可能なストリームを使用するかどうかと、それらの動作を設定します。

Target Variable (対象変数)

String (文字列)

操作の出力が格納される変数の名前。

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略。

スロー

  • ANYPOINT-MQ:UNKNOWN

  • ANYPOINT-MQ:RETRY_EXHAUSTED

  • ANYPOINT-MQ:CONNECTIVITY

  • ANYPOINT-MQ:RESOURCE_NOT_FOUND

Sources (ソース)

Subscriber

<anypoint-mq:subscriber>

指定した宛先名からメッセージを取得します。

パラメータ

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

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

x

Output Mime Type (出力 Mime の種類)

String (文字列)

この操作で出力されるペイロードの MIME の種類。

Output Encoding (出力エンコード)

String (文字列)

この操作で出力されるペイロードのエンコード。

Redelivery Policy (再配信ポリシー)

同じメッセージの再配信を処理するためのポリシー。

Reconnection Strategy (再接続戦略)

接続エラー時の再試行戦略。

出力

バイナリ

属性型

AnypointMQMessageContext

SubscriberAckMode

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

IMMEDIATE (即時)

String (文字列)

メッセージがフローにディスパッチされるとすぐに肯定応答されます。フローの実行中にメッセージの処理が失敗した場合、アプリケーションによって処理される必要があります。

AUTO (自動)

String (文字列)

メッセージを処理するフローが正常に終了した場合にのみ肯定応答されます。フローの実行中にエラーが伝達されると実行はエラーで終了し、サブスクライバリスナはメッセージを否定応答することで実質的に再配信のために宛先に戻します。肯定応答 TTL が除去される前にフロー処理が終了しない場合、メッセージは再配信のためにブローカーによって自動的に宛先に戻されます。

MANUAL (手動)

String (文字列)

サブスクライバはメッセージの肯定応答のどの側面も処理しません。メッセージが処理のためにフローにディスパッチされたら、ACK または NACK のいずれかの実行はアプリケーションによって行われます。肯定応答 TTL が除去される前に何も行われなければ、メッセージは再配信のためにブローカーによって自動的に宛先に戻されます。

Anypoint MQ Message Context (Anypoint MQ メッセージコンテキスト)

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

destination (宛先)

String (文字列)

メッセージがコンシュームされた宛先の名前。

message (メッセージ)

Anypoint MQ Message (Anypoint MQ メッセージ)

コンシュームされるメッセージに関するメタデータ。

Anypoint MQ Message (Anypoint MQ メッセージ)

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

id (ID)

String (文字列)

メッセージの ID。

x

lockId (ロック ID)

Number (数値)

インフライト状態のメッセージのロックを更新するために使用される ID。

x

deliveryCount (配信数)

Number (数値)

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

x

properties (プロパティ)

Map (マップ)

メッセージのカスタムプロパティ。メッセージ本文に関連する追加情報をポートするのに使用されます。

headers (ヘッダー)

Map (マップ)

メッセージのヘッダー。作成日時や配信数など、ブローカーが提供する情報が含まれます。

Proxy Parameter Group (プロキシパラメータグループ)

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

Host (ホスト)

String (文字列)

Port (ポート)

Number (数値)

Username (ユーザ名)

String (文字列)

Password (パスワード)

String (文字列)

TCP Client Socket Parameter Group (TCP クライアントソケットのパラメータグループ)

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

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

Number (数値)

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

Number (数値)

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

Number (数値)

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

Boolean (ブール)

true

Linger (リンガー)

Number (数値)

Keep Alive (キープアライブ)

Boolean (ブール)

false

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

Number (数値)

30000

TLS

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (信頼ストア)

Key Store (キーストア)

Trust Store (信頼ストア)

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

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 (文字列)

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

Reconnection (再接続)

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

Fails Deployment (デプロイに失敗)

Boolean

アプリケーションがデプロイされたときに、すべてのコネクタで接続テストが実行されます。trure に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

Count (カウント)

Number (数値)

再接続の試行回数。

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

再接続の頻度 (ミリ秒)。

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

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

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

Number (数値)

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

Time Unit (時間単位)

Enumeration (列挙)。次のいずれか:

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時)

  • DAYS (日)

maxIdleTime 属性に使用できる時間単位。

Redelivery Policy (再配信ポリシー)

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

Max Redelivery Count (最大再配信数)

Number (数値)

正常に処理されずにプロセス失敗メッセージがトリガされるまでにメッセージを再配信できる最大回数。

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

Boolean (ブール)

再配信されたメッセージの識別にセキュアハッシュアルゴリズムを使用するかどうか。

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

String (文字列)

使用するセキュアハッシュアルゴリズム。設定しない場合、デフォルトの SHA-256 になります。

Id Expression (ID 式)

String (文字列)

メッセージがいつ再配信されたのかを判断するために使用する 1 つ以上の式を定義します。このプロパティは、useSecureHash が false の場合にのみ設定できます。

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

ObjectStore

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

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 で表される単位。

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

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

Message id (メッセージ ID)

String (文字列)

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

x

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub