MessagingContext (NablarchApi)

java.lang.Object
- nablarch.fw.messaging.MessagingContext

直系の既知のサブクラス:

JmsMessagingProvider.Context
```
@Published(tag="architect")
public abstract class MessagingContext
extends Object
```
メッセージングサーバとの間に開かれるセッションに対するラッパー。このクラスのインスタンスはスレッドローカル変数上で管理されており、 MessagingContext.getInstance()を用いてインスタンスを獲得する。本クラスでは、以下の機能を提供する。
- メッセージ送信
- メッセージ同期送信
- メッセージ受信
作成者:

Iwauo Tajima

関連項目:

MessagingProvider

メソッドのサマリー

すべてのメソッド staticメソッドインスタンス・メソッド abstractメソッド concreteメソッド
修飾子とタイプ	メソッドと説明
`static void`	`attach(MessagingContext context)` カレントスレッドにメッセージコンテキストを紐づける。
`abstract void`	`close()` 現在のセッションを終了し、保持しているリソースを開放する。
`static void`	`detach()` カレントスレッド上のメッセージコンテキストを閉じた上で除去する。
`protected void`	`emitLog(InterSystemMessage<?> message)` メッセージングの証跡ログを出力する。
`static MessagingContext`	`getInstance()` カレントスレッドに紐づけられているメッセージングコンテキストを返す。
`abstract ReceivedMessage`	`receiveMessage(String receiveQueue, String messageId, long timeout)` 指定した受信キュー上のメッセージを取得する。
`ReceivedMessage`	`receiveSync(String receiveQueue)` 指定した受信キュー上のメッセージを取得する。
`ReceivedMessage`	`receiveSync(String receiveQueue, long timeout)` 指定した受信キュー上のメッセージを取得する。
`ReceivedMessage`	`receiveSync(String receiveQueue, String messageId, long timeout)` 指定した受信キュー上のメッセージを取得する。
`String`	`send(SendingMessage message)` メッセージを送信する。
`abstract String`	`sendMessage(SendingMessage message)` メッセージを送信する。
`ReceivedMessage`	`sendSync(SendingMessage message)` メッセージの同期送信を行う。
`ReceivedMessage`	`sendSync(SendingMessage message, long timeout)` メッセージの同期送信を行う。

- メソッドの詳細
  - getInstance
```
public static MessagingContext getInstance()
```
    カレントスレッドに紐づけられているメッセージングコンテキストを返す。メッセージングコンテキストが現在のスレッド上に存在しない場合は実行時例外を送出する。
    
    戻り値:
    
    メッセージングコンテキスト
    
    例外:
    
    IllegalStateException - メッセージングコンテキストが現在のスレッド上に存在しない場合
  - attach
```
public static void attach(MessagingContext context)
```
    カレントスレッドにメッセージコンテキストを紐づける。
    
    パラメータ:
    
    context - カレントスレッドに紐づけるメッセージングコンテキスト
  - detach
```
public static void detach()
```
    カレントスレッド上のメッセージコンテキストを閉じた上で除去する。メッセージングコンテキストがカレントスレッド上に存在しない場合はなにもしない。
  - send
```
public String send(SendingMessage message)
```
    メッセージを送信する。
    
    パラメータ:
    
    message - 送信メッセージ
    
    戻り値:
    
    送信メッセージのメッセージID
  - sendSync
```
public ReceivedMessage sendSync(SendingMessage message)
```
    メッセージの同期送信を行う。プロバイダ側設定のタイムアウト時間を経過した場合はnullを返す。
    
    パラメータ:
    
    message - 送信メッセージ
    
    戻り値:
    
    応答メッセージ
  - sendSync
```
public ReceivedMessage sendSync(SendingMessage message,
                                long timeout)
```
    メッセージの同期送信を行う。メッセージ送信後、応答電文を受信するか、指定した時間が経過するまでブロックする。タイムアウトした場合はnullを返す。タイムアウト時間に0以下の数値を設定した場合、プロバイダ側のデフォルトタイムアウト時間を経過した場合はnullを返す。タイムアウト時間が指定された場合は有効期間ヘッダにタイムアウト時間を指定する。
    
    パラメータ:
    
    message - 送信メッセージ
    
    timeout - 応答タイムアウト (単位：ミリ秒、0以下の数値の場合はブロックし続ける)
    
    戻り値:
    
    応答受信メッセージ（タイムアウトした場合はnull）
  - receiveSync
```
public ReceivedMessage receiveSync(String receiveQueue)
```
    指定した受信キュー上のメッセージを取得する。キュー上にメッセージが存在していない場合は、メッセージを受信するまでブロックする。
    
    パラメータ:
    
    receiveQueue - 受信キューの論理名
    
    戻り値:
    
    受信したメッセージ
  - receiveSync
```
public ReceivedMessage receiveSync(String receiveQueue,
                                   long timeout)
```
    指定した受信キュー上のメッセージを取得する。キュー上にメッセージが存在していない場合は、メッセージを受信するまでブロックする。
    
    パラメータ:
    
    receiveQueue - 受信キューの論理名
    
    timeout - 応答タイムアウト (単位：ミリ秒、0以下の数値の場合はブロックし続ける)
    
    戻り値:
    
    受信したメッセージ
  - receiveSync
```
public ReceivedMessage receiveSync(String receiveQueue,
                                   String messageId,
                                   long timeout)
```
    指定した受信キュー上のメッセージを取得する。 messageIdが指定されている場合は、当該のメッセージに対する応答電文を取得する。messageIdが指定されていないばあいは、受信キュー上の任意の電文を取得する。キュー上に取得対象のメッセージが存在しない場合、メッセージを受信するか、指定した時間が経過する（タイムアウトする）までブロックする。タイムアウトした場合はnullをかえす。タイムアウト時間に0以下の数値を設定した場合は応答電文を受信するまでブロックし続ける。
    
    パラメータ:
    
    receiveQueue - 受信キューの論理名
    
    messageId - 送信電文のメッセージID (応答受信でない場合はnull)
    
    timeout - 応答タイムアウト (単位：ミリ秒、0以下の数値の場合はブロックし続ける)
    
    戻り値:
    
    受信したメッセージ（タイムアウトした場合はnull）
  - sendMessage
```
public abstract String sendMessage(SendingMessage message)
```
    メッセージを送信する。
    
    パラメータ:
    
    message - 送信メッセージ
    
    戻り値:
    
    送信メッセージのメッセージID
  - receiveMessage
```
public abstract ReceivedMessage receiveMessage(String receiveQueue,
                                               String messageId,
                                               long timeout)
```
    指定した受信キュー上のメッセージを取得する。 messageIdが指定されている場合は、当該のメッセージに対する応答電文を取得する。messageIdが指定されていないばあいは、受信キュー上の任意の電文を取得する。キュー上に取得対象のメッセージが存在しない場合、メッセージを受信するか、指定した時間が経過する（タイムアウトする）までブロックする。タイムアウトした場合はnullをかえす。タイムアウト時間に0以下の数値を設定した場合は応答電文を受信するまでブロックし続ける。
    
    パラメータ:
    
    receiveQueue - 受信キューの論理名
    
    messageId - 送信電文のメッセージID (応答受信でない場合はnull)
    
    timeout - 応答タイムアウト (単位：ミリ秒、0以下の数値の場合はブロックし続ける)
    
    戻り値:
    
    受信したメッセージ（タイムアウトした場合はnull）
  - close
```
public abstract void close()
```
    現在のセッションを終了し、保持しているリソースを開放する。
  - emitLog
```
protected void emitLog(InterSystemMessage<?> message)
```
    メッセージングの証跡ログを出力する。
    
    パラメータ:
    
    message - メッセージオブジェクト

クラス MessagingContext

メソッドのサマリー

メソッドの詳細

getInstance

attach

detach

send

sendSync

sendSync

receiveSync

receiveSync

receiveSync

sendMessage

receiveMessage

close

emitLog