nablarch.fw.messaging.reader

クラス MessageReader

java.lang.Object

nablarch.fw.messaging.reader.MessageReader

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

DataReader<ReceivedMessage>

public class MessageReader
extends java.lang.Object
implements DataReader<ReceivedMessage>

指定されたメッセージキューを監視し、受信した電文オブジェクトを返すデータリーダ。

受信電文読み込み時にエラーが発生した場合は、例外(MessageReadError)を送出する。

関連項目:

DataReader

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

インタフェースから継承されたネストされたクラス/インタフェース nablarch.fw.DataReader

DataReader.NoMoreRecord

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

コンストラクタ

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

メソッドのサマリー

修飾子とタイプ	メソッドと説明
void	close(ExecutionContext ctx) このリーダのクローズフラグを立て新規電文の受信を停止する。
boolean	hasNext(ExecutionContext ctx) 次に読み込むデータが存在するかどうかを返却する。
ReceivedMessage	read(ExecutionContext ctx) 受信電文を読み込む。
MessageReader	setFormatFileDirName(java.lang.String dirName) 受信電文のフォーマット定義ファイルが配置されているディレクトリの 論理名を指定する。
MessageReader	setFormatFileName(java.lang.String fileName) 受信電文のフォーマット定義ファイル名を設定する。
MessageReader	setReadTimeout(long timeout) 受信キューが空の場合に待機する最大時間を設定する。
MessageReader	setReceiveQueueName(java.lang.String queueName) このリーダが監視する受信キューの論理名を設定する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

MessageReader

public MessageReader()

メソッドの詳細

read

public ReceivedMessage read(ExecutionContext ctx)

受信電文を読み込む。

カレントスレッドに紐づけられたMessagingContext オブジェクトを使用して受信キューから電文を取得し返却する。
受信キュー上に電文が1件も無い場合は、新規電文を受信するか、タイムアウト時間まで待機する。
(このタイムアウトは各スレッドが開閉局やプロセス停止フラグ等の実行制御系の ステータスを確認するために必要となる。)
既にリーダが閉じられていた場合、またはタイムアウトした場合はnullを返却する。

定義:

read インタフェース内 DataReader<ReceivedMessage>

パラメータ:

ctx - 実行コンテキスト

戻り値:

受信電文オブジェクト

例外:

java.lang.IllegalStateException - 受信キューの論理名がnullの場合

java.lang.RuntimeException - 実行時例外が発生した場合

java.lang.Error - エラーが発生した場合

MessageReadError - 受信電文オブジェクトの設定中に 実行時例外またはエラーが発生した場合

hasNext

public boolean hasNext(ExecutionContext ctx)

次に読み込むデータが存在するかどうかを返却する。

この実装では、リーダが開いているかどうかで次のデータを読めるかどうか判定する。

定義:

hasNext インタフェース内 DataReader<ReceivedMessage>

パラメータ:

ctx - 実行コンテキスト

戻り値:

次に読み込むデータが存在する場合は true

close

public void close(ExecutionContext ctx)

このリーダのクローズフラグを立て新規電文の受信を停止する。

受信イベント待ちで待機中のスレッドについてはそのまま放置する。
それらのスレッドは、新規電文を受信するかタイムアウトした時点で待機が解除される。

定義:

close インタフェース内 DataReader<ReceivedMessage>

パラメータ:

ctx - 実行コンテキスト

setReceiveQueueName

public MessageReader setReceiveQueueName(java.lang.String queueName)

このリーダが監視する受信キューの論理名を設定する。

パラメータ:

queueName - 受信キューの論理名

戻り値:

このオブジェクト自体

setReadTimeout

public MessageReader setReadTimeout(long timeout)

受信キューが空の場合に待機する最大時間を設定する。

0以下の値を設定した場合はタイムアウトせずに 新規電文を受信するまで待機し続ける。

パラメータ:

timeout - 受信タイムアウト(単位：ミリ秒)

戻り値:

このオブジェクト自体

setFormatFileName

public MessageReader setFormatFileName(java.lang.String fileName)

受信電文のフォーマット定義ファイル名を設定する。

パラメータ:

fileName - フォーマット定義ファイル名

戻り値:

このオブジェクト自体

setFormatFileDirName

public MessageReader setFormatFileDirName(java.lang.String dirName)

受信電文のフォーマット定義ファイルが配置されているディレクトリの 論理名を指定する。

パラメータ:

dirName - フォーマット定義ファイル配置ディレクトリの論理名

戻り値:

このオブジェクト自体