WmqMessagingProvider (Nablarch-API)

java.lang.Object
- nablarch.integration.messaging.wmq.provider.WmqMessagingProvider

すべての実装されたインタフェース:

Initializable, MessagingProvider
```
public class WmqMessagingProvider
extends java.lang.Object
implements MessagingProvider, Initializable
```
WebSphere MQを使用したMessagingProviderの実装クラス。

コンストラクタのサマリー

コンストラクタ
コンストラクタと説明

WmqMessagingProvider()

コンストラクタ
コンストラクタと説明
`WmqMessagingProvider()`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`protected void`	`backout(com.ibm.mq.MQQueueManager mqQueueManager)` 分散トランザクションをバックアウトする。
`protected void`	`begin(com.ibm.mq.MQQueueManager mqQueueManager)` 分散トランザクションを開始する。
`protected void`	`checkPoisonSetting()` 退避キューの設定不備がないことをチェックする。
`protected void`	`checkXa()` 分散トランザクションを使用するに設定されていることをチェックする。
`protected void`	`close(java.util.Map<java.lang.String,com.ibm.mq.MQQueue> mqQueues)` 指定された全ての`MQQueue`をクローズする。
`protected void`	`close(com.ibm.mq.MQQueue mqQueue)` 指定された`MQQueue`をクローズする。
`protected void`	`commit(com.ibm.mq.MQQueueManager mqQueueManager)` 分散トランザクションをコミットする。
`MessagingContext`	`createContext()` `WmqMessagingContext`を生成する。
`protected com.ibm.mq.MQQueueManager`	`createMQQueueManager()` キューマネージャ名称を指定して`MQQueueManager`を生成する。
`protected void`	`disconnect(com.ibm.mq.MQQueueManager mqQueueManager)` `MQQueueManager`の接続を切断する。
`protected com.ibm.mq.MQGetMessageOptions`	`getGetMessageOptions(java.lang.String messageId, long timeout)` `MQQueue`からのメッセージ読み取りを制御するオプションを取得する。
`protected int`	`getGetSyncpointOption()` メッセージ読み取り時に使用する同期点オプションを取得する。
`protected java.sql.Connection`	`getJdbcConnection(com.ibm.mq.MQQueueManager mqQueueManager, javax.sql.XADataSource xaDataSource)` `MQQueueManager`から`Connection`を取得する。
`protected ReceivedMessage`	`getMessage(com.ibm.mq.MQQueue receivedMqQueue, java.lang.String messageId, long timeout, com.ibm.mq.MQQueue poisonMqQueue)` 指定された`MQQueue`から受信メッセージを読み込む。
`protected com.ibm.mq.MQQueue`	`getMQQueue(com.ibm.mq.MQQueueManager mqQueueManager, java.lang.String queueName, int openOptions)` 指定されたキュー名とオプションを使用して、正常にオープンされた`MQQueue`を取得する。
`protected java.util.Map<java.lang.String,com.ibm.mq.MQQueue>`	`getMQQueues(com.ibm.mq.MQQueueManager mqQueueManager, java.util.Collection<java.lang.String> queueNames, int openOptions)` 指定されたキュー名とオプションを使用して、正常にオープンされた`MQQueue`を取得する。
`protected int`	`getPoisonQueueOpenOptions()` ポイズンメッセージの退避先`MQQueue`のオープンを制御するオプションを取得する。
`protected com.ibm.mq.MQPutMessageOptions`	`getPutMessageOptions()` `MQQueue`へのメッセージ書き込みを制御するオプションを取得する。
`protected com.ibm.mq.MQPutMessageOptions`	`getPutPoisonMessageOptions()` `MQQueue`へのポイズンメッセージ書き込みを制御するオプションを取得する。
`protected int`	`getPutSyncpointOption()` メッセージ書き込み時に使用する同期点オプションを取得する。
`protected int`	`getReceivedQueueOpenOptions()` 受信先`MQQueue`のオープンを制御するオプションを取得する。
`protected int`	`getSendingQueueOpenOptions()` 送信先`MQQueue`のオープンを制御するオプションを取得する。
`void`	`initialize()` WebSphere MQの初期化処理を行う。
`protected boolean`	`isPoisonMessage(com.ibm.mq.MQMessage mqMessage)` 指定された`MQMessage`がポイズンメッセージであるか否かを判定する。
`protected void`	`processPoisonMessage(com.ibm.mq.MQQueue poisonMqQueue, com.ibm.mq.MQMessage mqMessage)` ポイズンメッセージの処理を行う。
`protected java.lang.String`	`putMessage(com.ibm.mq.MQQueue mqQueue, SendingMessage sendingMessage)` 送信メッセージを指定された`MQQueue`に書き込む。
`WmqMessagingProvider`	`setBackoutLimit(int backoutLimit)` バックアウト回数の上限値を設定する。
`WmqMessagingProvider`	`setBackoutLimitExceededExitCode(int backoutLimitExceededExitCode)` バックアウト上限を超えた場合に使用する終了コード(プロセスを終了(`System.exit(int)`)する際に設定する値)を設定する。
`WmqMessagingProvider`	`setBackoutLimitExceededFailureCode(java.lang.String backoutLimitExceededFailureCode)` バックアウト上限を超えた場合に使用する障害コードを設定する。
`MessagingProvider`	`setDefaultResponseTimeout(long defaultResponseTimeout)` デフォルトタイムアウト値(単位:msec)を設定する。
`MessagingProvider`	`setDefaultTimeToLive(long defaultTimeToLive)` 送信電文の有効期間(単位:msec)を設定する。
`WmqMessagingProvider`	`setMessagingExceptionFactory(MessagingExceptionFactory messagingExceptionFactory)` `MessagingException`ファクトリオブジェクトを設定する。
`WmqMessagingProvider`	`setMqmdFieldsOperator(WmqMqmdFieldsOperator mqmdFieldsOperator)` `WmqMqmdFieldsOperator`オブジェクトを設定する。
`void`	`setPoisonQueueName(java.lang.String poisonQueueName)` 退避キュー名(論理名)を設定する。
`void`	`setPoisonQueueNamePattern(java.lang.String poisonQueueNamePattern)` 退避キュー名パターン(論理名)を設定する。
`void`	`setPutPoisonFailedExitCode(int putPoisonFailedExitCode)` ポイズンメッセージの送信に失敗した場合に使用する終了コード(プロセスを終了(`System.exit(int)`)する際に設定する値)を設定する。
`void`	`setPutPoisonFailedFailureCode(java.lang.String putPoisonFailedFailureCode)` ポイズンメッセージの送信に失敗した場合に使用する障害コードを設定する。
`WmqMessagingProvider`	`setQueueManagerName(java.lang.String queueManagerName)` キューマネージャ名称を設定する。
`WmqMessagingProvider`	`setReceivedQueueName(java.lang.String receivedQueueName)` 受信キュー名(論理名)を設定する。
`WmqMessagingProvider`	`setSendingQueueNames(java.util.List<java.lang.String> sendingQueueNames)` 送信キュー名(論理名)リストを設定する。
`void`	`setUseProductSystemErrorOutput(boolean useProductSystemErrorOutput)` WebSphere MQによる`MQException`発生時の標準エラー出力を使用するか否かを設定する。
`void`	`setUseXa(boolean useXa)` 分散トランザクションを使用するか否かを設定する。

クラスから継承されたメソッド java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- コンストラクタの詳細
  - WmqMessagingProvider
```
public WmqMessagingProvider()
```
- メソッドの詳細
  - initialize
```
public void initialize()
```
    WebSphere MQの初期化処理を行う。
    下記の処理を行う。
    - checkPoisonSetting()メソッドを呼び出し退避キューの設定不備がないことをチェックする。
    - 接続モード(CMQC.TRANSPORT_PROPERTY)をバインディングモードに設定する。
    - スレッド類縁性(CMQC.THREAD_AFFINITY_PROPERTY)にuseXaプロパティの値を設定する。
    - useProductSystemErrorOutputプロパティがfalseの場合はWebSphere MQによる標準エラー出力を無効化する。
    - 接続モード(CMQC.TRANSPORT_PROPERTY)をバインディングモードに設定する。
    - poisonQueueNamePatternが指定された場合はreceivedQueueNameを使用してフォーマットした退避キュー名を設定する。
    定義:
    
    initialize インタフェース内 Initializable
  - checkPoisonSetting
```
protected void checkPoisonSetting()
```
    退避キューの設定不備がないことをチェックする。
    チェック内容は下記のとおり。
    - receivedQueueNameが指定されない場合は、 poisonQueueNamePatternとpoisonQueueNameも指定されないこと。
    - receivedQueueNameが指定された場合は、 poisonQueueNamePatternとpoisonQueueNameの両方が指定されないか、いずれか一方のみ指定されること。
    設定不備が見つかった場合は実行例例外を送出する。
  - createContext
```
public MessagingContext createContext()
```
    WmqMessagingContextを生成する。
```
 指定された設定情報からMQQueueManagerを生成し、
 MQQueueマップ(送信先と受信先とポイズンメッセージ送信先)の初期化を行う。
 
 MQQueueManagerの生成はcreateMQQueueManager()メソッドに委譲する。
 
 送信先MQQueueマップの初期化はgetMQQueues(MQQueueManager, Collection, int)メソッド、
 受信先MQQueueとポイズンメッセージ送信先MQQueueの初期化はgetPoisonQueueOpenOptions()メソッドに委譲する。
 
 送信先MQQueueのオープンを制御するオプションはgetSendingQueueOpenOptions()メソッド、
 受信先MQQueueのオープンを制御するオプションはgetReceivedQueueOpenOptions()メソッド、
 ポイズンメッセージ送信先MQQueueのオープンを制御するオプションはgetPoisonQueueOpenOptions()メソッド、
 から取得する。
 
 MQExceptionを捕捉した場合は、
 MessagingExceptionFactory.createMessagingException(String, Throwable) メソッド
 に例外処理を委譲する。
 
```
    定義:
    
    createContext インタフェース内 MessagingProvider
    
    戻り値:
    
    WmqMessagingContext
  - createMQQueueManager
```
protected com.ibm.mq.MQQueueManager createMQQueueManager()
                                                  throws com.ibm.mq.MQException
```
    キューマネージャ名称を指定してMQQueueManagerを生成する。
    
    戻り値:
    
    MQQueueManager
    
    例外:
    
    com.ibm.mq.MQException - MQQueueManagerの生成に失敗した場合
  - getSendingQueueOpenOptions
```
protected int getSendingQueueOpenOptions()
```
    送信先MQQueueのオープンを制御するオプションを取得する。
    下記オプションを指定した値を返す。
    - CMQC.MQOO_OUTPUT
    - CMQC.MQOO_FAIL_IF_QUIESCING
    戻り値:
    
    送信先MQQueueのオープンを制御するオプション
  - getReceivedQueueOpenOptions
```
protected int getReceivedQueueOpenOptions()
```
    受信先MQQueueのオープンを制御するオプションを取得する。
    下記オプションを指定した値を返す。
    - CMQC.MQOO_INPUT_SHARED
    - CMQC.MQOO_FAIL_IF_QUIESCING
    戻り値:
    
    受信先MQQueueのオープンを制御するオプション
  - getPoisonQueueOpenOptions
```
protected int getPoisonQueueOpenOptions()
```
    ポイズンメッセージの退避先MQQueueのオープンを制御するオプションを取得する。
    getSendingQueueOpenOptions()メソッドに処理を委譲する。
    
    戻り値:
    
    ポイズンメッセージの退避先MQQueueのオープンを制御するオプション
  - getMQQueues
```
protected java.util.Map<java.lang.String,com.ibm.mq.MQQueue> getMQQueues(com.ibm.mq.MQQueueManager mqQueueManager,
                                                                         java.util.Collection<java.lang.String> queueNames,
                                                                         int openOptions)
                                                                  throws com.ibm.mq.MQException
```
    指定されたキュー名とオプションを使用して、正常にオープンされたMQQueueを取得する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
    
    queueNames - キュー名リスト
    
    openOptions - MQQueueのオープンを制御するオプション
    
    戻り値:
    
    正常にオープンされたMQQueueマップ(キーはキュー名)
    
    例外:
    
    com.ibm.mq.MQException - MQQueueのオープンに失敗した場合
  - getMQQueue
```
protected com.ibm.mq.MQQueue getMQQueue(com.ibm.mq.MQQueueManager mqQueueManager,
                                        java.lang.String queueName,
                                        int openOptions)
                                 throws com.ibm.mq.MQException
```
    指定されたキュー名とオプションを使用して、正常にオープンされたMQQueueを取得する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
    
    queueName - キュー名
    
    openOptions - MQQueueのオープンを制御するオプション
    
    戻り値:
    
    正常にオープンされたMQQueue。キュー名の指定がない場合はnull
    
    例外:
    
    com.ibm.mq.MQException - MQQueueのオープンに失敗した場合
  - putMessage
```
protected java.lang.String putMessage(com.ibm.mq.MQQueue mqQueue,
                                      SendingMessage sendingMessage)
```
    送信メッセージを指定されたMQQueueに書き込む。
    送信メッセージからMQMessageを作成しMQQueueに書き込む。
    メッセージ送信前のMQMDフィールドの設定は、 WmqMqmdFieldsOperator.setFieldsBeforeSend(SendingMessage, MQMessage, long)メソッドに委譲する。
    MQQueueへの書き込みを制御するオプションはgetGetMessageOptions(String, long)メソッドから取得する。
    メッセージ送信後のMQMDフィールドの取得は、 WmqMqmdFieldsOperator.getFieldsAfterSend(MQMessage, SendingMessage)メソッドに委譲する。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    mqQueue - MQQueue
    
    sendingMessage - 送信メッセージ
    
    戻り値:
    
    メッセージID
  - getPutMessageOptions
```
protected com.ibm.mq.MQPutMessageOptions getPutMessageOptions()
```
    MQQueueへのメッセージ書き込みを制御するオプションを取得する。
    下記オプションを指定した値を返す。
    - getPutSyncpointOption()メソッドが返す同期点オプション
    - CMQC.MQPMO_NEW_MSG_ID
    戻り値:
    
    MQQueueへのメッセージ書き込みを制御するオプション
  - getPutPoisonMessageOptions
```
protected com.ibm.mq.MQPutMessageOptions getPutPoisonMessageOptions()
```
    MQQueueへのポイズンメッセージ書き込みを制御するオプションを取得する。
    getPutMessageOptions()に処理を委譲する。
    
    戻り値:
    
    MQQueueへのメッセージ書き込みを制御するオプション
  - getPutSyncpointOption
```
protected int getPutSyncpointOption()
```
    メッセージ書き込み時に使用する同期点オプションを取得する。
    useXaプロパティがtrueの場合はCMQC.MQPMO_SYNCPOINT、 falseの場合はCMQC.MQPMO_NO_SYNCPOINTを返す。
    
    戻り値:
    
    メッセージ書き込み時に使用する同期点オプション
  - getMessage
```
protected ReceivedMessage getMessage(com.ibm.mq.MQQueue receivedMqQueue,
                                     java.lang.String messageId,
                                     long timeout,
                                     com.ibm.mq.MQQueue poisonMqQueue)
```
    指定されたMQQueueから受信メッセージを読み込む。
    MQQueueから読み込んだMQMessageから受信メッセージを作成する。
    読み込んだMQMessageがポイズンメッセージの場合は processPoisonMessage(MQQueue, MQMessage)メソッドに処理を委譲する。 MQMessageがポイズンメッセージであるか否かの判定は isPoisonMessage(MQMessage)メソッドが行う。
    メッセージ受信前のMQMDフィールドの設定は WmqMqmdFieldsOperator.setFieldsBeforeReceive(String, MQMessage)メソッドに委譲する。
    MQQueueへの書き込みを制御するオプションはgetGetMessageOptions(String, long)メソッドから取得する。
    メッセージ受信後のMQMDフィールドの取得は WmqMqmdFieldsOperator.getFieldsAfterReceive(MQMessage, ReceivedMessage)メソッドに委譲する。
    MQExceptionが送出され、理由コードがCMQC.MQRC_NO_MSG_AVAILABLEの場合はnullを返す。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    receivedMqQueue - MQQueue
    
    messageId - 相関IDに指定するメッセージID
    
    timeout - タイムアウト値(単位:msec)
    
    poisonMqQueue - ポイズンメッセージ送信先MQQueue。指定がない場合はnull
    
    戻り値:
    
    受信メッセージ。受信できなかった場合はnull
  - isPoisonMessage
```
protected boolean isPoisonMessage(com.ibm.mq.MQMessage mqMessage)
```
    指定されたMQMessageがポイズンメッセージであるか否かを判定する。
    MQMessageのバックアウト回数がbackoutLimitプロパティより大きい場合にtrueを返す。
    
    パラメータ:
    
    mqMessage - MQMessage
    
    戻り値:
    
    ポイズンメッセージである場合はtrue
  - processPoisonMessage
```
protected void processPoisonMessage(com.ibm.mq.MQQueue poisonMqQueue,
                                    com.ibm.mq.MQMessage mqMessage)
                             throws ProcessAbnormalEnd,
                                    MessagingException
```
    ポイズンメッセージの処理を行う。
```
 ポイズンメッセージ送信先MQQueueの指定有無により処理が分かれる。
 
 ポイズンメッセージ送信先MQQueueの指定がない場合
 
   メッセージ受信処理が無限ループになるのを防止するために、
   ProcessAbnormalEndを送出しプロセスを異常終了させる。
   ProcessAbnormalEndの終了コードと障害コードには、
   backoutLimitExceededExitCodeプロパティとbackoutLimitExceededFailureCodeプロパティを指定する。
 
 ポイズンメッセージ送信先MQQueueが指定された場合
 
   FATALレベルで障害ログを出力し、指定されたMQQueueにポイズンメッセージを送信する。
   送信時は、メッセージ存続時間を無制限、元々設定されていたメッセージIDを相関IDに設定する。
   ポイズンメッセージの送信でMQExceptionが送出された場合は、
   送出されたMQExceptionがリトライ可能な例外である場合は再送出し、
   リトライ不可の場合は、メッセージ受信処理が無限ループになるのを防止するために、
   ProcessAbnormalEndを送出しプロセスを異常終了させる。
   ProcessAbnormalEndの終了コードと障害コードには、
   backoutLimitExceededExitCodeプロパティとbackoutLimitExceededFailureCodeプロパティを指定する。
 
 
```
    パラメータ:
    
    poisonMqQueue - ポイズンメッセージ送信先MQQueue。指定がない場合はnull
    
    mqMessage - ポイズンメッセージ
    
    例外:
    
    ProcessAbnormalEnd - ポイズンメッセージ送信先MQQueueの指定がない場合。ポイズンメッセージの送信に失敗し、かつリトライ不可な場合
    
    MessagingException - ポイズンメッセージの送信に失敗し、かつリトライ可能な場合
  - getGetMessageOptions
```
protected com.ibm.mq.MQGetMessageOptions getGetMessageOptions(java.lang.String messageId,
                                                              long timeout)
```
    MQQueueからのメッセージ読み取りを制御するオプションを取得する。
    下記オプションを指定した値を返す。
    - getGetSyncpointOption()メソッドが返す同期点オプション
    - CMQC.MQPMO_NEW_MSG_ID
    - CMQC.MQGMO_WAIT
    - 相関IDに指定するメッセージIDが指定された場合はCMQC.MQMO_MATCH_CORREL_ID、指定がない場合はCMQC.MQMO_NONE
    - タイムアウト値。タイムアウト値が0以下の場合はdefaultResponseTimeoutプロパティの値を使用する。
    パラメータ:
    
    messageId - 相関IDに指定するメッセージID
    
    timeout - タイムアウト値(単位:msec)
    
    戻り値:
    
    MQQueueからのメッセージ読み取りを制御するオプション
  - getGetSyncpointOption
```
protected int getGetSyncpointOption()
```
    メッセージ読み取り時に使用する同期点オプションを取得する。
    useXaプロパティがtrueの場合はCMQC.MQPMO_SYNCPOINT、 falseの場合はCMQC.MQPMO_NO_SYNCPOINTを返す。
    
    戻り値:
    
    メッセージ読み取り時に使用する同期点オプション
  - disconnect
```
protected void disconnect(com.ibm.mq.MQQueueManager mqQueueManager)
```
    MQQueueManagerの接続を切断する。
    MQExceptionが送出された場合はTRACEレベルのログを出力し、MQExceptionを送出しない。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
  - close
```
protected void close(java.util.Map<java.lang.String,com.ibm.mq.MQQueue> mqQueues)
```
    指定された全てのMQQueueをクローズする。
    個々のMQQueueを指定してclose(MQQueue)を呼び出す。
    
    パラメータ:
    
    mqQueues - MQQueueマップ
  - close
```
protected void close(com.ibm.mq.MQQueue mqQueue)
```
    指定されたMQQueueをクローズする。
    MQExceptionが送出された場合はTRACEレベルのログを出力し、MQExceptionを送出しない。
    
    パラメータ:
    
    mqQueue - MQQueue
  - getJdbcConnection
```
protected java.sql.Connection getJdbcConnection(com.ibm.mq.MQQueueManager mqQueueManager,
                                                javax.sql.XADataSource xaDataSource)
                                         throws java.sql.SQLException,
                                                javax.transaction.xa.XAException
```
    MQQueueManagerからConnectionを取得する。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
    
    xaDataSource - XAデータソース
    
    戻り値:
    
    Connection
    
    例外:
    
    java.sql.SQLException - Connectionの取得に失敗した場合
    
    javax.transaction.xa.XAException - Connectionの取得に失敗した場合
  - checkXa
```
protected void checkXa()
```
    分散トランザクションを使用するに設定されていることをチェックする。
    useXaプロパティがfalseの場合はIllegalStateExceptionを送出する。
  - begin
```
protected void begin(com.ibm.mq.MQQueueManager mqQueueManager)
```
    分散トランザクションを開始する。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
  - commit
```
protected void commit(com.ibm.mq.MQQueueManager mqQueueManager)
```
    分散トランザクションをコミットする。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
  - backout
```
protected void backout(com.ibm.mq.MQQueueManager mqQueueManager)
```
    分散トランザクションをバックアウトする。
    MQExceptionを捕捉した場合は、 MessagingExceptionFactory.createMessagingException(String, Throwable)メソッドに例外処理を委譲する。
    
    パラメータ:
    
    mqQueueManager - MQQueueManager
  - setQueueManagerName
```
public WmqMessagingProvider setQueueManagerName(java.lang.String queueManagerName)
```
    キューマネージャ名称を設定する。
    
    パラメータ:
    
    queueManagerName - キューマネージャ名称
    
    戻り値:
    
    このオブジェクト自体
  - setSendingQueueNames
```
public WmqMessagingProvider setSendingQueueNames(java.util.List<java.lang.String> sendingQueueNames)
```
    送信キュー名(論理名)リストを設定する。
    
    パラメータ:
    
    sendingQueueNames - 送信キュー名(論理名)リスト
    
    戻り値:
    
    このオブジェクト自体
  - setReceivedQueueName
```
public WmqMessagingProvider setReceivedQueueName(java.lang.String receivedQueueName)
```
    受信キュー名(論理名)を設定する。
    
    パラメータ:
    
    receivedQueueName - 受信キュー名(論理名)
    
    戻り値:
    
    このオブジェクト自体
  - setPoisonQueueNamePattern
```
public void setPoisonQueueNamePattern(java.lang.String poisonQueueNamePattern)
```
    退避キュー名パターン(論理名)を設定する。
```
 受信先キュー名を使用した命名規約により退避キュー名が規定されている場合は、
 本プロパティを指定する。
 本プロパティの設定例を示す。
 
     設定値: "%s.POISON"
     受信先キュー名が"TEST"の場合は、"TEST.POISON"となる。
 
 
```
    パラメータ:
    
    poisonQueueNamePattern - 退避キュー名パターン(論理名)
  - setPoisonQueueName
```
public void setPoisonQueueName(java.lang.String poisonQueueName)
```
    退避キュー名(論理名)を設定する。
```
 退避キュー名が受信先キュー名と命名規約により規定されていない場合は、
 本プロパティを指定する。
 
```
    パラメータ:
    
    poisonQueueName - 退避キュー名(論理名)
  - setBackoutLimit
```
public WmqMessagingProvider setBackoutLimit(int backoutLimit)
```
    バックアウト回数の上限値を設定する。
    デフォルトは0。
    
    パラメータ:
    
    backoutLimit - バックアウト回数の上限値
    
    戻り値:
    
    このオブジェクト自体
  - setBackoutLimitExceededExitCode
```
public WmqMessagingProvider setBackoutLimitExceededExitCode(int backoutLimitExceededExitCode)
```
    バックアウト上限を超えた場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)を設定する。
    デフォルトは190。
    
    パラメータ:
    
    backoutLimitExceededExitCode - バックアウト上限を超えた場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)
    
    戻り値:
    
    このオブジェクト自体
  - setBackoutLimitExceededFailureCode
```
public WmqMessagingProvider setBackoutLimitExceededFailureCode(java.lang.String backoutLimitExceededFailureCode)
```
    バックアウト上限を超えた場合に使用する障害コードを設定する。
    
    パラメータ:
    
    backoutLimitExceededFailureCode - バックアウト上限を超えた場合に使用する障害コード
    
    戻り値:
    
    このオブジェクト自体
  - setPutPoisonFailedExitCode
```
public void setPutPoisonFailedExitCode(int putPoisonFailedExitCode)
```
    ポイズンメッセージの送信に失敗した場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)を設定する。
    デフォルトは191。
    
    パラメータ:
    
    putPoisonFailedExitCode - ポイズンメッセージの送信に失敗した場合に使用する終了コード(プロセスを終了(System.exit(int))する際に設定する値)
  - setPutPoisonFailedFailureCode
```
public void setPutPoisonFailedFailureCode(java.lang.String putPoisonFailedFailureCode)
```
    ポイズンメッセージの送信に失敗した場合に使用する障害コードを設定する。
    
    パラメータ:
    
    putPoisonFailedFailureCode - ポイズンメッセージの送信に失敗した場合に使用する障害コード
  - setDefaultResponseTimeout
```
public MessagingProvider setDefaultResponseTimeout(long defaultResponseTimeout)
```
    デフォルトタイムアウト値(単位:msec)を設定する。
    デフォルトは300秒。
    
    定義:
    
    setDefaultResponseTimeout インタフェース内 MessagingProvider
    
    パラメータ:
    
    defaultResponseTimeout - デフォルトタイムアウト値(単位:msec)
    
    戻り値:
    
    このオブジェクト自体
  - setDefaultTimeToLive
```
public MessagingProvider setDefaultTimeToLive(long defaultTimeToLive)
```
    送信電文の有効期間(単位:msec)を設定する。
    デフォルトは60秒。
    
    定義:
    
    setDefaultTimeToLive インタフェース内 MessagingProvider
    
    パラメータ:
    
    defaultTimeToLive - 送信電文の有効期間(単位:msec)
    
    戻り値:
    
    このオブジェクト自体
  - setMqmdFieldsOperator
```
public WmqMessagingProvider setMqmdFieldsOperator(WmqMqmdFieldsOperator mqmdFieldsOperator)
```
    WmqMqmdFieldsOperatorオブジェクトを設定する。
    デフォルトはBasicWmqMqmdFieldsOperator。
    
    パラメータ:
    
    mqmdFieldsOperator - WmqMqmdFieldsOperatorオブジェクト
    
    戻り値:
    
    このオブジェクト自体
  - setMessagingExceptionFactory
```
public WmqMessagingProvider setMessagingExceptionFactory(MessagingExceptionFactory messagingExceptionFactory)
```
    MessagingExceptionファクトリオブジェクトを設定する。
    デフォルトはBasicWmqMessagingExceptionFactory。
    
    定義:
    
    setMessagingExceptionFactory インタフェース内 MessagingProvider
    
    パラメータ:
    
    messagingExceptionFactory - MessagingExceptionファクトリオブジェクト
    
    戻り値:
    
    このオブジェクト自体
  - setUseXa
```
public void setUseXa(boolean useXa)
```
    分散トランザクションを使用するか否かを設定する。
    デフォルトはtrue。
    
    パラメータ:
    
    useXa - 分散トランザクションを使用する場合はtrue
  - setUseProductSystemErrorOutput
```
public void setUseProductSystemErrorOutput(boolean useProductSystemErrorOutput)
```
    WebSphere MQによるMQException発生時の標準エラー出力を使用するか否かを設定する。
    デフォルトはfalse。
    
    パラメータ:
    
    useProductSystemErrorOutput - WebSphere MQによるMQException発生時の標準エラー出力を使用する場合はtrue

クラス WmqMessagingProvider

コンストラクタのサマリー

メソッドのサマリー

クラスから継承されたメソッド java.lang.Object

コンストラクタの詳細

WmqMessagingProvider

メソッドの詳細

initialize

checkPoisonSetting

createContext

createMQQueueManager

getSendingQueueOpenOptions

getReceivedQueueOpenOptions

getPoisonQueueOpenOptions

getMQQueues

getMQQueue

putMessage

getPutMessageOptions

getPutPoisonMessageOptions

getPutSyncpointOption

getMessage

isPoisonMessage

processPoisonMessage

getGetMessageOptions

getGetSyncpointOption

disconnect

close

close

getJdbcConnection

checkXa

begin

commit

backout

setQueueManagerName

setSendingQueueNames

setReceivedQueueName

setPoisonQueueNamePattern

setPoisonQueueName

setBackoutLimit

setBackoutLimitExceededExitCode

setBackoutLimitExceededFailureCode

setPutPoisonFailedExitCode

setPutPoisonFailedFailureCode

setDefaultResponseTimeout

setDefaultTimeToLive

setMqmdFieldsOperator

setMessagingExceptionFactory

setUseXa

setUseProductSystemErrorOutput