パッケージ org.springframework.webflow.context.servlet

クラス ServletExternalContext

java.lang.ObjectSE
org.springframework.webflow.context.servlet.ServletExternalContext
実装されたすべてのインターフェース:
ExternalContext
既知の直属サブクラス
MvcExternalContext
public class ServletExternalContext extends ObjectSE implements ExternalContext
Spring Web Flow と対話した HTTP サーブレット環境に関するコンテキスト情報を提供します。
作成者:
Keith Donald, Erwin Vervaet, Jeremy Grelle

  • コンストラクターの概要

    コンストラクター
    コンストラクター
    説明
    ServletExternalContext(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
    指定されたサーブレット HTTP リクエストとレスポンス、および指定されたサーブレットコンテキストをラップする新しい外部コンテキストを作成します。
    ServletExternalContext(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, FlowUrlHandler flowUrlHandler)
    指定されたサーブレット HTTP リクエストとレスポンス、および指定されたサーブレットコンテキストをラップする新しい外部コンテキストを作成します。

  • メソッドのサマリー

    修飾子と型
    メソッド
    説明
    SharedAttributeMap<ObjectSE>
    getApplicationMap()
    外部アプリケーションマップへのアクセスを提供し、現在のユーザーアプリケーションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
    protected jakarta.servlet.ServletContext
    getContext()
    サーブレットのコンテキストを返します。
    StringSE
    getContextPath()
    この外部コンテキストをホストするアプリケーションへの論理パスを返します。
    PrincipalSE
    getCurrentUser()
    ユーザーの主要なセキュリティオブジェクトへのアクセスを提供します。
    boolean
    getExternalRedirectRequested()
    フローによって外部リダイレクトレスポンスがリクエストされたかどうかを示すフラグを返します。
    StringSE
    getExternalRedirectUrl()
    リダイレクト先の URL を返します。
    boolean
    getFlowDefinitionRedirectRequested()
    フロー定義リダイレクトレスポンスがフローによってリクエストされたかどうかを示すフラグを返します。
    boolean
    getFlowExecutionRedirectRequested()
    フローによってフロー実行リダイレクトレスポンスがリクエストされたかどうかを示すフラグを返します。
    StringSE
    getFlowExecutionUrl(StringSE flowId, StringSE flowExecutionKey)
    指定されたキーを使用して実行するためのフロー実行 URL を取得します。
    StringSE
    getFlowRedirectFlowId()
    リダイレクト先のフロー定義の ID を返します。
    MutableAttributeMap<ObjectSE>
    getFlowRedirectFlowInput()
    リダイレクトを介してフロー定義を渡すための入力を返します。
    protected FlowUrlHandler
    getFlowUrlHandler()
    設定されたフロー URL ハンドラーを返します。
    SharedAttributeMap<ObjectSE>
    getGlobalSessionMap()
    グローバル外部セッションマップへのアクセスを提供し、ユーザーセッション全体でグローバルにデータを保存し、内部および外部の SWF 成果物の両方にアクセスできるようにします。
    LocaleSE
    getLocale()
    クライアントのロケールを返します。
    ObjectSE
    getNativeContext()
    現在の環境のコンテキストオブジェクトへのアクセスを提供します。
    ObjectSE
    getNativeRequest()
    現在の環境のリクエストオブジェクトへのアクセスを提供します。
    ObjectSE
    getNativeResponse()
    現在の環境のレスポンスオブジェクトへのアクセスを提供します。
    boolean
    getRedirectInPopup()
    リダイレクトレスポンスがリクエストされた場合、ポップアップダイアログからリダイレクトを発行するかどうかを示します。
    protected jakarta.servlet.http.HttpServletRequest
    getRequest()
    基になる HttpServletRequest を返します。
    MutableAttributeMap<ObjectSE>
    getRequestMap()
    外部リクエスト属性マップへのアクセスを提供し、現在のユーザーリクエストに対してローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
    ParameterMap
    getRequestParameterMap()
    SWF の呼び出しにつながったユーザーリクエストに関連付けられたパラメーターへのアクセスを提供します。
    protected jakarta.servlet.http.HttpServletResponse
    getResponse()
    基になる HttpServletResponse を返します。
    WriterSE
    getResponseWriter()
    回答を書くためにライターを雇ってください。
    SharedAttributeMap<ObjectSE>
    getSessionMap()
    外部セッションマップへのアクセスを提供し、現在のユーザーセッションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
    boolean
    isAjaxRequest()
    現在のリクエストが非同期 Ajax リクエストの場合は true を返します。
    boolean
    isResponseAllowed()
    このリクエストに対してレンダリングレスポンスを書き込むことは許可されていますか ? レスポンスが完了した後は常に false を返します。
    boolean
    isResponseComplete()
    レスポンスは完了しましたか ? レスポンス完了ステータスは、レスポンスを書き出して ExternalContext.recordResponseComplete() を呼び出すか、リダイレクトリクエストメソッドのいずれかを呼び出すことで達成できます。
    boolean
    isResponseCompleteFlowExecutionRedirect()
    フロー実行リダイレクトリクエストでレスポンスが完了した場合は true を返します。
    void
    recordResponseComplete()
    ビュー状態や終了状態などのフローアーティファクトによって呼び出され、通常はレスポンスストリームにコンテンツを書き出すことによってレスポンスを処理したことを示します。
    void
    requestExternalRedirect(StringSE location)
    任意のリソースの場所へのリダイレクトをリクエストします。
    void
    requestFlowDefinitionRedirect(StringSE flowId, MutableAttributeMap<?> input)
    呼び出し環境によってフロー定義リダイレクトを実行するようにリクエストします。
    void
    requestFlowExecutionRedirect()
    呼び出し環境によってフロー実行リダイレクトを実行するようにリクエストします。
    void
    requestRedirectInPopup()
    リクエストされた現在のリダイレクトを、クライアントがポップアップダイアログからリダイレクトを発行するようにクライアントに送信するようにリクエストします。
    void
    setAjaxRequest(boolean ajaxRequest)
    このクライアントからの現在のリクエストが Ajax リクエストであるかどうかを示します。

    クラス java.lang.ObjectSE から継承されたメソッド

    clone, equalsSE, finalize, getClass, hashCode, notify, notifyAll, toString, wait, waitSE, waitSE

  • コンストラクターの詳細

    • ServletExternalContext

      public ServletExternalContext(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      指定されたサーブレット HTTP リクエストとレスポンス、および指定されたサーブレットコンテキストをラップする新しい外部コンテキストを作成します。
      パラメーター:
      context - サーブレットコンテキスト
      request - http サーブレットリクエスト
      response - http サーブレットのレスポンス

    • ServletExternalContext

      public ServletExternalContext(jakarta.servlet.ServletContext context, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, FlowUrlHandler flowUrlHandler)
      指定されたサーブレット HTTP リクエストとレスポンス、および指定されたサーブレットコンテキストをラップする新しい外部コンテキストを作成します。
      パラメーター:
      context - サーブレットコンテキスト
      request - http サーブレットリクエスト
      response - http サーブレットのレスポンス
      flowUrlHandler - フロー URL ハンドラー

  • メソッドの詳細

    • setAjaxRequest

      public void setAjaxRequest(boolean ajaxRequest)
      このクライアントからの現在のリクエストが Ajax リクエストであるかどうかを示します。このフラグは、Spring Web Flow 内でのレスポンス書き込みの処理に影響する可能性があります。
      パラメーター:
      ajaxRequest - Ajax リクエストフラグ

    • getContextPath

      public StringSE getContextPath()
      インターフェースからコピーされた説明: ExternalContext
      この外部コンテキストをホストするアプリケーションへの論理パスを返します。
      次で指定:
      インターフェース ExternalContext の getContextPath 
      戻り値:
      コンテキストパス

    • getRequestParameterMap

      public ParameterMap getRequestParameterMap()
      インターフェースからコピーされた説明: ExternalContext
      SWF の呼び出しにつながったユーザーリクエストに関連付けられたパラメーターへのアクセスを提供します。このマップは不変であると想定されており、変更することはできません。
      次で指定:
      インターフェース ExternalContext の getRequestParameterMap 
      戻り値:
      不変のリクエストパラメーターマップ

    • getRequestMap

      public MutableAttributeMap<ObjectSE> getRequestMap()
      インターフェースからコピーされた説明: ExternalContext
      外部リクエスト属性マップへのアクセスを提供し、現在のユーザーリクエストに対してローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
      次で指定:
      インターフェース ExternalContext の getRequestMap 
      戻り値:
      変更可能なリクエスト属性マップ

    • getSessionMap

      public SharedAttributeMap<ObjectSE> getSessionMap()
      インターフェースからコピーされた説明: ExternalContext
      外部セッションマップへのアクセスを提供し、現在のユーザーセッションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
      次で指定:
      インターフェース ExternalContext の getSessionMap 
      戻り値:
      可変セッション属性マップ

    • getGlobalSessionMap

      public SharedAttributeMap<ObjectSE> getGlobalSessionMap()
      インターフェースからコピーされた説明: ExternalContext
      グローバル外部セッションマップへのアクセスを提供し、ユーザーセッション全体でグローバルにデータを保存し、内部および外部の SWF 成果物の両方にアクセスできるようにします。

      メモ: ほとんどの外部コンテキスト実装では、「ローカル」ユーザーセッションスコープと「グローバル」セッションスコープの概念を区別しません。それ以外の場合、このメソッドは ExternalContext.getSessionMap() を呼び出す場合と同じマップを返します。

      次で指定:
      インターフェース ExternalContext の getGlobalSessionMap 
      戻り値:
      可変グローバルセッション属性マップ

    • getApplicationMap

      public SharedAttributeMap<ObjectSE> getApplicationMap()
      インターフェースからコピーされた説明: ExternalContext
      外部アプリケーションマップへのアクセスを提供し、現在のユーザーアプリケーションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。
      次で指定:
      インターフェース ExternalContext の getApplicationMap 
      戻り値:
      可変アプリケーション属性マップ

    • getCurrentUser

      public PrincipalSE getCurrentUser()
      インターフェースからコピーされた説明: ExternalContext
      ユーザーの主要なセキュリティオブジェクトへのアクセスを提供します。
      次で指定:
      インターフェース ExternalContext の getCurrentUser 
      戻り値:
      ユーザープリンシパル

    • getLocale

      public LocaleSE getLocale()
      インターフェースからコピーされた説明: ExternalContext
      クライアントのロケールを返します。
      次で指定:
      インターフェース ExternalContext の getLocale 
      戻り値:
      ロケール

    • getNativeContext

      public ObjectSE getNativeContext()
      インターフェースからコピーされた説明: ExternalContext
      現在の環境のコンテキストオブジェクトへのアクセスを提供します。
      次で指定:
      インターフェース ExternalContext の getNativeContext 
      戻り値:
      環境固有のコンテキストオブジェクト

    • getNativeRequest

      public ObjectSE getNativeRequest()
      インターフェースからコピーされた説明: ExternalContext
      現在の環境のリクエストオブジェクトへのアクセスを提供します。
      次で指定:
      インターフェース ExternalContext の getNativeRequest 
      戻り値:
      環境固有のリクエストオブジェクト。

    • getNativeResponse

      public ObjectSE getNativeResponse()
      インターフェースからコピーされた説明: ExternalContext
      現在の環境のレスポンスオブジェクトへのアクセスを提供します。
      次で指定:
      インターフェース ExternalContext の getNativeResponse 
      戻り値:
      環境固有のレスポンスオブジェクト。

    • isAjaxRequest

      public boolean isAjaxRequest()
      インターフェースからコピーされた説明: ExternalContext
      現在のリクエストが非同期 Ajax リクエストの場合は true を返します。
      次で指定:
      インターフェース ExternalContext の isAjaxRequest 
      戻り値:
      現在のリクエストが Ajax リクエストの場合は true

    • getFlowExecutionUrl

      public StringSE getFlowExecutionUrl(StringSE flowId, StringSE flowExecutionKey)
      インターフェースからコピーされた説明: ExternalContext
      指定されたキーを使用して実行のフロー実行 URL を取得します。通常、後続のリクエストでのポストバックをサポートするためにフロー実行への参照を書き出すレスポンスライターによって使用されます。返される URL はエンコードされます。
      次で指定:
      インターフェース ExternalContext の getFlowExecutionUrl 
      パラメーター:
      flowId - フロー定義 ID
      flowExecutionKey - フロー実行キー
      戻り値:
      フロー実行 URL

    • getResponseWriter

      public WriterSE getResponseWriter() throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: ExternalContext
      回答を書くためにライターを雇ってください。
      次で指定:
      インターフェース ExternalContext の getResponseWriter 
      戻り値:
      ライター
      例外:
      IllegalStateExceptionSE - レスポンスが完了したか許可されていない場合

    • isResponseAllowed

      public boolean isResponseAllowed()
      インターフェースからコピーされた説明: ExternalContext
      このリクエストに対してレンダリングレスポンスを書き込むことは許可されていますか ? レスポンスが完了した後は、常に false を返します。レスポンスを完了できないことを示すために、それより前に false を返す場合があります。
      次で指定:
      インターフェース ExternalContext の isResponseAllowed 
      戻り値
      はいの場合は true、そうでない場合は false

    • isResponseComplete

      public boolean isResponseComplete()
      インターフェースからコピーされた説明: ExternalContext
      レスポンスは完了しましたか ? レスポンス完了ステータスは、次の方法で達成できます。
      次で指定:
      インターフェース ExternalContext の isResponseComplete 
      戻り値
      はいの場合は true、そうでない場合は false
      関連事項:

    • recordResponseComplete

      public void recordResponseComplete()
      インターフェースからコピーされた説明: ExternalContext
      ビュー状態や終了状態などのフローアーティファクトによって呼び出され、通常はレスポンスストリームにコンテンツを書き出すことによってレスポンスが処理されたことを示します。このフラグを設定すると、この外部コンテキストはレスポンスが処理されたことを認識でき、追加のレスポンス処理アクションを実行する必要がなくなります。
      次で指定:
      インターフェース ExternalContext の recordResponseComplete 

    • isResponseCompleteFlowExecutionRedirect

      public boolean isResponseCompleteFlowExecutionRedirect()
      インターフェースからコピーされた説明: ExternalContext
      フロー実行リダイレクトリクエストでレスポンスが完了した場合は true を返します。
      次で指定:
      インターフェース ExternalContext の isResponseCompleteFlowExecutionRedirect 
      戻り値:
      リダイレクトレスポンスが完了した場合は true
      関連事項:

    • requestFlowExecutionRedirect

      public void requestFlowExecutionRedirect() throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: ExternalContext
      フロー実行リダイレクトが呼び出し環境によって実行されるようにリクエストします。通常、フロー実行内から呼び出され、リフレッシュ操作をリクエストします。通常は、「イベント処理後のリフレッシュ」動作をサポートするためです。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。
      次で指定:
      インターフェース ExternalContext の requestFlowExecutionRedirect 
      例外:
      IllegalStateExceptionSE - レスポンスが完了した場合
      関連事項:

    • requestFlowDefinitionRedirect

      public void requestFlowDefinitionRedirect(StringSE flowId, MutableAttributeMap<?> input) throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: ExternalContext
      フロー定義のリダイレクトが呼び出し環境によって実行されるようにリクエストします。通常、フロー実行終了状態内から呼び出され、チェーンのような方法でフローの新しい独立した実行を開始するようにリクエストします。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。
      次で指定:
      インターフェース ExternalContext の requestFlowDefinitionRedirect 
      パラメーター:
      flowId - リダイレクト先のフロー定義の ID
      input - フローを渡すための入力。この入力は通常、フローを起動するための URL をエンコードします。
      例外:
      IllegalStateExceptionSE - レスポンスが完了した場合
      関連事項:

    • requestExternalRedirect

      public void requestExternalRedirect(StringSE location) throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: ExternalContext
      任意のリソースの場所へのリダイレクトをリクエストします。一部の環境ではサポートされない場合があります。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。
      次で指定:
      インターフェース ExternalContext の requestExternalRedirect 
      パラメーター:
      location - リダイレクト先のリソースの場所
      例外:
      IllegalStateExceptionSE - レスポンスが完了した場合
      関連事項:

    • requestRedirectInPopup

      public void requestRedirectInPopup() throws IllegalStateExceptionSE
      インターフェースからコピーされた説明: ExternalContext
      リクエストされた現在のリダイレクトを、クライアントがポップアップダイアログからリダイレクトを発行するようにクライアントに送信するようにリクエストします。リダイレクトがリクエストされた後にのみ、このメソッドを呼び出します。
      次で指定:
      インターフェース ExternalContext の requestRedirectInPopup 
      例外:
      IllegalStateExceptionSE - リダイレクトがリクエストされていない場合
      関連事項:

    • getFlowExecutionRedirectRequested

      public boolean getFlowExecutionRedirectRequested()
      フローによってフロー実行リダイレクトレスポンスがリクエストされたかどうかを示すフラグを返します。

    • getFlowDefinitionRedirectRequested

      public boolean getFlowDefinitionRedirectRequested()
      フロー定義リダイレクトレスポンスがフローによってリクエストされたかどうかを示すフラグを返します。

    • getFlowRedirectFlowId

      public StringSE getFlowRedirectFlowId()
      リダイレクト先のフロー定義の ID を返します。getFlowDefinitionRedirectRequested() が true を返す場合にのみ設定されます。

    • getFlowRedirectFlowInput

      public MutableAttributeMap<ObjectSE> getFlowRedirectFlowInput()
      リダイレクトを介してフロー定義を渡すための入力を返します。getFlowDefinitionRedirectRequested() が true を返す場合にのみ設定されます。

    • getExternalRedirectRequested

      public boolean getExternalRedirectRequested()
      フローによって外部リダイレクトレスポンスがリクエストされたかどうかを示すフラグを返します。

    • getExternalRedirectUrl

      public StringSE getExternalRedirectUrl()
      リダイレクト先の URL を返します。getExternalRedirectRequested() が true を返す場合にのみ設定されます。

    • getRedirectInPopup

      public boolean getRedirectInPopup()
      リダイレクトレスポンスがリクエストされた場合、ポップアップダイアログからリダイレクトを発行するかどうかを示します。

    • getContext

      protected jakarta.servlet.ServletContext getContext()
      サーブレットのコンテキストを返します。

    • getRequest

      protected jakarta.servlet.http.HttpServletRequest getRequest()
      基になる HttpServletRequest を返します。

    • getResponse

      protected jakarta.servlet.http.HttpServletResponse getResponse()
      基になる HttpServletResponse を返します。

    • getFlowUrlHandler

      protected FlowUrlHandler getFlowUrlHandler()
      設定されたフロー URL ハンドラーを返します。