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

IBM MQ Connector v1.7

このコネクタのメインクラスを提供します。これは、設定、接続プロバイダー、操作、およびソースを宣言するエントリポイントです。

設定


設定

デフォルトの設定です。

パラメーター

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

Name (名前)

String (文字列)

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

x

Connection (接続)

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

x

Encoding (エンコード)

String (文字列)

メッセージにエンコードが指定されていない場合のメッセージ本文のデフォルトエンコード。

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

String (文字列)

メッセージにコンテンツタイプが指定されていない場合のメッセージ本文のデフォルトコンテンツタイプ。

/

Send Correlation Id (送信相関 ID)

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

  • AUTO

  • ALWAYS

  • NEVER

メッセージをパブリッシュするときに ​correlationId​ を指定するかどうか。操作レベルで指定されるカスタム相関 ID と、現在のイベントから引用されるデフォルト相関 ID の両方に適用されます。

AUTO

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

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

Ack Mode (肯定応答モード)

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

  • IMMEDIATE

  • AUTO

  • MANUAL

  • DUPS_OK

メッセージをコンシュームするときに使用するセッション肯定応答モード。

AUTO

Consumer Type (コンシューマー種別)

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

Selector (セレクター)

String (文字列)

受信メッセージの絞り込みに使用するデフォルトの JMS セレクター。

Persistent Delivery (永続的な配信)

Boolean (ブール)

true の場合、メッセージは PERSISTENT ​JMSDeliveryMode​ を使用して送信されます。

false

Priority (優先度)

Number (数値)

メッセージを送信するときに使用するデフォルトの ​JMSPriority​ 値。

4

Time To Live (存続期間)

Number (数値)

メッセージが期限切れになって破棄されるまでブローカーに残るデフォルトの時間を定義します。

0

Time To Live Unit (存続期間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

MILLISECONDS

Disable Message Id (メッセージ ID の無効化)

Boolean (ブール)

true の場合、MessageID を生成しないようにメッセージにフラグが付けられます。

false

Disable Message Timestamp (メッセージタイムスタンプの無効化)

Boolean (ブール)

true の場合、送信タイムスタンプを生成しないようにメッセージにフラグが付けられます。

false

Delivery Delay (配信遅延)

Number (数値)

JMS 2.0 のみで使用: メッセージの配信を遅らせるための配信遅延時間を設定します。

Delivery Delay Unit (配信遅延単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

JMS 2.0 のみで使用: deliveryDelay 設定で使用する時間単位。

MILLISECONDS

Jms Type (JMS 種別)

String (文字列)

メッセージが送信されるときに JMSType ヘッダーで設定されるメッセージ種別の識別子。

接続種別

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

接続モード

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

x

Username (ユーザー名)

String (文字列)

IBM MQ サーバーに接続するために使用するユーザー名。

Password (パスワード)

String (文字列)

使用するユーザー名のパスワード。

Client ID (クライアント ID)

String (文字列)

現在のクライアントを識別するために使用する JMS クライアントの ID。

CSS ID

Number (数値)

キューマネージャーに接続するときに使用する数字。ほとんどの場合、デフォルト値 (819) で問題ありません。

Additional Properties (追加プロパティ)

Object (オブジェクト)

IBM MQ クライアントを設定するための追加のプロパティ。

キャッシュ戦略

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

セッションと接続のキャッシュに使用する戦略。

Enable XA Transactions (XA トランザクションの有効化)

Boolean (ブール)

XA トランザクションの作成と結合をサポートしており、複数リソースのトランザクションに関与できます。

IBM MQ Connector では、IBM MQ ドライバーの制限により、ネストされた XA トランザクションはサポートされません。

false

Specification (仕様)

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

  • JMS_2_0​

  • JMS_1_1

JMS クライアントの JMS 仕様のバージョン。

JMS_2_0

Target Client (対象クライアント)

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

  • JMS_COMPLIANT​

  • NO_JMS_COMPLIANT

IBM MQ JMS クライアントの作成方法。​JMS_COMPLIANT​ を指定すると、RFH2 形式を使用して情報が送信されます。RFH2 ヘッダーには、メッセージコンテンツに関連した JMS 特有のデータが格納されます。​JMS_COMPLIANT​ を指定しないと、ユーザープロパティやメディア種別の伝播などの機能が無効になります。

JMS_COMPLIANT

Application Name (アプリケーション名)

String (文字列)

接続ファクトリに登録されるアプリケーション名。デフォルトでは、アプリケーション名がそのまま使用されます。27 文字以内で指定できます。

Read Message Descriptor (MD) (メッセージディスクリプター (MD) の読み取り)

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

  • ENABLED

  • DISABLED

メッセージディスクリプタープロパティの読み取りが有効かどうか。

ENABLED

Write Message Descriptor (MD) (メッセージディスクリプター (MD) の書き込み)

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

  • ENABLED

  • DISABLED

メッセージディスクリプタープロパティの書き込みが有効かどうか。

ENABLED

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

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

  • DEFAULT

  • SET_ALL_CONTEXT​

  • SET_IDENTITY_CONTEXT

メッセージオプションを設定するためのメッセージコンテキスト。

  • DEFAULT: オプションは設定できません。

  • SET_ALL_CONTEXT​: すべてのオプションを設定できます。

  • SET_IDENTITY_CONTEXT​: アイデンティティオプションのみ設定できます。

DEFAULT

Temporary Model (一時モデル)

String (文字列)

永続的な動的キューを作成するために使用できるモデルキューを意味する IBM MQ モデルキューの名前。

Temporal Queue Prefix (一時キュープレフィックス)

String (文字列)

一時キュー名を作成する際に使用するプレフィックス。最後の空白以外の文字はアスタリスク (​*​) である必要があります。

Temporal Topic Prefix (一時トピックプレフィックス)

String (文字列)

一時トピック名を作成する際に使用するプレフィックス。最後の空白以外の文字はアスタリスク (​*​) である必要があります。

Receive Exit Handler (受信終了ハンドラー)

String (文字列)

受信終了ハンドラークラス。IBM MQ Java で使用する終了ハンドラーを作成する場合、各オブジェクトにも 1 つの文字列引数を取るコンストラクターが必要です。IBM MQ が終了ハンドラーのインスタンスを作成する際には、このコンストラクターを使用して初期化データを終了ハンドラーに渡します。

Receive Exit Handler Init (受信終了ハンドラー初期化)

String (文字列)

受信終了の初期化文字列。

Send Exit Handler (送信終了ハンドラー)

String (文字列)

送信終了ハンドラークラス。IBM MQ Java で使用する終了ハンドラーを作成する場合、各オブジェクトにも 1 つの文字列引数を取るコンストラクターが必要です。IBM MQ が終了ハンドラーのインスタンスを作成する際には、このコンストラクターを使用して初期化データを終了ハンドラーに渡します。

Send Exit Handler Init (送信終了ハンドラー初期化)

String (文字列)

送信終了の初期化文字列。

Security Exit Handler (セキュリティ終了ハンドラー)

String (文字列)

セキュリティ終了ハンドラークラス。IBM MQ Java で使用する終了ハンドラーを作成する場合、各オブジェクトにも 1 つの文字列引数を取るコンストラクターが必要です。IBM MQ が終了ハンドラーのインスタンスを作成する際には、このコンストラクターを使用して初期化データを終了ハンドラーに渡します。

Security Exit Handler Init (セキュリティ終了ハンドラー初期化)

String (文字列)

セキュリティ終了の初期化文字列。

Min Pool Size (最小プールサイズ)

Number (数値)

XA 接続プールの最小サイズ。

4

Max Pool Size (最大プールサイズ)

Number (数値)

XA 接続プールの最大サイズ。

32

Max Idle Seconds (最大アイドル秒)

Number (数値)

XA トランザクション接続が除去対象となるまでアイドル状態を維持できる秒数。

60

IBM MQ CipherSpec Mapping (IBM MQ CipherSpec マッピング)

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

  • ORACLE_CIPHER_SUITES​

  • IBM_CIPHER_SUITES​

  • NONE

Oracle JDK と IBM JDK のどちらの CipherSuite マッピングを使用するかを定義します。ホスト JDK に応じてこのパラメーターを設定します。詳細は、 「SSL/TLS CipherSpecs および CipherSuites」​を参照してください。

ORACLE_CIPHER_SUITES

IBM Cipher Suite (IBM 暗号化スイート)

String (文字列)

IBM MQ サーバーに接続するために使用する CipherSuite。

Reset Count (リセット数)

Number (数値)

このプロパティは、暗号化で使用するシークレットキーが再ネゴシエートされるまでに、接続により送受信された合計バイト数を表します。0 (無効) ~ 999999999 の整数値。

Peer Name (ピア名)

String (文字列)

識別名パターンを指定して、JMS アプリケーションが正しいキューマネージャーに接続されるようにします。

FIPS Required (必要な FIPS)

Boolean (ブール)

IBM Java JSSE FIPS プロバイダー (IBMJSSEFIPS) でサポートされる暗号化スイートを接続で使用する必要がある場合、有効にします。

false

Cert Stores (証明書ストア)

String (文字列)

証明書失効リスト (CRL) の確認で使用する LDAP サーバーのリストを指定します。

TLS Context

TLS

Reconnection (再接続)

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

ソース

Consume

<ibm-mq:consume>

特定の宛先から単一のメッセージをユーザーがコンシュームできるようにします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージをコンシュームする宛先の名前。

x

Consumer Type (コンシューマー種別)

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

特定の宛先に必要な MessageConsumer の種別と、宛先種別に基づいて必要となるその他の設定。

Ack Mode (肯定応答モード)

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

  • IMMEDIATE

  • MANUAL

メッセージとセッションで設定する ConsumerAckMode。

Selector (セレクター)

String (文字列)

メッセージの絞り込みに使用するカスタム JMS セレクター。

Maximum Wait (最大待機)

Number (数値)

タイムアウトとなる前にメッセージを待つ最大時間。

10000

Maximum Wait Unit (最大待機単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

MILLISECONDS (ミリ秒)

Transactional Action (トランザクションアクション)

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

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

トランザクションに関する操作で実行できる結合アクションの種別。

JOIN_IF_POSSIBLE

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

String (文字列)

受信したメッセージのコンテンツタイプ。メッセージで指定されている場合は、この設定は上書きされます。

Encoding (エンコード)

String (文字列)

受信したメッセージのエンコード。メッセージで指定されている場合は、この設定は上書きされます。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • IBM-MQ:ACK

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:CONSUMING

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

  • IBM-MQ:TIMEOUT

Publish

<ibm-mq:publish>

ユーザーがメッセージを JMS 宛先に送信できるようにします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージの送信先となる宛先の名前。

x

Destination Type (宛先種別)

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

  • QUEUE

  • TOPIC

宛先の MQDestinationType。

QUEUE

Transactional Action (トランザクションアクション)

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

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

操作のトランザクションアクション。パブリッシュをトランザクションとして実行するかどうかを指定します。

JOIN_IF_POSSIBLE

Send Correlation Id (送信相関 ID)

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

  • AUTO

  • ALWAYS

  • NEVER

アウトバウンド相関 ID を含めるかどうかのオプション。

Body (本文)

Any (任意)

メッセージの本文。

#[payload]

JMS Type (JMS 種別)

String (文字列)

メッセージの JMSType 識別子ヘッダー。

Correlation ID (相関 ID)

String (文字列)

メッセージの JMSCorrelationID ヘッダー。

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

Boolean (ブール)

本文のコンテンツタイプをプロパティとして送信するかどうか。

true

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

String (文字列)

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

Send Encoding (エンコードの送信)

Boolean (ブール)

本文の outboundEncoding をメッセージのプロパティとして送信するかどうか。

true

Encoding (エンコード)

String (文字列)

メッセージ本文のエンコード。

Reply To (返信先)

このメッセージへの応答を送信する宛先。

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

Object (オブジェクト)

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

JMSX Properties (JMSX プロパティ)

このメッセージに設定される JMSX プロパティ。

Persistent Delivery (永続的な配信)

Boolean (ブール)

true の場合、メッセージは PERSISTENT JMSDeliveryMode を使用して送信されます。

Priority (優先度)

Number (数値)

メッセージを送信するときに使用するデフォルトの JMSPriority 値。

Time To Live (存続期間)

Number (数値)

メッセージが期限切れになって破棄されるまでブローカーに残るデフォルトの時間を定義します。

Time To Live Unit (存続期間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Disable Message Id (メッセージ ID の無効化)

Boolean (ブール)

true の場合、MessageID を生成しないようにメッセージにフラグが付けられます。

Disable Message Timestamp (メッセージタイムスタンプの無効化)

Boolean (ブール)

true の場合、送信タイムスタンプを生成しないようにメッセージにフラグが付けられます。

Delivery Delay (配信遅延)

Number (数値)

JMS 2.0 でのみ使用。メッセージの配信を遅らせるための配信遅延時間を設定します。

Delivery Delay Unit (配信遅延単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Reconnection Strategy (再接続戦略)

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

次の設定の場合

スロー

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:ILLEGAL_BODY

  • IBM-MQ:PUBLISHING

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

Publish Consume

<ibm-mq:publish-consume>

ユーザーが JMS 宛先にメッセージを送信し、指定された ReplyTo 宛先または動的に作成される一時的な宛先への応答を待機できるようします。

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージの送信先となる宛先の名前。

x

Request-Reply Pattern (要求-応答パターン)

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

  • CORRELATION_ID​

  • MESSAGE_ID​

  • NONE

要求メッセージと応答メッセージの相関方法を示します。これにより、受信メッセージが送信メッセージの正しい応答であることが保証されます。

* CORRELATION_ID​ パターン値は、​Publish Consume​ 操作で使用されます。この操作では、要求メッセージを宛先キューにパブリッシュした後に、要求メッセージと同じ相関 ID のメッセージを想定します。その後、その相関している応答メッセージをコンシュームします。

* MESSAGE_ID​ パターン値は、​Publish Consume​ 操作で使用されます。この操作では、要求メッセージを宛先キューにパブリッシュした後に、要求メッセージのメッセージ ID と同じ値の相関 ID のメッセージを想定します。その後、その相関している応答メッセージをコンシュームします。

CORRELATION_ID

Send Correlation ID (送信相関 ID)

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

アウトバウンド相関 ID を含めるかどうかのオプション。

Body (本文)

Any (任意)

メッセージの本文。

#[payload]

JMS Type (JMS 種別)

String (文字列)

メッセージの JMSType 識別子ヘッダー。

Correlation ID (相関 ID)

String (文字列)

メッセージの JMSCorrelationID ヘッダー。

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

Boolean (ブール)

本文のコンテンツタイプをプロパティとして送信するかどうか。

true

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

String (文字列)

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

Send Encoding (エンコードの送信)

Boolean (ブール)

本文の outboundEncoding をメッセージのプロパティとして送信するかどうか。

true

Encoding (エンコード)

String (文字列)

メッセージ本文のエンコード。

Reply To (返信先)

このメッセージへの応答を送信する宛先。

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

Object (オブジェクト)

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

JMSX Properties (JMSX プロパティ)

このメッセージに設定される JMSX プロパティ。

Persistent Delivery (永続的な配信)

Boolean (ブール)

true の場合、メッセージは PERSISTENT JMSDeliveryMode を使用して送信されます。

Priority (優先度)

Number (数値)

メッセージを送信するときに使用するデフォルトの JMSPriority 値。

Time To Live (存続期間)

Number (数値)

メッセージが期限切れになって破棄されるまでブローカーに残るデフォルトの時間を定義します。

Time To Live Unit (存続期間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Disable Message Id (メッセージ ID の無効化)

Boolean (ブール)

true の場合、MessageID を生成しないようにメッセージにフラグが付けられます。

Disable Message Timestamp (メッセージタイムスタンプの無効化)

Boolean (ブール)

true の場合、送信タイムスタンプを生成しないようにメッセージにフラグが付けられます。

Delivery Delay (配信遅延)

Number (数値)

JMS 2.0 でのみ使用。メッセージの配信を遅らせるための配信遅延時間を設定します。

Delivery Delay Unit (配信遅延単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Ack Mode (肯定応答モード)

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

  • IMMEDIATE

  • MANUAL

メッセージをコンシュームするときに使用するセッション肯定応答モード。

IMMEDIATE

Maximum Wait (最大待機)

Number (数値)

タイムアウトとなる前にメッセージの到着を待つ最大時間。

10000

Maximum Wait Unit (最大待機単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

MILLISECONDS (ミリ秒)

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

String (文字列)

コンシュームするメッセージ本文のコンテンツタイプ。

Encoding (エンコード)

String (文字列)

コンシュームするメッセージ本文のエンコード。

Target Variable (対象変数)

String (文字列)

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

Target Value (対象値)

String (文字列)

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

#[payload]

Reconnection Strategy (再接続戦略)

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

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

スロー

  • IBM-MQ:ACK

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:CONSUMING

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:ILLEGAL_BODY

  • IBM-MQ:PUBLISHING

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

  • IBM-MQ:TIMEOUT

Ack

<ibm-mq:ack>

メッセージのコンシューム中に AckMode#MANUAL モードが選択された場合にユーザーが肯定応答を実行できるようにします。JMS 仕様に従い、単一のメッセージに対する肯定応答は自動的に同じ JmsSession で生成されるすべてのメッセージの肯定応答として機能します。

パラメーター

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

Ack Id

String (文字列)

肯定応答するメッセージの AckId。

x

スロー

  • IBM-MQ:ACK

Recover Session

<ibm-mq:recover-session>

メッセージのコンシューム中に AckMode#MANUAL モードが選択された場合にユーザーがセッション回復を実行できるようにします。JMS 仕様の定義により、セッションリカバリーを実行すると、そのリカバリー以前にコンシュームされていて肯定応答されていなかったすべてのメッセージが再配信されます。

パラメーター

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

Ack Id

String (文字列)

リカバリーするメッセージセッションの AckId。

x

スロー

  • IBM-MQ:SESSION_RECOVER

ソース

On New Message

<ibm-mq:listener>

パラメーター

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

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Destination (宛先)

String (文字列)

メッセージをコンシュームする宛先の名前。

x

Consumer Type (コンシューマー種別)

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

指定された宛先で使用するコンシューマーの種別。

Ack Mode (肯定応答モード)

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

  • IMMEDIATE

  • AUTO

  • MANUAL

  • DUPS_OK

メッセージをコンシュームするときに使用するセッション肯定応答モード。

Selector (セレクター)

String (文字列)

受信メッセージの絞り込みに使用する JMS セレクター。

Number Of Consumers (コンシューマーの数)

Number (数値)

JMS メッセージを受信するために使用する同時コンシューマー数。

4

Transactional Action (トランザクションアクション)

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

  • ALWAYS_BEGIN​

  • NONE

ソースがトランザクションに関して実行できる開始アクションの種別。

NONE

Transaction Type (トランザクション種別)

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

  • LOCAL

  • XA

作成するトランザクションの種別。使用できるかどうかは、Runtime バージョンによって決まります。

LOCAL

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

Boolean (ブール)

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

true

Redelivery Policy (再配信ポリシー)

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

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

String (文字列)

受信したメッセージのコンテンツタイプを設定します。メッセージにすでにコンテンツタイプが指定されている場合は、その設定は上書きされます。

Encoding (エンコード)

String (文字列)

受信したメッセージのエンコードを設定します。メッセージで指定されている場合は、その設定は上書きされます。

Reconnection Strategy (再接続戦略)

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

Ignore JMS replyTo header (JMS replyTo ヘッダーを無視)

Boolean (ブール)

宛先ヘッダーが含まれるメッセージの自動応答が必要ない場合は True

false

Body (本文)

Any (任意)

メッセージの本文。

#[payload]

JMS Type (JMS 種別)

String (文字列)

メッセージの JMSType 識別子ヘッダー。

Correlation ID (相関 ID)

String (文字列)

メッセージの JMSCorrelationID ヘッダー。

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

Boolean (ブール)

本文のコンテンツタイプをプロパティとして送信するかどうか。

true

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

String (文字列)

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

Send Encoding (エンコードの送信)

Boolean (ブール)

本文の outboundEncoding をメッセージのプロパティとして送信するかどうか。

true

Encoding (エンコード)

String (文字列)

メッセージ本文のエンコード。

Reply To (返信先)

このメッセージへの応答を送信する宛先。

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

Object (オブジェクト)

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

JMSX Properties (JMSX プロパティ)

このメッセージに設定される JMSX プロパティ。

Persistent Delivery (永続的な配信)

Boolean (ブール)

配信を永続的な設定で行うかどうか。

Priority (優先度)

Number (数値)

メッセージを送信するときに使用するデフォルトの JMSPriority 値。

Time To Live (存続期間)

Number (数値)

メッセージが期限切れになって破棄されるまでブローカーに残るデフォルトの時間を定義します。

Time To Live Unit (存続期間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Disable Message Id (メッセージ ID の無効化)

Boolean (ブール)

true の場合、MessageID を生成しないようにメッセージにフラグが付けられます。

Disable Message Timestamp (メッセージタイムスタンプの無効化)

Boolean (ブール)

true の場合、送信タイムスタンプを生成しないようにメッセージにフラグが付けられます。

Delivery Delay (配信遅延)

Number (数値)

JMS 2.0 でのみ使用。メッセージの配信を遅らせるための配信遅延時間を設定します。

Delivery Delay Unit (配信遅延単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

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

Send Correlation ID (送信相関 ID)

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

  • AUTO

  • ALWAYS

  • NEVER

アウトバウンド相関 ID を含めるかどうかのオプション。

Request Reply Pattern (要求応答パターン)

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

  • CORRELATION_ID​

  • MESSAGE_ID​

  • NONE

要求メッセージと応答メッセージの相関方法を示します。これにより、受信メッセージが送信メッセージの正しい応答であることが保証されます。

* CORRELATION_ID​ パターン値は、​Publish Consume​ 操作で使用されます。この操作では、要求メッセージを宛先キューにパブリッシュした後に、要求メッセージと同じ相関 ID のメッセージを想定します。その後、その相関している応答メッセージをコンシュームします。

* MESSAGE_ID​ パターン値は、​Publish Consume​ 操作で使用されます。この操作では、要求メッセージを宛先キューにパブリッシュした後に、要求メッセージのメッセージ ID と同じ値の相関 ID のメッセージを想定します。その後、その相関している応答メッセージをコンシュームします。

CORRELATION_ID

出力

Any (任意)

Attributes Type (属性型)

次の設定の場合

TLS

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

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

String (文字列)

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

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

String (文字列)

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

Trust Store (トラストストア)

Key Store (キーストア)

Revocation Check (取り消し確認)

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

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

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

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

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

Boolean (ブール)

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

Prefer Crls (CRL を優先)

Boolean (ブール)

最初に OCSP ではなく CRL を試みます。

No Fallback (代替なし)

Boolean (ブール)

第 2 の確認方法 (以前に選択されていない方法) を使用しません。

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 (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

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

Frequency (頻度)

Number (数値)

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

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

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

true

Reconnect Forever (繰り返し再接続)

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

Frequency (頻度)

Number (数値)

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

blocking (ブロック)

Boolean (ブール)

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

true

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

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

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

Number (数値)

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

Time Unit (時間単位)

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

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位。

IBM MQ 属性

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

Properties (プロパティ)

Headers (ヘッダー)

Any (任意)

x

Ack Id

String (文字列)

JMS メッセージのプロパティ

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

すべて

Any (任意)

x

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

Any (任意)

x

Jms Properties (JMS プロパティ)

Any (任意)

x

Jmsx Properties (JMSX プロパティ)

JMSX Properties (JMSX プロパティ)

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

Jmsx User ID (JMSX ユーザー ID)

String (文字列)

Jmsx App ID (JMSX アプリケーション ID)

String (文字列)

Jmsx Delivery Count (JMSX 配信数)

Number (数値)

Jmsx Group ID (JMSX グループ ID)

String (文字列)

Jmsx Group Seq (JMSX グループシーケンス)

Number (数値)

Jmsx Producer TXID (JMSX プロデューサー TXID)

String (文字列)

Jmsx Consumer TXID (JMSX コンシューマー TXID)

String (文字列)

Jmsx Rcv Timestamp (JMSX 受信タイムスタンプ)

Number (数値)

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 (オブジェクトストア)

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

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

MQ JMS Destination (MQ JMS 宛先)

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

Destination (宛先)

String (文字列)

メッセージの送信先となる宛先の名前。

x

Destination Type (宛先種別)

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

  • QUEUE

  • TOPIC

この宛先の種別。

QUEUE

MQ JMSX Properties (MQ JMSX プロパティ)

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

Jmsx User ID (JMSX ユーザー ID)

String (文字列)

Jmsx App ID (JMSX アプリケーション ID)

String (文字列)

Jmsx Delivery Count (JMSX 配信数)

Number (数値)

Jmsx Group ID (JMSX グループ ID)

String (文字列)

Jmsx Group Seq (JMSX グループシーケンス)

Number (数値)

Jmsx Producer TXID (JMSX プロデューサー TXID)

String (文字列)

Jmsx Consumer TXID (JMSX コンシューマー TXID)

String (文字列)

Jmsx Rcv Timestamp (JMSX 受信タイムスタンプ)

Number (数値)

Topic Consumer (トピックコンシューマー)

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

Durable (永続的)

Boolean (ブール)

false

Shared (共有)

Boolean (ブール)

false

No Local (非ローカル)

Boolean (ブール)

false

Subscription Name (サブスクリプション名)

String (文字列)

Binding (バインディング)

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

Queue Manager (キューマネージャー)

String (文字列)

キューマネージャー名。

Client (クライアント)

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

Host (ホスト)

String (文字列)

IBM MQ ブローカーが存在するホスト。

x

Port (ポート)

Number (数値)

キューマネージャーのリスナーポート。

1414

Queue Manager (キューマネージャー)

String (文字列)

チャネル定義の選択時に使用するキューマネージャー。

Channel (チャネル)

String (文字列)

接続先のチャネル名。

Connection Name List (接続名リスト)

String (文字列)

接続が失われたときにクライアントが再接続を試みるホスト。接続名リストでは、ホストと IP ポートのペアをカンマで区切って指定します。

Default Caching (デフォルトキャッシュ)

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

Session Cache Size (セッションキャッシュサイズ)

Number (数値)

Cache Producers (キャッシュプロデューサー)

Boolean (ブール)

true

Cache Consumers (キャッシュコンシューマー)

Boolean (ブール)

true