パッケージ org.springframework.web.context.request

クラス FacesRequestAttributes

java.lang.ObjectSE
org.springframework.web.context.request.FacesRequestAttributes
実装されたすべてのインターフェース:
RequestAttributes
既知の直属サブクラス
FacesWebRequest
public class FacesRequestAttributes extends ObjectSE implements RequestAttributes
JSF FacesContextEE 用の RequestAttributes アダプター。JSF 環境でデフォルトとして使用され、現在の FacesContext をラップします。

注 :ServletRequestAttributes とは対照的に、このバリアントは、リクエストスコープでもセッションスコープでも、スコープ属性の破棄コールバックをサポートしていません。このような暗黙の破棄コールバックに依存している場合は、web.xml で Spring RequestContextListener を定義することを検討してください。

Spring 4.0 以降、JSF 2.0 以上が必要です。

導入:
2.5.2
作成者:
Juergen Hoeller
関連事項:

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

    • FacesRequestAttributes

      public FacesRequestAttributes(FacesContextEE facesContext)
      指定された FacesContext の新しい FacesRequestAttributes アダプターを作成します。
      パラメーター:
      facesContext - 現在の FacesContext
      関連事項:

  • メソッドの詳細

    • getFacesContext

      protected final FacesContextEE getFacesContext()
      このアダプターが動作する JSF FacesContext を返します。

    • getExternalContext

      protected final ExternalContextEE getExternalContext()
      このアダプターが動作する JSF ExternalContext を返します。
      関連事項:

    • getAttributeMap

      protected MapSE<StringSE,ObjectSE> getAttributeMap(int scope)
      指定されたスコープの JSF 属性マップを返します。
      パラメーター:
      scope - リクエストまたはセッションスコープを示す定数
      戻り値:
      指定されたスコープ内の属性のマップ表現
      関連事項:

    • getAttribute

      @Nullable public ObjectSE getAttribute(StringSE name, int scope)
      インターフェースからコピーされた説明: RequestAttributes
      指定された名前のスコープ付き属性の値を返します（ある場合）。
      次で指定:
      インターフェース RequestAttributes の getAttribute 
      パラメーター:
      name - 属性の名前
      scope - スコープ識別子
      戻り値:
      現在の属性値。見つからない場合は null 

    • setAttribute

      public void setAttribute(StringSE name, ObjectSE value, int scope)
      インターフェースからコピーされた説明: RequestAttributes
      指定された名前のスコープ属性の値を設定し、既存の値（存在する場合）を置き換えます。
      次で指定:
      インターフェース RequestAttributes の setAttribute 
      パラメーター:
      name - 属性の名前
      value - 属性の値
      scope - スコープ識別子

    • removeAttribute

      public void removeAttribute(StringSE name, int scope)
      インターフェースからコピーされた説明: RequestAttributes
      指定された名前のスコープ属性が存在する場合は削除します。

      実装では、指定された属性に登録されている破棄コールバックも削除する必要があることに注意してください。ただし、この場合、登録された破棄コールバックを実行する必要はありません。オブジェクトが呼び出し側によって破棄されるためです（該当する場合）。

      次で指定:
      インターフェース RequestAttributes の removeAttribute 
      パラメーター:
      name - 属性の名前
      scope - スコープ識別子

    • getAttributeNames

      public StringSE[] getAttributeNames(int scope)
      インターフェースからコピーされた説明: RequestAttributes
      スコープ内のすべての属性の名前を取得します。
      次で指定:
      インターフェース RequestAttributes の getAttributeNames 
      パラメーター:
      scope - スコープ識別子
      戻り値:
      文字列配列としての属性名

    • registerDestructionCallback

      public void registerDestructionCallback(StringSE name, RunnableSE callback, int scope)
      インターフェースからコピーされた説明: RequestAttributes
      指定されたスコープ内の指定された属性の破棄時に実行されるコールバックを登録します。

      実装は、適切なときに、つまり、それぞれリクエストの補完時またはセッションの終了時にコールバックを実行するために最善を尽くす必要があります。そのようなコールバックが基本的なランタイム環境でサポートされていない場合は、コールバックを無視して、対応する警告をログに記録する必要があります。

      「破棄」は通常、スコープ全体の破棄に対応し、アプリケーションによって明示的に削除された個々の属性には対応しないことに注意してください。このファサードの RequestAttributes.removeAttribute(String, int) メソッドを介して属性が削除された場合、削除されたオブジェクトが再利用されるか手動で破棄されると想定して、登録されている破棄コールバックも無効にする必要があります。

      注意 : コールバックオブジェクトは、セッションスコープに登録されている場合、通常は直列化可能である必要があります。そうしないと、コールバック（またはセッション全体）が Web アプリの再起動に耐えられない可能性があります。

      次で指定:
      インターフェース RequestAttributes の registerDestructionCallback 
      パラメーター:
      name - コールバックを登録する属性の名前
      callback - 実行される破棄コールバック
      scope - スコープ識別子

    • resolveReference

      @Nullable public ObjectSE resolveReference(StringSE key)
      インターフェースからコピーされた説明: RequestAttributes
      指定されたキーのコンテキスト参照を解決します（ある場合）。

      最低でも: キー「リクエスト」の HttpServletRequest リファレンス、およびキー「セッション」の HttpSession リファレンス。

      次で指定:
      インターフェース RequestAttributes の resolveReference 
      パラメーター:
      key - コンテキストキー
      戻り値:
      対応するオブジェクト。見つからない場合は null 

    • getSessionId

      public StringSE getSessionId()
      インターフェースからコピーされた説明: RequestAttributes
      現在の基本的なセッションの ID を返します。
      次で指定:
      インターフェース RequestAttributes の getSessionId 
      戻り値:
      String としてのセッション ID (非 null)

    • getSessionMutex

      public ObjectSE getSessionMutex()
      インターフェースからコピーされた説明: RequestAttributes
      基盤となるセッションで利用可能な最良のミューテックス、つまり、基盤となるセッションで同期するオブジェクトを公開します。
      次で指定:
      インターフェース RequestAttributes の getSessionMutex 
      戻り値:
      使用するセッションミューテックス (非 null)