MO名称:

manager-properties

定義:

ObjectName

amx:type=manager-properties,config={1},category=config

CLIName

server.session-config.session-manager.manager-properties

属性の概要

max-sessions (最大セッション数) アクティブセッションの最大数を指定します。制限なしの場合は-1を指定します。

reap-interval-in-seconds (セッション管理処理周期) Webアプリケーションがバックグラウンドスレッドを実行する周期を指定します。(単位：秒)

process-expires-frequency (タイムアウトチェック頻度) セッションのタイムアウトチェックをバックグラウンドスレッドの実行周期で何回おきに実行するかで指定します。(単位：回) 「セッション管理処理周期」プロパティも参照してください。

session-file-name (セッションファイル名) Webアプリケーション停止時にセッション情報を保存するファイル名を指定します。

session-id-length (セッションID長) 生成されるセッションIDの長さを指定します。(単位：byte)

algorithm (アルゴリズム) セッションIDを計算するアルゴリズムを指定します。 アルゴリズムにはJava.security.MessageDigestでサポートされているアルゴリズムを指定することができます。

entropy (エントロピー) セッションIDの生成時に用いられる、乱数生成メソッドに渡す文字列を指定します。

random-class (ランダムクラス) 乱数を生成するクラスを指定します。指定するクラスはjava.security.SecureRandomを実装している必要があります。

replication-mode (読み出し/書き込み頻度) セッション情報の書き込み・読み出しタイミングを指定します。 "Servlet API呼び出し時"(即時同期モード)：Servlet処理中のセッション属性の更新の呼び出しによる情報更新時にセッション情報を格納先に反映する。 "リクエスト開始・終了時"(同期モード)：Servlet処理中にはセッション情報の格納は行わず、リクエスト終了時にまとめて格納先に反映する。 "時間間隔"(非同期モード)：リクエスト処理の延長ではセッション情報の格納は行わず、リクエストとは非同期に、バックグラウンドスレッド（非同期バックアップスレッドが実行。既定値では、１分周期）によって格納先に反映する。

max-idle-backup (書き込みアイドル間隔) セッションが最後に使われてからバックアップされるまでの時間を指定します。(単位：秒) スワップアウトと異なりメモリ上からは削除されません。 非同期モードで有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

min-idle-swap (スワップ最小アイドル時間) セッションが最後に使われてから、セッション情報を格納先に保存しメモリ上から削除するまでの時間を指定します。(単位：秒) 非同期モードで有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

max-idle-swap (スワップ時間) セッションが最後に使われてから、セッション情報を格納先に保存しメモリ上から削除するまでの時間を指定します。(単位：秒) 非同期モードで有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

skip-static-file-session-upd (静的ファイルアクセス時刻更新) 動的ファイル（JSP/Servlet）以外の静的ファイルにリクエストがあった際にセッション情報を更新するかどうかを表します。true を指定した場合、静的ファイルへのアクセスの際にはセッション情報を更新しません。

save-skip (セッション情報無更新時の書き込みスキップ) セッション情報が更新されなかった場合にセッション情報の保存を行わない場合に true を設定します。 既定値は true です。

change-session-id (スティッキーセッション情報更新) リクエストのセッションIDに、自プロセスで発行した識別子（JavaプロパティjvmRoute設定値とプロセスID）と異なる識別子が付加されている場合、自身のプロセスで生成したセッションに置き換えるかどうかを指定します。 非同期モードでの既定値：true 同期モード・即時同期モードでの既定値：false ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

session-double-reading (メモリ上のセッション情報が有効な場合のセッション情報読み込み) メモリ上にJNDIサーバやデータベースから読み込んだセッション情報が未書き込みの場合、セッション情報を読み込むかどうかを指定します。 同期モードで有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

storage-type (保存先タイプ) セッション情報の格納先、JNDIかデータベースかデータグリッドを指定します。 非同期モードの場合のみ、FILEも指定できます。同期モード・即時同期モードでは、FILEを選択しないでください。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

datasource-name (データソース名) データベースと接続するデータソース名を指定します。 保存先タイプに「DB」を指定した場合のみ有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

sqlfile-path (SQL拡張ファイルパス) SQL拡張ファイルへのパスを指定します。 パスの基点はドメインのconfigディレクトリです。 保存先タイプに「DB」を指定した場合のみ有効。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

backup-interval (バックアップ処理間隔) セッション情報のバックアップ処理を実行する間隔を指定します。(単位：秒) 非同期モードで有効。

storage-timeout-check-once (起動後１回のみタイムアウトチェック実行) 格納先にあるセッション情報のタイムアウトチェックを起動時に一度のみ行うかどうかを設定します。 非同期モードで有効。

storage-timeout-access-wait (格納先アクセス待ち時間) タイムアウトチェック処理において格納先にアクセスする処理を待ち合わせする時間を指定します。待ち合わせしない場合は-1を指定します。(単位：ミリ秒)

all-save (セッション情報全保存フラグ) セッションを格納先に保存する際、全セッション情報を保存するか、更新のあった項目のみを更新するかを指定します。 既定値はレプリケーションモードにより異なり、非同期モードでは無視されます。 同期モードでの既定値：true 即時同期モードでの既定値：false ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

lock-mode (ロックモード) 同一セッションに対する同時アクセスを制限するかどうかを指定します。 ※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

data-grid-name (データグリッド名) データグリッド名を指定します。 保存先タイプに「DATAGRID」を指定した場合のみ有効。

操作の概要

getProperties (プロパティ一覧の取得) プロパティの一覧を取得します。

setProperty (プロパティの設定) プロパティの名前と値を設定します。

max-sessions (最大セッション数)

アクティブセッションの最大数を指定します。制限なしの場合は-1を指定します。

詳細:

アクティブセッション(*1)の最大数を指定します。制限なしの場合は-1を指定します

(*1) レプリケーションモードが即時同期/同期モードの場合、アクティブセッション数=最大セッション数です。非同期モードの場合、アクティブセッション数=スワップアウトされていないセッションの最大数です。
スワップアウトされたセッションとは格納先には保存されているがメモリ上からは削除され非活性状態になっているセッションを指します。

型:

java.lang.String

長さの範囲:

-1,1-2147483647

reap-interval-in-seconds (セッション管理処理周期)

Webアプリケーションがバックグラウンドスレッドを実行する周期を指定します。(単位：秒)

詳細:

Webアプリケーションがバックグラウンドスレッドを実行する周期を指定します。
バックグラウンドスレッドでは「セッションのタイムアウトチェック」及び「サーブレットのクラスファイルの更新チェック」が実行されます。
セッションのタイムアウトチェック処理は、タイムアウトチェック頻度との組み合わせで実行周期を決定します。
「タイムアウトチェック頻度」プロパティも参照してください。

型:

java.lang.String

長さの範囲:

1-2147483647

process-expires-frequency (タイムアウトチェック頻度)

セッションのタイムアウトチェックをバックグラウンドスレッドの実行周期で何回おきに実行するかで指定します。(単位：回)
「セッション管理処理周期」プロパティも参照してください。

詳細:

セッションのタイムアウトチェックが実施される周期は次のように計算されます。
セッションタイムアウトチェック周期＝「セッション管理処理周期」×「タイムアウトチェック頻度」

型:

java.lang.String

長さの範囲:

1-2147483647

session-file-name (セッションファイル名)

Webアプリケーション停止時にセッション情報を保存するファイル名を指定します。

型:

java.lang.String

session-id-length (セッションID長)

生成されるセッションIDの長さを指定します。(単位：byte)

詳細:

生成されるセッションIDの長さを指定します。
実際に生成されるセッションIDは、指定したバイト数×2の長さになります。

16を指定した場合に生成されるセッションIDの例
D076CCDA5EFF2167B860A9C75FD558BB

型:

java.lang.String

長さの範囲:

8-512

algorithm (アルゴリズム)

セッションIDを計算するアルゴリズムを指定します。
アルゴリズムにはJava.security.MessageDigestでサポートされているアルゴリズムを指定することができます。

詳細:

型:

java.lang.String

entropy (エントロピー)

セッションIDの生成時に用いられる、乱数生成メソッドに渡す文字列を指定します。

詳細:

型:

java.lang.String

random-class (ランダムクラス)

乱数を生成するクラスを指定します。指定するクラスはjava.security.SecureRandomを実装している必要があります。

詳細:

型:

java.lang.String

replication-mode (読み出し/書き込み頻度)

セッション情報の書き込み・読み出しタイミングを指定します。
"Servlet API呼び出し時"(即時同期モード)：Servlet処理中のセッション属性の更新の呼び出しによる情報更新時にセッション情報を格納先に反映する。
"リクエスト開始・終了時"(同期モード)：Servlet処理中にはセッション情報の格納は行わず、リクエスト終了時にまとめて格納先に反映する。
"時間間隔"(非同期モード)：リクエスト処理の延長ではセッション情報の格納は行わず、リクエストとは非同期に、バックグラウンドスレッド（非同期バックアップスレッドが実行。既定値では、１分周期）によって格納先に反映する。

詳細:

セッションレプリケーションを利用する場合、処理速度を重視するのか、信頼性を重視するのかによってパラメータの設定が変わってきます。次に代表的な設定例を説明します。

処理速度(高)、信頼性(低) の設定：
・読み出し/書き込み頻度 ：時間間隔(非同期モード:AS)
・セッション情報無更新時の書き込みスキップ ：true
・セッション管理処理周期 ：60(秒)
・タイムアウトチェック頻度 ：1(回)
・スワップ最小アイドル時間 ：-1(スワップしない)
・スワップアイドル時間 ：-1(スワップしない)
・書き込みアイドル間隔 ：0(秒)
・バックアップ処理間隔 ：60(秒)

処理速度(中)、信頼性(中) の設定：
・読み出し/書き込み頻度 ：リクエスト開始・終了時(同期モード:SS)
・セッション情報無更新時の書き込みスキップ ：true
・セッション管理処理周期 ：60(秒)
・タイムアウトチェック頻度 ：1(回)
・セッション情報全保存フラグ :true（全ての項目を保存）

処理速度(低)、信頼性(高) の設定：
・読み出し/書き込み頻度 ：ServletAPI呼び出し時(即時同期モード:RS)
・セッション情報無更新時の書き込みスキップ ：false固定
・セッション管理処理周期 ：60(秒)
・タイムアウトチェック頻度 ：1(回)
・セッション情報全保存フラグ :false(更新のあった項目のみ保存)

※レプリケーションのモード毎に注意事項があります。マニュアルの「注意制限事項」も必ず参照してください。

型:

java.lang.String

値の有効範囲:

RS	-	Servlet API呼び出し時
SS	-	リクエスト開始・終了時
AS	-	時間間隔

max-idle-backup (書き込みアイドル間隔)

セッションが最後に使われてからバックアップされるまでの時間を指定します。(単位：秒)
スワップアウトと異なりメモリ上からは削除されません。
非同期モードで有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

書き込みアイドル間隔。非同期モードのみ有効、セッション情報を格納先に保存(バックアップ)するまでの時間です。既定値は 0 (OFF) です。
セッションへの最終１つ前のアクセスからmaxIdleBackup時間が経過している場合、セッション情報を格納先に保存します。

型:

java.lang.String

長さの範囲:

-1,0-2147483647

min-idle-swap (スワップ最小アイドル時間)

セッションが最後に使われてから、セッション情報を格納先に保存しメモリ上から削除するまでの時間を指定します。(単位：秒)
非同期モードで有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

スワップ最小アイドル時間。非同期モードで有効、セッション情報を非活性化(*1)するまでの時間です。既定値は -1 (OFF) です。
最大セッション数が指定されている場合に参照されます。非活性化されていないセッションの数が最大セッション数を超えている場合、アイドル時間(*2)がminIdleSwap時間を越えているセッションを非活性化(*1)します。
最大セッション数が指定され、minIdleSwapにOFF(-1)が設定された場合、最大セッション数を超えた分のセッションは検索順に非活性化(*1)されます。
ただしminIdleSwap時間は最大セッション数が指定された場合に有効になります。非活性化(*1)されていないセッションが最大セッション数を越えている、かつ、セッションへの最終１つ前のアクセスからminIdleSwap時間が経過している場合、セッション情報を非活性化(*1)します。mainIdleSwapは最大セッション数が定義されない場合もmaxIdleSwapのスイッチとして機能します。minIdleSwapはmaxIdleSwapと同じか短い値を指定してください。
(*1) セッション情報を格納先に保存し、メモリ上から削除する処理

型:

java.lang.String

長さの範囲:

-1,1-2147483647

max-idle-swap (スワップ時間)

セッションが最後に使われてから、セッション情報を格納先に保存しメモリ上から削除するまでの時間を指定します。(単位：秒)
非同期モードで有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

スワップ時間。非同期モードで有効、セッション情報を非活性化(*1)するまでの時間です。既定値は -1 (OFF)です。
セッションへの最終１つ前のアクセスからスワップ時間が経過している場合、セッション情報を非活性化(*1)します。スワップはスワップ最小アイドル時間に OFF(-1) が設定されている場合は使用されません。またスワップ時間にはスワップ最小アイドル時間と同じか長い時間を設定してください。
(*1) セッション情報を格納先に保存し、メモリ上から削除する処理

型:

java.lang.String

長さの範囲:

-1,1-2147483647

skip-static-file-session-upd (静的ファイルアクセス時刻更新)

動的ファイル（JSP/Servlet）以外の静的ファイルにリクエストがあった際にセッション情報を更新するかどうかを表します。true を指定した場合、静的ファイルへのアクセスの際にはセッション情報を更新しません。

詳細:

型:

java.lang.String

値の有効範囲:

true

false

save-skip (セッション情報無更新時の書き込みスキップ)

セッション情報が更新されなかった場合にセッション情報の保存を行わない場合に true を設定します。
既定値は true です。

詳細:

サーブレットによってセッション情報が更新された時にセッション情報を書き込む動作をスキップするかどうかを指定します。true を設定した場合はセッション情報が更新されなかった場合はセッション情報を書き込みません。もし、この値を false に設定すると全てのリクエストでセッション情報の書き込みが行われます。

型:

java.lang.String

値の有効範囲:

true

false

change-session-id (スティッキーセッション情報更新)

リクエストのセッションIDに、自プロセスで発行した識別子（JavaプロパティjvmRoute設定値とプロセスID）と異なる識別子が付加されている場合、自身のプロセスで生成したセッションに置き換えるかどうかを指定します。
非同期モードでの既定値：true
同期モード・即時同期モードでの既定値：false
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

値の有効範囲:

true

false

session-double-reading (メモリ上のセッション情報が有効な場合のセッション情報読み込み)

メモリ上にJNDIサーバやデータベースから読み込んだセッション情報が未書き込みの場合、セッション情報を読み込むかどうかを指定します。
同期モードで有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

メモリ上にJNDIサーバやDBから読み込んだセッション情報が未書き込みの場合、セッション情報を読み込むかどうかを指定します。
同時に１つのセッション情報にアクセスする特殊なケースの場合にfalseにしてください。
falseに設定することが必要な場合は、合わせてセッション固定での負荷分散をする必要があります。
デフォルトは、”セッション情報を読み込む”(true)です。
本設定は、同期モードの場合のみ有効です。

型:

java.lang.String

値の有効範囲:

true

false

storage-type (保存先タイプ)

セッション情報の格納先、JNDIかデータベースかデータグリッドを指定します。
非同期モードの場合のみ、FILEも指定できます。同期モード・即時同期モードでは、FILEを選択しないでください。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

値の有効範囲:

JNDI

DB

FILE

DATAGRID

datasource-name (データソース名)

データベースと接続するデータソース名を指定します。
保存先タイプに「DB」を指定した場合のみ有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

sqlfile-path (SQL拡張ファイルパス)

SQL拡張ファイルへのパスを指定します。
パスの基点はドメインのconfigディレクトリです。
保存先タイプに「DB」を指定した場合のみ有効。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

backup-interval (バックアップ処理間隔)

セッション情報のバックアップ処理を実行する間隔を指定します。(単位：秒)
非同期モードで有効。

詳細:

バックアップ処理を実行する間隔。非同期モードのみ有効。セッション情報を格納先に保存する処理を呼び出すまでの時間です。
実際にセッション情報を保存(バックアップ)するかどうかはmaxIdleBackupの設定で判定されます。

型:

java.lang.String

長さの範囲:

0-2147483647

storage-timeout-check-once (起動後１回のみタイムアウトチェック実行)

格納先にあるセッション情報のタイムアウトチェックを起動時に一度のみ行うかどうかを設定します。
非同期モードで有効。

詳細:

既定値(false)では、格納先にあるセッション情報のタイムアウトチェックはバックグラウンドスレッドで定期的に実行されます。一度のみ実行(true)を指定した場合は、Webアプリケーションが起動した後、一度だけ格納先セッションのタイムアウトチェックが実行されます。セッションをスワップアウトする、かつ本設定を一度のみ実行(true)とした場合、スワップアウトされたセッションはタイムアウトチェックされなくなる事に注意してください。

型:

java.lang.String

値の有効範囲:

true

false

storage-timeout-access-wait (格納先アクセス待ち時間)

タイムアウトチェック処理において格納先にアクセスする処理を待ち合わせする時間を指定します。待ち合わせしない場合は-1を指定します。(単位：ミリ秒)

詳細:

格納先への連続アクセスによる高負荷状態を回避するために、アクセスする前に処理を待つ時間を指定します。

型:

java.lang.String

長さの範囲:

-1,1-9223372036854775807

all-save (セッション情報全保存フラグ)

セッションを格納先に保存する際、全セッション情報を保存するか、更新のあった項目のみを更新するかを指定します。
既定値はレプリケーションモードにより異なり、非同期モードでは無視されます。
同期モードでの既定値：true
即時同期モードでの既定値：false
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

値の有効範囲:

true	-	true（全ての項目を保存）
false	-	false（更新のあった項目のみ保存）

lock-mode (ロックモード)

同一セッションに対する同時アクセスを制限するかどうかを指定します。
※チューニングに関する指針を「読み出し/書き込み頻度」の「？」に説明していますので参照してください。

詳細:

型:

java.lang.String

値の有効範囲:

true

false

data-grid-name (データグリッド名)

データグリッド名を指定します。
保存先タイプに「DATAGRID」を指定した場合のみ有効。

詳細:

Infinispanを利用したセッション情報のレプリケーションを行う場合に、ここで指定したデータグリッドが使用されます。

型:

java.lang.String

getProperties (プロパティ一覧の取得)

プロパティの一覧を取得します。

詳細:

プロパティの一覧を取得します。

戻り値:

javax.management.AttributeList

引数:

なし

setProperty (プロパティの設定)

プロパティの名前と値を設定します。

詳細:

プロパティの名前と値を設定します。

戻り値:

void

引数:

nameAndValue - javax.management.Attribute

プロパティの名前と値を設定します。