パッケージ jakarta.enterprise.context

インターフェース Conversation

public interface Conversation

アプリケーションが、現在の会話を一時的または長時間実行としてマークするか、会話識別子を指定するか、会話タイムアウトを設定することにより、会話コンテキストを管理できるようにします。

インスタンスが挿入される場合があります。

 @Inject
 Conversation conversation;

会話のタイムアウトは、ミリ秒単位の最後の指定された間隔内に会話がアクティブであった場合に会話を破棄してはならないというコンテナーへのヒントです。

会話のサポートを提供するために、CDI Lite の実装は必要ありません。

作成者:
Pete Muir, Gavin King
関連事項:

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    void
    begin()
    現在の一時的な会話を長時間実行していることをマークします。
    void
    begin(StringSE id)
    指定された識別子を使用して、現在の一時的な会話を長時間実行していることをマークします。
    void
    end()
    現在の長時間実行中の会話を一時的なものとしてマークします。
    StringSE
    getId()
    現在実行中の会話の識別子を取得します。
    long
    getTimeout()
    現在の会話のタイムアウトを取得します。
    boolean
    isTransient()
    会話が一時的または長時間実行としてマークされているかどうかを確認します。
    void
    setTimeout(long milliseconds)
    現在の会話のタイムアウトを設定します。

  • メソッドの詳細

    • begin

      void begin()

      現在の一時的な会話を長時間実行していることをマークします。会話識別子はコンテナーによって生成されます。

      例外:
      IllegalStateExceptionSE - 現在の会話がすでに長期実行としてマークされている場合。

    • begin

      void begin(StringSE id)

      指定された識別子を使用して、現在の一時的な会話を長時間実行していることをマークします。

      パラメーター:
      id - 会話 ID
      例外:
      IllegalStateExceptionSE - 現在の会話がすでに長期実行としてマークされている場合。
      IllegalArgumentExceptionSE - 指定された識別子の会話がすでに存在する場合。

    • end

      void end()

      現在の長時間実行中の会話を一時的なものとしてマークします。

      例外:
      IllegalStateExceptionSE - 現在の会話がすでに一時的とマークされている場合。

    • getId

      StringSE getId()

      現在実行中の会話の識別子を取得します。

      戻り値:
      現在の長時間実行中の会話の識別子。現在の会話が一時的な場合は null 値。

    • getTimeout

      long getTimeout()

      現在の会話のタイムアウトを取得します。

      戻り値:
      ミリ秒単位の現在のタイムアウト。

    • setTimeout

      void setTimeout(long milliseconds)

      現在の会話のタイムアウトを設定します。

      パラメーター:
      milliseconds - ミリ秒単位の新しいタイムアウト。

    • isTransient

      boolean isTransient()

      会話が一時的または長時間実行としてマークされているかどうかを確認します。

      戻り値:
      会話が一時的とマークされている場合は true、長時間実行とマークされている場合は false。