nablarch.common.handler.threadcontext

Class ThreadContextHandler

java.lang.Object

nablarch.common.handler.threadcontext.ThreadContextHandler

All Implemented Interfaces:

nablarch.fw.Handler<Object,Object>, nablarch.fw.InboundHandleable, nablarch.fw.OutboundHandleable

public class ThreadContextHandler
extends Object
implements nablarch.fw.Handler<Object,Object>, nablarch.fw.InboundHandleable, nablarch.fw.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>
 

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Object	handle(Object input, nablarch.fw.ExecutionContext ctx)
nablarch.fw.Result	handleInbound(nablarch.fw.ExecutionContext context)
nablarch.fw.Result	handleOutbound(nablarch.fw.ExecutionContext context)
ThreadContextHandler	setAttributes(List<ThreadContextAttribute> attributes) このハンドラが管理する属性のリストを登録する。

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadContextHandler

public ThreadContextHandler(ThreadContextAttribute... attributes)

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

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

Parameters:

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

ThreadContextHandler

public ThreadContextHandler()

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

Method Detail

handle

public Object handle(Object input,
                     nablarch.fw.ExecutionContext ctx)

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

Specified by:

handle in interface nablarch.fw.Handler<Object,Object>

setAttributes

public ThreadContextHandler setAttributes(List<ThreadContextAttribute> attributes)

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

Parameters:

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

Returns:

このオブジェクト自体

handleInbound

public nablarch.fw.Result handleInbound(nablarch.fw.ExecutionContext context)

Specified by:

handleInbound in interface nablarch.fw.InboundHandleable

handleOutbound

public nablarch.fw.Result handleOutbound(nablarch.fw.ExecutionContext context)

Specified by:

handleOutbound in interface nablarch.fw.OutboundHandleable