パッケージ org.springframework.webflow.execution

インターフェース FlowExecutionContext

既知のすべてのサブインターフェース:
FlowExecution
すべての既知の実装クラス:
FlowExecutionImpl, MockFlowExecutionContext
public interface FlowExecutionContext
フロー実行に関するコンテキスト情報を提供します。フロー実行は、FlowDefinition の実行可能なインスタンスです。これは、クライアントとの会話を実行するための中心的な Spring Web Flow 構成要素です。この不変のインターフェースは、status や current state などの会話に関する実行時情報へのアクセスを提供します。

このインターフェースを実装するオブジェクトは、実行リクエストコンテキストからもトラバース可能です (RequestContext.getFlowExecutionContext() を参照)。

このインターフェースは、スレッドセーフな方法で複数のリクエストにまたがる可能性のある情報を提供します。RequestContext インターフェースは、1 つのリクエストから 1 つのフロー実行をローカルに操作するための、 リクエスト固有の制御インターフェースを定義します。

作成者:
Keith Donald, Erwin Vervaet
関連事項:

  • 方法の概要

    修飾子と型
    メソッド
    説明
    FlowSession
    getActiveSession()
    このフロー実行のアクティブなフローセッションを返します。
    AttributeMap<ObjectSE>
    getAttributes()
    状態やアクションなど、フロー成果物の動作に影響を与える可能性のあるランタイム実行属性を返します。
    MutableAttributeMap<ObjectSE>
    getConversationScope()
    「会話スコープ」に保持されているデータの変更可能なマップを返します。
    FlowDefinition
    getDefinition()
    この実行中のフローに関連付けられたルートフロー定義を返します。
    MutableAttributeMap<ObjectSE>
    getFlashScope()
    「フラッシュスコープ」に保持されているデータの変更可能なマップを返します。
    FlowExecutionKey
    getKey()
    このフロー実行に割り当てられたキーを返します。
    FlowExecutionOutcome
    getOutcome()
    この実行によって到達した結果を返します。この実行がまだ終了していない場合は null を返します。
    boolean
    hasEnded()
    この実行が終了したかどうかを示すフラグを返します。
    boolean
    hasStarted()
    この実行が開始されたかどうかを示すフラグを返します。
    boolean
    isActive()
    フロー実行はアクティブですか ? フロー実行は、active session を取得するとアクティブになり、終了するまでアクティブなままになります。

  • メソッドの詳細

    • getKey

      FlowExecutionKey getKey()
      このフロー実行に割り当てられたキーを返します。フロー実行キーは、フロー実行の永続的な ID です。
      戻り値:
      フロー実行キー。キーがまだ割り当てられていない場合は、null になることがあります。

    • getDefinition

      FlowDefinition getDefinition()
      この実行中のフローに関連付けられたルートフロー定義を返します。

      このメソッドを呼び出すと、実際にアクティブなフロー (たとえば、サブフローが生成されているかどうか) に関係なく、常に同じフロー定義 (最上位の「ルート」) が返されます。

      戻り値:
      ルートフロー定義

    • hasStarted

      boolean hasStarted()
      この実行が開始されたかどうかを示すフラグを返します。開始されてアクティブなフロー実行は現在進行中です。開始されてアクティブでないフロー実行は終了しています。
      戻り値:
      開始されている場合は true、開始されていない場合は false
      関連事項:

    • isActive

      boolean isActive()
      フロー実行はアクティブですか ? フロー実行は、active session を取得するとアクティブになり、終了するまでアクティブなままになります。
      戻り値:
      アクティブな場合は true、フロー実行が終了したかまだ開始されていない場合は false

    • hasEnded

      boolean hasEnded()
      この実行が終了したかどうかを示すフラグを返します。終了したフロー実行は開始されましたが、アクティブではなくなりました。
      戻り値:
      終了した場合は true、開始されていないかまだアクティブな場合は false
      関連事項:

    • getOutcome

      FlowExecutionOutcome getOutcome()
      この実行によって到達した結果を返します。この実行がまだ終了していない場合は null を返します。
      戻り値:
      結果、またはこの実行がまだ終了していない場合は null 

    • getActiveSession

      FlowSession getActiveSession() throws IllegalStateExceptionSE
      このフロー実行のアクティブなフローセッションを返します。アクティブなフローセッションは、現在実行中のセッションです。これは「ルートフロー」セッションの場合もあれば、このフロー実行によってサブフローが生成された場合にはサブフローセッションの場合もあります。
      戻り値:
      アクティブフローセッション
      例外:
      IllegalStateExceptionSE - このフロー実行がアクティブでない場合
      関連事項:

    • getFlashScope

      MutableAttributeMap<ObjectSE> getFlashScope()
      「フラッシュスコープ」に保持されているデータの変更可能なマップを返します。このマップの属性は、次のビューレンダリング時にクリアされます。フラッシュ属性は、フロー実行のリフレッシュ操作後も保持されます。
      戻り値:
      フラッシュスコープ

    • getConversationScope

      MutableAttributeMap<ObjectSE> getConversationScope()
      「会話スコープ」に保持されているデータの変更可能なマップを返します。会話スコープは、このフロー実行の存続期間中存在し、すべてのフローセッションからアクセスできるデータ構造です。
      戻り値:
      会話の範囲

    • getAttributes

      AttributeMap<ObjectSE> getAttributes()
      状態やアクションなど、フロー成果物の動作に影響を与える可能性のあるランタイム実行属性を返します。
      戻り値:
      実行属性