パッケージ jakarta.jms

インターフェース QueueBrowser

すべてのスーパーインターフェース:
AutoCloseableSE
public interface QueueBrowser extends AutoCloseableSE
クライアントは QueueBrowser オブジェクトを使用して、キューのメッセージを削除せずに調べます。

getEnumeration メソッドは、キューのメッセージをスキャンするために使用される java.util.Enumeration を返します。キューのコンテンツ全体の列挙である場合もあれば、メッセージセレクターに一致するメッセージのみが含まれている場合もあります。

スキャンの実行中にメッセージが到着して期限切れになる場合があります。Jakarta Messaging API では、列挙型のコンテンツがキューコンテンツの静的スナップショットである必要はありません。これらの変更が表示されるかどうかは、JMS プロバイダーによって異なります。

QueueBrowser は、配信時間に達する前にメッセージを返してはなりません。

QueueBrowser は、Session または  QueueSession のいずれかから作成できます。

導入:
JMS 1.0
バージョン:
Jakarta Messaging 2.0
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    close()
    QueueBrowser を閉じます。
    EnumerationSE
    getEnumeration()
    受信される順序で現在のキューメッセージを参照するための列挙を取得します。
    StringSE
    getMessageSelector()
    このキューブラウザーのメッセージセレクタ式を取得します。
    Queue
    getQueue()
    このキューブラウザーに関連付けられているキューを取得します。

  • メソッドの詳細

    • getQueue

      Queue getQueue() throws JMSException
      このキューブラウザーに関連付けられているキューを取得します。
      戻り値:
      待ち行列
      例外:
      JMSException - 内部エラーが原因で Jakarta Messaging プロバイダーがこのブラウザーに関連付けられたキューを取得できない場合。

    • getMessageSelector

      StringSE getMessageSelector() throws JMSException
      このキューブラウザーのメッセージセレクタ式を取得します。
      戻り値:
      このキューブラウザーのメッセージセレクタ、またはメッセージコンシューマー用のメッセージセレクタが存在しない場合は null (つまり、メッセージセレクターが設定されていないか、null または空の文字列に設定されている場合)
      例外:
      JMSException - 内部エラーのために Jakarta Messaging プロバイダーがこのブラウザーのメッセージセレクターを取得できない場合。

    • getEnumeration

      EnumerationSE getEnumeration() throws JMSException
      受信される順序で現在のキューメッセージを参照するための列挙を取得します。
      戻り値:
      メッセージを閲覧するための列挙
      例外:
      JMSException - 内部エラーが原因で Jakarta Messaging プロバイダーがこのブラウザーの列挙を取得できない場合。

    • close

      void close() throws JMSException
      QueueBrowser を閉じます。

      プロバイダーは、Java 仮想マシンの外部で QueueBrowser に代わって一部のリソースを割り当てる可能性があるため、クライアントは、必要のないときに閉じる必要があります。最終的にこれらのリソースを再利用するためにガベージコレクションに依存することは、タイムリーではない場合があります。

      次で指定:
      インターフェース AutoCloseableSE の close 
      例外:
      JMSException - 内部エラーが原因で Jakarta Messaging プロバイダーがこのブラウザーを閉じることができない場合。