nablarch.common.handler.threadcontext

クラス ThreadContextHandler

java.lang.Object

nablarch.common.handler.threadcontext.ThreadContextHandler

すべての実装されたインタフェース:

Handler<java.lang.Object,java.lang.Object>, InboundHandleable, OutboundHandleable

public class ThreadContextHandler
extends java.lang.Object
implements Handler<java.lang.Object,java.lang.Object>, InboundHandleable, OutboundHandleable

スレッドコンテキストに保持される共通属性を管理するハンドラ。 フレームワークには、スレッドコンテキストにユーザID・リクエストID・言語設定を保持する実装が含まれている。 これらを有効化するには以下のリポジトリ設定を追加する。 (同様にプロジェクト固有の属性を追加することも可能である。)

 <component class="nablarch.common.handler.threadcontext.ThreadContextHandler">
   <property name="attributes">
     <list>
       <!-- ユーザID -->
       <component class="nablarch.common.handler.threadcontext.UserIdAttribute">
         <property name="sessionKey"  value="user.id" />
         <property name="anonymousId" value="guest" />
       </component>
       
       <!-- リクエストID -->
       <component class="nablarch.common.handler.threadcontext.RequestIdAttribute" />
       
       <!-- 言語 -->
       <component class="nablarch.common.handler.threadcontext.LanguageAttribute">
           <property name="defaultLanguage" value="ja" />
       </component>
     </list>
   </property>
 </component>
 

コンストラクタのサマリー

コンストラクタ

コンストラクタと説明
ThreadContextHandler() デフォルトコンストラクタ
ThreadContextHandler(ThreadContextAttribute... attributes) 引数に渡されたスレッドコンテキスト属性を管理するハンドラを生成する。

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.Object	handle(java.lang.Object input, ExecutionContext ctx) 入力データに対する処理を実行する。
Result	handleInbound(ExecutionContext context) 前処理を実装する。
Result	handleOutbound(ExecutionContext context) 後処理を実装する。
ThreadContextHandler	setAttributes(java.util.List<ThreadContextAttribute> attributes) このハンドラが管理する属性のリストを登録する。

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

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ThreadContextHandler

public ThreadContextHandler(ThreadContextAttribute... attributes)

引数に渡されたスレッドコンテキスト属性を管理するハンドラを生成する。

 このメソッドの処理は以下のソースコードと等価である。
 
     new ThreadContextHandler()
         .setAttributes(Arrays.asList(attributes))
 

パラメータ:

attributes - スレッドコンテキスト属性

ThreadContextHandler

public ThreadContextHandler()

デフォルトコンストラクタ

メソッドの詳細

handle

public java.lang.Object handle(java.lang.Object input,
                               ExecutionContext ctx)

入力データに対する処理を実行する。

 このクラスの実装では以下の処理を行う。
 
   1. スレッドコンテキスト上の全てのエントリを削除する。
   2. このハンドラに登録されている全ての属性について、
      キー(ThreadContextAttribute#getKey()の結果)と値(ThreadContextAttribute#getValue()の結果)を
      スレッドコンテキストに格納する。
   3. 後続のリクエストハンドラに処理を委譲する。
 

定義:

handle インタフェース内 Handler<java.lang.Object,java.lang.Object>

パラメータ:

input - 入力データ

ctx - 実行コンテキスト

戻り値:

処理結果データ

setAttributes

public ThreadContextHandler setAttributes(java.util.List<ThreadContextAttribute> attributes)

このハンドラが管理する属性のリストを登録する。

パラメータ:

attributes - このハンドラが管理する属性のリスト

戻り値:

このオブジェクト自体

handleInbound

public Result handleInbound(ExecutionContext context)

インタフェースからコピーされた説明: InboundHandleable

前処理を実装する。

定義:

handleInbound インタフェース内 InboundHandleable

パラメータ:

context - ExecutionContext

戻り値:

処理結果オブジェクト

handleOutbound

public Result handleOutbound(ExecutionContext context)

インタフェースからコピーされた説明: OutboundHandleable

後処理を実装する。

定義:

handleOutbound インタフェース内 OutboundHandleable

パラメータ:

context - ExecutionContext

戻り値:

処理結果オブジェクト