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

インターフェース FlowSession

すべての既知の実装クラス:
MockFlowSession
public interface FlowSession
全体的なフロー実行内で起動される flow definition の単一のローカルインスタンス化。

このオブジェクトは、1 つの管理 FlowExecution 内のセッションステータスを含むすべてのインスタンス状態と、現在のフロー状態を維持します。このオブジェクトは、ローカルの「フロースコープ」データモデルとしても機能します。flow scope 内のデータは、このオブジェクトの存続期間中存続し、このオブジェクトが破棄されると自動的にクリーンアップされます。このセッションが終了状態になると、破棄が行われます。

フローセッションは HTTP セッションにリンクされていないことに注意してください。フローセッションは、ステートフルオブジェクトを表すために、使い慣れた「セッション」命名規則を使用するだけです。

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

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    FlowDefinition
    getDefinition()
    このセッションをサポートするフロー定義を返します。
    FlowSession
    getParent()
    現在のフロー実行の親フローセッションを返します。親フローセッションがない場合は null を返します。
    MutableAttributeMap<ObjectSE>
    getScope()
    このセッションのローカル属性を返します。これは、「フロースコープ」(フローセッションスコープ) の基礎となります。
    StateDefinition
    getState()
    このフローセッションの現在の状態を返します。
    MutableAttributeMap<ObjectSE>
    getViewScope()
    「ビュースコープ」に保持されているデータの変更可能なマップを返します。
    boolean
    isEmbeddedMode()
    フローセッションが埋め込みページモードで開始された場合は true を返します。
    boolean
    isRoot()
    このフローセッションが進行中のフロー実行におけるルートフローセッションであるかどうかを返します。

  • メソッドの詳細

    • getDefinition

      FlowDefinition getDefinition()
      このセッションをサポートするフロー定義を返します。

    • getState

      StateDefinition getState()
      このフローセッションの現在の状態を返します。この値はフローの実行に応じて変化します。

    • getScope

      MutableAttributeMap<ObjectSE> getScope()
      このセッションのローカル属性を返します。これは、「フロースコープ」(フローセッションスコープ) の基礎となります。
      戻り値:
      フロースコープ属性

    • getViewScope

      MutableAttributeMap<ObjectSE> getViewScope() throws IllegalStateExceptionSE
      「ビュースコープ」に保持されているデータの変更可能なマップを返します。このマップ内の属性は、現在のビュー状態が終了するとクリアされます。
      戻り値:
      ビュー範囲
      例外:
      IllegalStateExceptionSE - このフローセッションが現在ビュー状態にない場合

    • isEmbeddedMode

      boolean isEmbeddedMode()
      フローセッションが埋め込みページモードで開始された場合は true を返します。埋め込みフローは、投稿後のリダイレクトが必要かどうかに関して異なる仮定を行うことができます。

    • getParent

      FlowSession getParent()
      現在のフロー実行の親フローセッションを返します。親フローセッションがない場合は null を返します。

    • isRoot

      boolean isRoot()
      このフローセッションが進行中のフロー実行におけるルートフローセッションであるかどうかを返します。ルートフローセッションには親フローセッションがありません。