JmsMessagingProvider (Nablarch-API)

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプクラスと説明

static class JmsMessagingProvider.Context
メッセージングコンテキストのJMSベース実装

ネストされたクラス
修飾子とタイプ	クラスと説明
`static class`	`JmsMessagingProvider.Context` メッセージングコンテキストのJMSベース実装

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

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

JmsMessagingProvider()

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

メソッドのサマリー

すべてのメソッドインスタンス・メソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`MessagingContext`	`createContext()` メッセージングコンテキストを返す。
`javax.jms.ConnectionFactory`	`getConnectionFactory()` コネクションファクトリを返す。
`JmsMessagingProvider`	`setConnectionFactory(javax.jms.ConnectionFactory factory)` コネクションファクトリを設定する。
`JmsMessagingProvider`	`setDefaultPoisonQueue(java.lang.String queueName)` デフォルトで使用する受信退避キューの論理名を設定する。
`MessagingProvider`	`setDefaultResponseTimeout(long timeout)` 同期送信処理における応答受信待ちのデフォルトタイムアウト値を設定する。
`MessagingProvider`	`setDefaultTimeToLive(long timeToLive)` 送信電文の有効期間のデフォルト値を設定する。
`JmsMessagingProvider`	`setDestinations(java.util.Map<java.lang.String,javax.jms.Queue> table)` メッセージング機能で使用する宛先の論理名とJMS Destinationオブジェクトとのマッピングを設定する。
`MessagingProvider`	`setMessagingExceptionFactory(MessagingExceptionFactory messagingExceptionFactory)` `MessagingException`ファクトリオブジェクトを設定する。
`JmsMessagingProvider`	`setPoisonQueueNamePattern(java.lang.String pattern)` 各受信キューに対する退避キューの論理名を決定する際に使用するパターン文字列を設定する。
`JmsMessagingProvider`	`setRedeliveryLimit(int limit)` MOMによる受信リトライの上限回数を設定する。

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

- コンストラクタの詳細
  - JmsMessagingProvider
```
public JmsMessagingProvider()
```
- メソッドの詳細
  - createContext
```
public MessagingContext createContext()
```
    メッセージングコンテキストを返す。この実装では、コネクションファクトリからJMSコネクションを取得し、新規セッションを作成する。
    
    定義:
    
    createContext インタフェース内 MessagingProvider
    
    戻り値:
    
    メッセージングコンテキスト
  - setDefaultResponseTimeout
```
public MessagingProvider setDefaultResponseTimeout(long timeout)
```
    同期送信処理における応答受信待ちのデフォルトタイムアウト値を設定する。 (単位:msec) 同期送信処理におけるデフォルトタイムアウト値を設定する。デフォルトタイムアウトを明示的に設定しなかった場合のデフォルトタイムアウトは 5分間となる。
    
    定義:
    
    setDefaultResponseTimeout インタフェース内 MessagingProvider
    
    パラメータ:
    
    timeout - デフォルトタイムアウト値 (単位:msec)
    
    戻り値:
    
    このオブジェクト自体
  - setDefaultTimeToLive
```
public MessagingProvider setDefaultTimeToLive(long timeToLive)
```
    送信電文の有効期間のデフォルト値を設定する。 (単位:msec) 送信電文のデフォルト有効期間を設定する。デフォルト値を明示的に設定しなかった場合の有効期間は30秒(30000msec)となる。
    
    定義:
    
    setDefaultTimeToLive インタフェース内 MessagingProvider
    
    パラメータ:
    
    timeToLive - 送信電文の有効期間 (単位:msec)
    
    戻り値:
    
    このオブジェクト自体
  - setConnectionFactory
```
@Published(tag="architect")
public JmsMessagingProvider setConnectionFactory(javax.jms.ConnectionFactory factory)
```
    コネクションファクトリを設定する。このクラスではコネクションプール機能を提供していないため、コネクションプール機能を内蔵したコネクションファクトリを使用することを強く推奨する。
    
    パラメータ:
    
    factory - コネクションファクトリ
    
    戻り値:
    
    このオブジェクト自体
  - getConnectionFactory
```
@Published(tag="architect")
public javax.jms.ConnectionFactory getConnectionFactory()
```
    コネクションファクトリを返す。
    
    戻り値:
    
    コネクションファクトリ
  - setDestinations
```
@Published(tag="architect")
public JmsMessagingProvider setDestinations(java.util.Map<java.lang.String,javax.jms.Queue> table)
```
    メッセージング機能で使用する宛先の論理名とJMS Destinationオブジェクトとのマッピングを設定する。（既存の設定があった場合は上書きされる。）
    
    パラメータ:
    
    table - キューの論理名とそれに対応するQueueオブジェクトとのマッピング
    
    戻り値:
    
    このオブジェクト自体
  - setPoisonQueueNamePattern
```
public JmsMessagingProvider setPoisonQueueNamePattern(java.lang.String pattern)
```
    各受信キューに対する退避キューの論理名を決定する際に使用するパターン文字列を設定する。明示的に指定しなかった場合のデフォルトは、 (受信キュー名).POISON となる。当該のキューが存在しなかった場合はデフォルトの退避キュー名を使用する。
    
    パラメータ:
    
    pattern - 退避キューの論理名を決定する際に使用するパターン文字列
    
    戻り値:
    
    このオブジェクト自体
  - setDefaultPoisonQueue
```
public JmsMessagingProvider setDefaultPoisonQueue(java.lang.String queueName)
```
    デフォルトで使用する受信退避キューの論理名を設定する。当該のキューが存在しなかった場合は、MessgingExceptionを送出する。明示的に指定しなかった場合は、DEFAULT.POISONを使用する。
    
    パラメータ:
    
    queueName - キュー名称
    
    戻り値:
    
    このオブジェクト自体
  - setRedeliveryLimit
```
public JmsMessagingProvider setRedeliveryLimit(int limit)
```
    MOMによる受信リトライの上限回数を設定する。受信メッセージのJMSXDeliveryCountヘッダの値がこの上限値を越えると、メッセージを退避キューに転送した上で、MessagingExceptionを送出する。この値が0以下の数値であった場合は、退避処理自体が無効化される。明示的に指定しない場合のデフォルトは0である。
    
    パラメータ:
    
    limit - 受信リトライの上限回数
    
    戻り値:
    
    このオブジェクト自体。
  - setMessagingExceptionFactory
```
public MessagingProvider setMessagingExceptionFactory(MessagingExceptionFactory messagingExceptionFactory)
```
    MessagingExceptionファクトリオブジェクトを設定する。
    デフォルトはBasicMessagingExceptionFactory。
    
    定義:
    
    setMessagingExceptionFactory インタフェース内 MessagingProvider
    
    パラメータ:
    
    messagingExceptionFactory - MessagingExceptionファクトリオブジェクト
    
    戻り値:
    
    このオブジェクト自体

クラス JmsMessagingProvider

ネストされたクラスのサマリー

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

メソッドのサマリー

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

コンストラクタの詳細

JmsMessagingProvider

メソッドの詳細

createContext

setDefaultResponseTimeout

setDefaultTimeToLive

setConnectionFactory

getConnectionFactory

setDestinations

setPoisonQueueNamePattern

setDefaultPoisonQueue

setRedeliveryLimit

setMessagingExceptionFactory