jp.terasoluna.fw.web.rich.context.support
クラス AbstractRequestContextSupport

java.lang.Object
  上位を拡張 jp.terasoluna.fw.web.rich.context.support.AbstractRequestContextSupport
すべての実装されたインタフェース:
RequestContextSupport
直系の既知のサブクラス:
DefaultRequestContextSupportImpl

public abstract class AbstractRequestContextSupport
extends Object
implements RequestContextSupport

制御情報を扱うための補助ロジックインタフェースを継承した抽象クラス。

業務コンテキストマネージャより業務コンテキストを取得し、必要な情報を返却する。

RequestContext, RequestContextManagerを利用して 制御情報を扱う実装を提供している。 詳細は、RequestContext, RequestContextManagerを参照すること。

制御情報に設定する値はHTTPリクエストから取得する。 HTTPリクエストから取得する項目は、システムの要件によって変化するため、 リクエスト名をリクエストヘッダ以外の箇所から取得する場合や、 業務プロパティを保持したい場合等は、 必要に応じてシステムごとに本クラスの実装クラスを作成し、 制御情報初期化の抽象メソッドを実装すること。

システムとして特に上記のような要件がない場合は、デフォルト実装である、 DefaultRequestContextSupportImplを利用すること。

本クラスを利用する場合、実装クラスをBean定義すること。 定義例は、実装クラスを参照すること。 また、以下のプロパティを必ず設定すること。

関連項目:
RequestContext, RequestContextManager

コンストラクタの概要
AbstractRequestContextSupport()
           
 
メソッドの概要
 void destroyContext()
          制御情報を破棄する。
protected abstract  RequestContext doGenerateContext(javax.servlet.http.HttpServletRequest request)
          制御情報を生成・初期化して返却する。
 void generateContext(javax.servlet.http.HttpServletRequest request)
          業務コンテキストを生成する。
 Object getProperty(String key)
          業務プロパティを取得する。
<E> E
getProperty(String key, Class<E> clazz)
          返却値の型を指定して、業務プロパティを取得する。
 String getPropertyString(String key)
          String型の業務プロパティを取得する。
protected  RequestContext getRequestContext()
          制御情報をマネージャより取得する。
 String getRequestName()
          実行する業務ロジックを識別するリクエスト名を取得する。
 
クラス java.lang.Object から継承されたメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

コンストラクタの詳細

AbstractRequestContextSupport

public AbstractRequestContextSupport()
メソッドの詳細

getRequestName

public String getRequestName()
実行する業務ロジックを識別するリクエスト名を取得する。

定義:
インタフェース RequestContextSupport 内の getRequestName
戻り値:
リクエスト名

getProperty

public Object getProperty(String key)
業務プロパティを取得する。 業務ごとに独自に保持したい情報は、このメソッドで取得する。

定義:
インタフェース RequestContextSupport 内の getProperty
パラメータ:
key - キー
戻り値:
業務プロパティ

getProperty

public <E> E getProperty(String key,
                         Class<E> clazz)
返却値の型を指定して、業務プロパティを取得する。 業務ごとに独自に保持したい情報は、このメソッドで取得する。 取得する業務プロパティの型と指定された型が違った場合は、 実行時例外を発生させる。

定義:
インタフェース RequestContextSupport 内の getProperty
型パラメータ:
E - 返却値の型
パラメータ:
key - キー
戻り値:
業務プロパティ

getPropertyString

public String getPropertyString(String key)
String型の業務プロパティを取得する。 業務ごとに独自に保持したい情報は、このメソッドで取得する。

定義:
インタフェース RequestContextSupport 内の getPropertyString
パラメータ:
key - キー
戻り値:
業務プロパティ

generateContext

public void generateContext(javax.servlet.http.HttpServletRequest request)
業務コンテキストを生成する。

定義:
インタフェース RequestContextSupport 内の generateContext
パラメータ:
request - HTTPリクエスト

doGenerateContext

protected abstract RequestContext doGenerateContext(javax.servlet.http.HttpServletRequest request)
制御情報を生成・初期化して返却する。

パラメータ:
request - HTTPリクエスト
戻り値:
生成した空の制御情報。

destroyContext

public void destroyContext()
制御情報を破棄する。

定義:
インタフェース RequestContextSupport 内の destroyContext

getRequestContext

protected RequestContext getRequestContext()
制御情報をマネージャより取得する。

戻り値:
制御情報


Copyright © 2012. All Rights Reserved.