jp.terasoluna.fw.web.rich.context.support
インタフェース RequestContextSupport

既知の実装クラスの一覧:
AbstractRequestContextSupport, DefaultRequestContextSupportImpl

public interface RequestContextSupport

制御情報を扱うクラスが実装すべきインタフェース。

フレームワークやサービス層のクラスは、本インタフェースを 呼び出して、制御情報を参照することが出来る。

本インタフェースを呼び出す際は、本インタフェースの実装クラスをDIコンテナより設定して利用する。 通常は実装クラスとして、DefaultRequestContextSupportImplを利用すればよい。 DefaultRequestContextSupportImplでは業務の要件が満たせない場合にのみ、 抽象クラスAbstractRequestContextSupportまたは本インタフェースを実装した 業務要件を満たすクラスを作成し、利用すること。

制御情報を参照するクラスは、以下のようにBean定義すること。

Bean定義ファイルの設定例】

  <bean id="xxxx" class="xxxx.Xxx">
    <property name="ctxSupport" ref="ctxSupport"/>
  </bean>
  ※ctxSupportは、RequestContextSupport実装クラスのBean定義。
  詳細は、本インタフェースの実装クラスを参照すること。
 

制御情報を参照する際の実装を、以下にしめす。

Xxx.javaの実装例】

 public class Xxx {
   // 属性で定義
   RequestContextSupport ctxSupport;
   // セッターを用意(DIコンテナにより実行される)
   public void setCtxSupport(RequestContextSupport ctxSupport) {
       this.ctxSupport = ctxSupport;
   }
   // 制御情報を参照するロジック
   protected void execute(String urlPath) {
            ・・・・
       String requestName = ctxSupport.getRequestName();
       ・・・・
   }
 }
 


メソッドの概要
 void destroyContext()
          制御情報を破棄する。
 void generateContext(javax.servlet.http.HttpServletRequest request)
          制御情報を生成する。
 Object getProperty(String key)
          業務プロパティを取得する。
<E> E
getProperty(String key, Class<E> clazz)
          返却値の型を指定して、業務プロパティを取得する。
 String getPropertyString(String key)
          String型の業務プロパティを取得する。
 String getRequestName()
          リクエスト名を取得する。
 

メソッドの詳細

getRequestName

String getRequestName()
リクエスト名を取得する。

戻り値:
リクエスト名

getProperty

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

パラメータ:
key - キー
戻り値:
業務プロパティ

getProperty

<E> E getProperty(String key,
                  Class<E> clazz)
返却値の型を指定して、業務プロパティを取得する。 業務ごとに独自に保持したい情報は、このメソッドで取得する。

型パラメータ:
E - 返却値の型
パラメータ:
key - キー
戻り値:
業務プロパティ

getPropertyString

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

パラメータ:
key - キー
戻り値:
業務プロパティ

generateContext

void generateContext(javax.servlet.http.HttpServletRequest request)
制御情報を生成する。

パラメータ:
request - HTTPリクエスト

destroyContext

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



Copyright © 2012. All Rights Reserved.