nablarch.common.handler.threadcontext

クラス UserIdAttribute

java.lang.Object

nablarch.common.handler.threadcontext.UserIdAttribute

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

ThreadContextAttribute<java.lang.Object>

public class UserIdAttribute
extends java.lang.Object
implements ThreadContextAttribute<java.lang.Object>

スレッドコンテキストに保持するユーザID属性。

 HTTPセッション上に格納されているログインユーザIDを
 スレッドコンテキストに格納する。
 

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

コンストラクタ

コンストラクタと説明
UserIdAttribute()

メソッドのサマリー

修飾子とタイプ	メソッドと説明
java.lang.String	getKey() スレッドコンテキストに格納する際に使用するプロパティのキー名を返す。
java.lang.Object	getValue(java.lang.Object req, ExecutionContext ctx) スレッドコンテキストに格納するプロパティの値を返す。
void	setAnonymousId(java.lang.String anonymousId) 未ログイン時にスレッドコンテキストに設定されるIDを設定する。
void	setSessionKey(java.lang.String sessionKey) ログインユーザIDが格納されているHTTPセッション上のキー名を設定する。

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

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

コンストラクタの詳細

UserIdAttribute

public UserIdAttribute()

メソッドの詳細

setSessionKey

public void setSessionKey(java.lang.String sessionKey)

ログインユーザIDが格納されているHTTPセッション上のキー名を設定する。

 デフォルトではgetKey()の値を使用する。
 

パラメータ:

sessionKey - HTTPセッション上のキー名

setAnonymousId

public void setAnonymousId(java.lang.String anonymousId)

未ログイン時にスレッドコンテキストに設定されるIDを設定する。

 明示的にこの値を設定しなかった場合、
 未ログイン時にスレッドコンテキスト上のユーザIDは設定されない。
 

パラメータ:

anonymousId - 未ログイン時にスレッドコンテキストに設定されるID

getKey

public java.lang.String getKey()

スレッドコンテキストに格納する際に使用するプロパティのキー名を返す。

 ThreadContext.USER_ID_KEY を使用する。
 

定義:

getKey インタフェース内 ThreadContextAttribute<java.lang.Object>

戻り値:

プロパティのキー名

getValue

public java.lang.Object getValue(java.lang.Object req,
                                 ExecutionContext ctx)

スレッドコンテキストに格納するプロパティの値を返す。

 スレッドコンテキストに格納するユーザIDの値は以下のように決定される。
 
   1. HTTPセッション上のキーsessionKey の値を取得する。
      その値がnullでなければスレッドコンテキストに設定する。
   2. HTTPセッション上の値がnullであり、かつ anonymousId が
      設定されていれば、その値をスレッドコンテキストに設定する。
   3. 上記以外の場合はnullを設定する。
 

定義:

getValue インタフェース内 ThreadContextAttribute<java.lang.Object>

パラメータ:

req - ハンドラの入力データ

ctx - 実行コンテキスト情報

戻り値:

プロパティの値