nablarch.common.handler.threadcontext

Class UserIdAttribute

java.lang.Object

nablarch.common.handler.threadcontext.UserIdAttribute

All Implemented Interfaces:

ThreadContextAttribute<java.lang.Object>

Direct Known Subclasses:

UserIdAttributeInSessionStore

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

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

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

Constructor Summary

Constructors

Constructor and Description
UserIdAttribute()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getKey() スレッドコンテキストに格納する際に使用するプロパティのキー名を返す。
protected java.lang.Object	getUserIdSession(ExecutionContext ctx, java.lang.String skey) セッションからユーザIDを取得する。 デフォルトではHTTPセッションからユーザIDを取得する。 必要に応じてオーバーライドすること。
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セッション上のキー名を設定する。

Methods inherited from class java.lang.Object

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

Constructor Detail

UserIdAttribute

public UserIdAttribute()

Method Detail

setSessionKey

public void setSessionKey(java.lang.String sessionKey)

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

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

Parameters:

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

setAnonymousId

public void setAnonymousId(java.lang.String anonymousId)

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

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

Parameters:

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

getKey

public java.lang.String getKey()

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

 ThreadContext.USER_ID_KEY を使用する。
 

Specified by:

getKey in interface ThreadContextAttribute<java.lang.Object>

Returns:

プロパティのキー名

getValue

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

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

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

Specified by:

getValue in interface ThreadContextAttribute<java.lang.Object>

Parameters:

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

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

Returns:

プロパティの値

getUserIdSession

protected java.lang.Object getUserIdSession(ExecutionContext ctx,
                                            java.lang.String skey)

セッションからユーザIDを取得する。 デフォルトではHTTPセッションからユーザIDを取得する。 必要に応じてオーバーライドすること。

Parameters:

ctx - 実行コンテキスト

skey - ユーザIDのキー

Returns:

ユーザID