インターフェース ExternalContext

メソッドの詳細

• getContextPath

  StringSE getContextPath()

  この外部コンテキストをホストするアプリケーションへの論理パスを返します。

  戻り値:

  コンテキストパス

• getRequestParameterMap

  ParameterMap getRequestParameterMap()

  SWF の呼び出しにつながったユーザーリクエストに関連付けられたパラメーターへのアクセスを提供します。このマップは不変であると想定されており、変更することはできません。

  戻り値:

  不変のリクエストパラメーターマップ

• getRequestMap

  MutableAttributeMap<ObjectSE> getRequestMap()

  外部リクエスト属性マップへのアクセスを提供し、現在のユーザーリクエストに対してローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。

  戻り値:

  変更可能なリクエスト属性マップ

• getSessionMap

  SharedAttributeMap<ObjectSE> getSessionMap()

  外部セッションマップへのアクセスを提供し、現在のユーザーセッションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。

  戻り値:

  可変セッション属性マップ

• getGlobalSessionMap

  SharedAttributeMap<ObjectSE> getGlobalSessionMap()

  グローバル外部セッションマップへのアクセスを提供し、ユーザーセッション全体でグローバルにデータを保存し、内部および外部の SWF 成果物の両方にアクセスできるようにします。

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

  戻り値:

  可変グローバルセッション属性マップ

• getApplicationMap

  SharedAttributeMap<ObjectSE> getApplicationMap()

  外部アプリケーションマップへのアクセスを提供し、現在のユーザーアプリケーションにローカルで、内部および外部の SWF 成果物の両方にアクセス可能なデータのストレージを提供します。

  戻り値:

  可変アプリケーション属性マップ

• isAjaxRequest

  boolean isAjaxRequest()

  現在のリクエストが非同期 Ajax リクエストの場合は true を返します。

  戻り値:

  現在のリクエストが Ajax リクエストの場合は true

• getFlowExecutionUrl

  StringSE getFlowExecutionUrl(StringSE flowId, StringSE flowExecutionKey)

  指定されたキーを使用して実行のフロー実行 URL を取得します。通常、後続のリクエストでのポストバックをサポートするためにフロー実行への参照を書き出すレスポンスライターによって使用されます。返される URL はエンコードされます。

  パラメーター:

  flowId - フロー定義 ID

  flowExecutionKey - フロー実行キー

  戻り値:

  フロー実行 URL

• getCurrentUser

  PrincipalSE getCurrentUser()

  ユーザーの主要なセキュリティオブジェクトへのアクセスを提供します。

  戻り値:

  ユーザープリンシパル

• getLocale

  LocaleSE getLocale()

  クライアントのロケールを返します。

  戻り値:

  ロケール

• getNativeContext

  ObjectSE getNativeContext()

  現在の環境のコンテキストオブジェクトへのアクセスを提供します。

  戻り値:

  環境固有のコンテキストオブジェクト

• getNativeRequest

  ObjectSE getNativeRequest()

  現在の環境のリクエストオブジェクトへのアクセスを提供します。

  戻り値:

  環境固有のリクエストオブジェクト。

• getNativeResponse

  ObjectSE getNativeResponse()

  現在の環境のレスポンスオブジェクトへのアクセスを提供します。

  戻り値:

  環境固有のレスポンスオブジェクト。

• getResponseWriter

  WriterSE getResponseWriter() throws IllegalStateExceptionSE

  回答を書くためにライターを雇ってください。

  戻り値:

  ライター

  例外:

  IllegalStateExceptionSE - レスポンスが完了したか許可されていない場合

• isResponseAllowed

  boolean isResponseAllowed()

  このリクエストに対してレンダリングレスポンスを書き込むことは許可されていますか ? レスポンスが完了した後は、常に false を返します。レスポンスを完了できないことを示すために、それより前に false を返す場合があります。

  戻り値

  はいの場合は true、そうでない場合は false

• requestFlowExecutionRedirect

  void requestFlowExecutionRedirect() throws IllegalStateExceptionSE

  フロー実行リダイレクトが呼び出し環境によって実行されるようにリクエストします。通常、フロー実行内から呼び出され、リフレッシュ操作をリクエストします。通常は、「イベント処理後のリフレッシュ」動作をサポートするためです。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。

  例外:

  IllegalStateExceptionSE - レスポンスが完了した場合

  関連事項:

  • isResponseComplete()

• requestFlowDefinitionRedirect

  void requestFlowDefinitionRedirect(StringSE flowId, MutableAttributeMap<?> input) throws IllegalStateExceptionSE

  フロー定義のリダイレクトが呼び出し環境によって実行されるようにリクエストします。通常、フロー実行終了状態内から呼び出され、チェーンのような方法でフローの新しい独立した実行を開始するようにリクエストします。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。

  パラメーター:

  flowId - リダイレクト先のフロー定義の ID

  input - フローを渡すための入力。この入力は通常、フローを起動するための URL をエンコードします。

  例外:

  IllegalStateExceptionSE - レスポンスが完了した場合

  関連事項:

  • isResponseComplete()

• requestExternalRedirect

  void requestExternalRedirect(StringSE location) throws IllegalStateExceptionSE

  任意のリソースの場所へのリダイレクトをリクエストします。一部の環境ではサポートされない場合があります。このメソッドを呼び出すと、responseComplete ステータスも true に設定されます。

  パラメーター:

  location - リダイレクト先のリソースの場所

  例外:

  IllegalStateExceptionSE - レスポンスが完了した場合

  関連事項:

  • isResponseComplete()

• requestRedirectInPopup

  void requestRedirectInPopup() throws IllegalStateExceptionSE

  リクエストされた現在のリダイレクトを、クライアントがポップアップダイアログからリダイレクトを発行するようにクライアントに送信するようにリクエストします。リダイレクトがリクエストされた後にのみ、このメソッドを呼び出します。

  例外:

  IllegalStateExceptionSE - リダイレクトがリクエストされていない場合

  関連事項:

  • requestFlowExecutionRedirect()
  • requestFlowDefinitionRedirect(String, MutableAttributeMap)
  • requestExternalRedirect(String)

• recordResponseComplete

  void recordResponseComplete()

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

• isResponseComplete

  boolean isResponseComplete()

  レスポンスは完了しましたか ? レスポンス完了ステータスは、次の方法で達成できます。

  • レスポンスを書き出して recordResponseComplete() を呼び出すか
  • リダイレクトリクエストメソッドの 1 つを呼び出す

  戻り値

  はいの場合は true、そうでない場合は false

  関連事項:

  • getResponseWriter()
  • recordResponseComplete()
  • requestFlowExecutionRedirect()
  • requestFlowDefinitionRedirect(String, MutableAttributeMap)
  • requestExternalRedirect(String)

• isResponseCompleteFlowExecutionRedirect

  boolean isResponseCompleteFlowExecutionRedirect()

  フロー実行リダイレクトリクエストでレスポンスが完了した場合は true を返します。

  戻り値:

  リダイレクトレスポンスが完了した場合は true

  関連事項:

  • isResponseComplete()
  • requestFlowExecutionRedirect()