パッケージ jakarta.jms

インターフェース QueueSession

  • すべてのスーパーインターフェース:
    AutoCloseableSE、RunnableSE、Session
    public interface QueueSession
extends Session
    QueueSession オブジェクトは、QueueReceiver、QueueSender、QueueBrowser、TemporaryQueue オブジェクトを作成するためのメソッドを提供します。

    QueueSession の終了時に受信されましたが確認応答されていないメッセージがある場合、これらのメッセージは保持され、コンシューマーが次にキューにアクセスしたときに再配信されます。

    QueueSession は、ポイントツーポイント固有のオブジェクトを作成するために使用されます。通常は、Session オブジェクトを使用します。QueueSession は、既存のコードをサポートするために使用されます。Session オブジェクトを使用すると、プログラミングモデルが簡素化され、2 つのメッセージングドメインでトランザクションを使用できるようになります。

    QueueSession を使用して、パブリッシュ / サブスクライブドメインに固有のオブジェクトを作成することはできません。次のメソッドは Session から継承しますが、QueueSession から使用する場合は IllegalStateException をスローする必要があります。

    • createDurableSubscriber
    • createDurableConsumer
    • createSharedConsumer
    • createSharedDurableConsumer
    • createTemporaryTopic
    • createTopic
    • unsubscribe
    導入:
    JMS 1.0
    バージョン:
    Jakarta Messaging 2.0
    関連事項:
    Session, QueueConnection.createQueueSession(boolean, int), XAQueueSession.getQueueSession()

    • メソッドの詳細

      • createQueue

        Queue createQueue​(StringSE queueName)
           throws JMSException
        Queue 名を指定してキュー ID を作成します。

        この機能は、クライアントがキュー ID を動的に操作する必要があるまれなケースのために提供されています。プロバイダー固有の名前でキュー ID を作成できます。この機能に依存するクライアントは移植できません。

        このメソッドは物理的なキューを作成するためのものではないことに注意してください。キューの物理的な作成は管理タスクであり、Jakarta Messaging API によって開始されません。1 つの例外は一時的なキューの作成で、これは createTemporaryQueue メソッドで実行されます。

        次で指定:
        インターフェース Session の createQueue 
        パラメーター:
        queueName - この Queue の名前
        戻り値:
        指定された名前の Queue 
        例外:
        JMSException - 内部エラーのためにセッションがキューの作成に失敗した場合。

      • createReceiver

        QueueReceiver createReceiver​(Queue queue)
                      throws JMSException
        指定されたキューからメッセージを受信する QueueReceiver オブジェクトを作成します。
        パラメーター:
        queue - アクセスする Queue 
        戻り値:
        指定されたキューからメッセージを受信する QueueReceiver オブジェクト
        例外:
        JMSException - 内部エラーのためにセッションがレシーバーの作成に失敗した場合。
        InvalidDestinationException - 無効なキューが指定された場合。

      • createReceiver

        QueueReceiver createReceiver​(Queue queue,
                             StringSE messageSelector)
                      throws JMSException
        メッセージセレクターを使用して、指定されたキューからメッセージを受信する QueueReceiver オブジェクトを作成します。
        パラメーター:
        queue - アクセスする Queue 
        messageSelector - メッセージセレクター式に一致するプロパティを持つメッセージのみが配信されます。null または空の文字列の値は、メッセージコンシューマーにメッセージセレクタがないことを示します。
        戻り値:
        指定されたキューからメッセージを受信する QueueReceiver オブジェクト
        例外:
        JMSException - 内部エラーのためにセッションがレシーバーの作成に失敗した場合。
        InvalidDestinationException - 無効なキューが指定された場合。
        InvalidSelectorException - メッセージセレクタが無効な場合。

      • createSender

        QueueSender createSender​(Queue queue)
                  throws JMSException
        指定されたキューにメッセージを送信する QueueSender オブジェクトを作成します。
        パラメーター:
        queue - アクセスする Queue。これが不明なプロデューサーの場合は null
        戻り値:
        指定されたキューにメッセージを送信するための QueueSender オブジェクト。
        例外:
        JMSException - 内部エラーのためにセッションが送信者の作成に失敗した場合。
        InvalidDestinationException - 無効なキューが指定された場合。

      • createBrowser

        QueueBrowser createBrowser​(Queue queue)
                    throws JMSException
        QueueBrowser オブジェクトを作成して、指定されたキューのメッセージを確認します。
        次で指定:
        インターフェース Session の createBrowser 
        パラメーター:
        queue - アクセスする Queue 
        戻り値:
        メッセージをのぞく QueueBrowser オブジェクト。
        例外:
        JMSException - 内部エラーのためにセッションがブラウザーの作成に失敗した場合。
        InvalidDestinationException - 無効なキューが指定された場合。

      • createBrowser

        QueueBrowser createBrowser​(Queue queue,
                           StringSE messageSelector)
                    throws JMSException
        QueueBrowser オブジェクトを作成して、メッセージセレクターを使用して、指定されたキューのメッセージを確認します。
        次で指定:
        インターフェース Session の createBrowser 
        パラメーター:
        queue - アクセスする Queue 
        messageSelector - メッセージセレクター式に一致するプロパティを持つメッセージのみが配信されます。null または空の文字列の値は、メッセージコンシューマーにメッセージセレクタがないことを示します。
        戻り値:
        指定されたキューのメッセージをのぞく QueueBrowser オブジェクト。
        例外:
        JMSException - 内部エラーのためにセッションがブラウザーの作成に失敗した場合。
        InvalidDestinationException - 無効なキューが指定された場合。
        InvalidSelectorException - メッセージセレクタが無効な場合。

      • createTemporaryQueue

        TemporaryQueue createTemporaryQueue()
                             throws JMSException
        TemporaryQueue オブジェクトを作成します。それが以前に削除されない限り、その存続期間は QueueConnection の存続期間になります。
        次で指定:
        インターフェース Session の createTemporaryQueue 
        戻り値:
        一時的なキュー ID
        例外:
        JMSException - 内部エラーのためにセッションが一時キューの作成に失敗した場合。