7.4.7 QueueBrowserインタフェース

QueueBrowserインタフェースは,JMSクライアントがキューからメッセージを削除しないで参照するために使用します。

<この項の構成>
(1) 現在のキューにあるメッセージ一覧の取得
(2) メッセージセレクタの取得
(3) キューブラウザのクローズ
(4) キューの取得
(5) 形式
(6) フィールド
(7) メソッド

(1) 現在のキューにあるメッセージ一覧の取得

現在のキューにあるメッセージの一覧を取得します。メッセージセレクタを設定してQueueBrowserオブジェクトが生成されている場合は,メッセージセレクタに応じたメッセージだけを参照できます。

(2) メッセージセレクタの取得

QueueBrowserオブジェクトを生成する際に設定されたメッセージセレクタを取得します。メッセージセレクタについては,「2.6.2 メッセージセレクタ」を参照してください。

(3) キューブラウザのクローズ

QueueBrowserオブジェクトをクローズできます。クローズによって,QueueBrowserオブジェクトに関連づけられたすべてのリソースを解放します。

QueueBrowserインタフェースのメソッドは,複数スレッドからの同時発行をJMSで禁止されています。ただし,close()メソッドだけは複数スレッドから同時発行してパラレルに実行できます。

(4) キューの取得

キューブラウザを生成する際に設定されたキューを取得します。

(5) 形式

public interface QueueBrowser
{
 public void     close() throws JMSException;
 public java.util.Enumeration
                 getEnumeration() throws JMSException;
 public java.lang.String
                 getMessageSelector() throws JMSException;
 public Queue    getQueue() throws JMSException;
}

(6) フィールド

ありません。

(7) メソッド

「(5) 形式」に記載した順序で各メソッドを説明します。

(a) closeメソッド

public void close() throws JMSException

キューブラウザをクローズします。キューブラウザには幾つかのリソースが割り当てられている場合があるため,リソースが不要になった場合はキューブラウザをクローズしてください。

(b) getEnumerationメソッド

public java.util.Enumeration getEnumeration() throws JMSException

現在のキューにあるメッセージの列挙を取得します。

(c) getMessageSelectorメソッド

public java.lang.String getMessageSelector() throws JMSException

キューブラウザのメッセージセレクタ構文を返します。

(d) getQueueメソッド

public Queue getQueue() throws JMSException

キューブラウザに関連づけられたキューを返します。