intra-mart(R)
5.0

jp.co.intra_mart.framework.base.session
クラス DefaultSessionPropertyHandler

java.lang.Object
  拡張jp.co.intra_mart.framework.base.session.DefaultSessionPropertyHandler
すべての実装インタフェース:
PropertyHandler, SessionPropertyHandler

public class DefaultSessionPropertyHandler
extends Object
implements SessionPropertyHandler

セッションに関連するデフォルトのプロパティハンドラです。 プロパティの設定内容は以下のとおりです。

キー 内容
factory.name SessionFactoryのクラス名
object.param リクエストに渡すセッションIDのパラメータ名
error.page.path セッションエラー(セッションタイムアウト等)のときに表示するページのパス
object.key リクエストの属性にSessionObjectを保存する時のキー
reserved.user.key SessionObjectの属性に設定されているユーザIDのキー
reserved.group.key SessionObjectの属性に設定されているログイングループIDのキー

バージョン:
1.0

フィールドの概要
static String DEFAULT_BUNDLE_NAME
          デフォルトのリソースバンドル名
static String DEFAULT_BUNDLE_NAME_PARAM
          リソースバンドル名のパラメータ名
 
コンストラクタの概要
DefaultSessionPropertyHandler()
          DefaultSessionPropertyHandlerを新規に生成します。
 
メソッドの概要
 String getLoginGroupIDKey()
          セッションに登録されているログイングループIDのキーを取得します。
 String getLoginUserIDKey()
          セッションに登録されているログインユーザIDのキーを取得します。
 String getSessionErrorPagePath()
          セッションエラーページのパスを取得します。
 String getSessionFactoryName()
          推奨されていません。 セッションとしてはHttpSessionを直接利用するようにしてください。
 String getSessionObjectKey()
          推奨されていません。 HttpSessionを直接取得するようにしてください。
 String getSessionParameter()
          推奨されていません。 HttpSessionを直接使用する場合、このメソッドは不要になります。
 void init(PropertyParam[] params)
          プロパティハンドラを初期化します。
 
クラス java.lang.Object から継承したメソッド
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

DEFAULT_BUNDLE_NAME

public static final String DEFAULT_BUNDLE_NAME
デフォルトのリソースバンドル名

関連項目:
定数フィールド値

DEFAULT_BUNDLE_NAME_PARAM

public static final String DEFAULT_BUNDLE_NAME_PARAM
リソースバンドル名のパラメータ名

関連項目:
定数フィールド値
コンストラクタの詳細

DefaultSessionPropertyHandler

public DefaultSessionPropertyHandler()
DefaultSessionPropertyHandlerを新規に生成します。

メソッドの詳細

init

public void init(PropertyParam[] params)
          throws PropertyHandlerException
プロパティハンドラを初期化します。

定義:
インタフェース PropertyHandler 内の init
パラメータ:
params - 初期パラメータ
例外:
PropertyHandlerException - プロパティハンドラの初期化時に例外が発生

getSessionFactoryName

public String getSessionFactoryName()
                             throws SessionPropertyException
推奨されていません。 セッションとしてはHttpSessionを直接利用するようにしてください。

セッションファクトリのクラス名を取得します。 何も設定されていない場合nullが返ります。

定義:
インタフェース SessionPropertyHandler 内の getSessionFactoryName
戻り値:
セッションファクトリのクラス名(設定されていない場合null)
例外:
SessionPropertyException - セッションファクトリのクラス名の取得時に例外が発生

getSessionParameter

public String getSessionParameter()
                           throws SessionPropertyException
推奨されていません。 HttpSessionを直接使用する場合、このメソッドは不要になります。

セッションIDのパラメータ名を取得します。 何も設定されていない場合nullが返ります。

定義:
インタフェース SessionPropertyHandler 内の getSessionParameter
戻り値:
セッションIDのパラメータ名(設定されていない場合null)
例外:
SessionPropertyException - セッションIDのパラメータ名の取得時に例外が発生

getSessionObjectKey

public String getSessionObjectKey()
                           throws SessionPropertyException
推奨されていません。 HttpSessionを直接取得するようにしてください。

セッションオブジェクトのキーを取得します。 何も設定されていない場合nullが返ります。

定義:
インタフェース SessionPropertyHandler 内の getSessionObjectKey
戻り値:
セッションオブジェクトのキー(設定されていない場合null)
例外:
SessionPropertyException - セッションオブジェクトのキーの取得時に例外が発生

getLoginUserIDKey

public String getLoginUserIDKey()
                         throws SessionPropertyException
セッションに登録されているログインユーザIDのキーを取得します。

定義:
インタフェース SessionPropertyHandler 内の getLoginUserIDKey
戻り値:
ログインユーザIDのキー
例外:
SessionPropertyException - 属性名の取得時に例外が発生

getLoginGroupIDKey

public String getLoginGroupIDKey()
                          throws SessionPropertyException
セッションに登録されているログイングループIDのキーを取得します。

定義:
インタフェース SessionPropertyHandler 内の getLoginGroupIDKey
戻り値:
ログイングループIDのキー
例外:
SessionPropertyException - 属性名の取得時に例外が発生

getSessionErrorPagePath

public String getSessionErrorPagePath()
                               throws SessionPropertyException
セッションエラーページのパスを取得します。

定義:
インタフェース SessionPropertyHandler 内の getSessionErrorPagePath
戻り値:
セッションエラーページのパス
例外:
SessionPropertyException - セッションエラーページのパスの取得時に例外が発生

intra-mart(R)
5.0

Copyright © 2000-2005 NTT DATA INTRAMART CO.,LTD. All Rights Reserved.