グローバルセッション情報として登録する情報や，使用するSFOサーバの情報などは，<filter>タグ内の初期化パラメタである，<init-param>タグ内を編集して定義します。

参考

<init-param>タグ内の情報は，アプリケーションをJ2EEサーバにインポートしたあとで，サーバ管理コマンドを使用して設定することもできます。

DDの<init-param>タグ内に定義する内容を次の表に示します。なお，<param-value>に指定する値の詳細については，(2)以降で説明します。

表12-11　DDの<init-param>タグ内に定義する内容

注※1　キー名称の先頭と最後の空白は省略されます。省略された結果，""（文字列）になったキー名称は無視されます。

注※2　同じキー名称を指定した場合，Webアプリケーションを開始できません。

これらの定義項目は，使用する機能によって設定するかどうかが異なります。使用する機能ごとのDDの<init-param>タグ内に定義する要素のデフォルト値と設定要否を次の表に示します。

表12-12　使用する機能ごとのDDの<init-param>タグ内に定義する要素のデフォルト値と設定要否

（凡例）

任意：省略できることを示します。省略した場合はデフォルトの値が設定されます。

無効：指定しても無効になることを示します。設定した値は使用されません。

注※1　GSInfoKey-RWとGSInfoKey-Rの両方を省略することはできません。

注※2　パラメタに不正な値を指定した場合はエラーとなり，Webアプリケーションは開始できません。

注※3　SFOフィルタのサーバ定義名に指定されているSFOサーバ名が一つの場合は，そのSFOサーバ名がデフォルトになります。複数指定されている場合は，先頭に指定されているSFOサーバ名がデフォルトになります。SFOフィルタのサーバ定義名は，簡易構築定義ファイルの論理J2EEサーバ（j2ee-server）の<configuration>タグ内に，webserver.sfo.sfo_serversパラメタで指定します。

注※4　指定したSFOサーバ名が，簡易構築定義ファイルで指定されているSFOフィルタのサーバ定義名にない場合もエラーになりません。SFOフィルタのサーバ定義名は，簡易構築定義ファイルの論理J2EEサーバ（j2ee-server）の<configuration>タグ内に，webserver.sfo.sfo_serversパラメタで指定します。

なお，グローバルセッションの制御方法によって，指定する必要があるパラメタが異なります。

グローバルセッションの制御方法と指定が必要なパラメタの対応を次の表に示します。

表12-13　グローバルセッションの制御方法と指定が必要なパラメタの対応

（凡例）

◎：指定が必要です。省略できません。

○：指定が必要です。省略した場合は，デフォルト値が有効になります。

−：指定は不要です。

注※

デフォルト値は「cookie」です。このため，省略した場合もHTTP Cookieによってグローバルセッションが制御されます。

注意

• グローバルセッション情報として使用する情報は，一つ以上指定する必要があります。それ以外の値の定義は任意です。デフォルト値がある項目については，省略するとデフォルト値が使用されます。
• パラメタ値を省略する場合，<init-param>タグごと省略してください。次のようにタグを残して値だけを省略した場合，空文字列を指定したと判断されて，エラーになります。
  間違った省略方法の例
  　　　　：
  <init-param>
  <param-name>GSInfosLengthMax</param-name>
  <param-value></param-value>
  </init-param>
  　　　　：
  

セッションフェイルオーバ機能を使用するためのDDの定義内容は，冗長化したJ2EEサーバにデプロイした同一アプリケーションで同じ必要があります。定義内容が不正な場合，アプリケーション開始処理がエラーになります。メッセージは，KDJE34202-Eのメッセージが出力されます。

HTTPセッションに登録する情報の中から，グローバルセッション情報として登録する情報を選択して定義します。HTTPセッションに登録する情報すべてをグローバルセッション情報として引き継ぐ場合は，「*」を指定します。

グローバルセッション情報は，書き換え可能グローバルセッション情報または読み込み専用グローバルセッション情報として指定します。HTTPセッションに登録後，変更が必要なセッション情報は，書き換え可能グローバルセッション情報に指定します。HTTPセッションに登録後，変更が不要なセッション情報は，読み込み専用グローバルセッションに指定します。グローバルセッション情報については，「12.2.3　グローバルセッション情報」を参照してください。

書き換え可能グローバルセッション情報の場合は，パラメタのGSInfoKey-RWで指定します。読み込み専用グローバルセッション情報の場合は，GSInfoKey-Rで指定します。

GSInfoKey-RWおよびGSInfoKey-Rパラメタに指定した文字列は，「;」（半角セミコロン）で分割したあと，それぞれの値の先頭と最後の連続した空白文字^※を削除した結果がキー名称として使用されます。空白文字^※を削除した結果が「""」（空文字列）になったキー名称は無視されます。GSInfoKey-RWおよびGSInfoKey-Rパラメタに指定した文字列に有効となるキー名称がない場合は，KDJE34202-Eのメッセージが出力され，エラーとなります。

注※　空白文字とは，半角スペース，タブ，LF（ラインフィード（0x0a）），CR（キャリッジリターン（0x0d））またはFF（フォームフィード（0x0c））のことを指します。

GSInfoKey-RWおよびGSInfoKey-Rパラメタに指定する値と引き継ぎ対象となるセッション情報の関係を次の表に示します。

表12-14　GSInfoKey-RWおよびGSInfoKey-Rパラメタに指定する値と引き継ぎ対象となるセッション情報の関係

（凡例）△：空白文字を示します。

注※　GSInfoKey-RWパラメタで「*」を指定している場合に，GSInfoKey-Rパラメタでキーを指定しているときは，GSInfoKey-Rパラメタに指定したキーで登録されたセッション情報は含まれません。また，GSInfoKey-Rパラメタで「*」を指定している場合に，GSInfoKey-RWパラメタでキーを指定しているときは，GSInfoKey-RWパラメタに指定したキーで登録されたセッション情報は含まれません。

SFOサーバに格納するグローバルセッション情報の一つ当たりの最大サイズを指定します。SFOサーバで冗長化できるグローバルセッション情報のサイズは，デフォルトでは1,024バイトまでです。冗長化するグローバルセッション情報の文字数がこの値を超える場合は，定義した内容を変更する必要があります。

また，グローバルセッション情報の最大サイズを小さくすると，SFOサーバで使用するメモリサイズを少なくできます。実際に格納するグローバルセッション情報の最大サイズを考慮して，適切なサイズを指定してください。

注意

グローバルセッション情報のサイズ見積もり機能を有効にしている場合，GSInfosLengthMaxパラメタの指定は無視されます。このため，グローバルセッション情報のサイズ見積もり機能を無効にして運用を開始する前に，KDJE34260-Iのメッセージで出力されたグローバルセッション情報のサイズが，GSInfosLengthMaxパラメタで指定したサイズを超えていないことを確認してください。

グローバルセッション情報のサイズは，次の式で算出できます。直列化可能クラスのオブジェクトであるセッション情報の引き継ぎを許可しているかどうか（GSInfoTypeSerializableEnableパラメタの指定）によって，見積もり式が異なります。

(a)　直列化可能クラスのオブジェクトであるセッション情報の引き継ぎを許可していない場合

注※1

区切り文字数は，2×（設定したグローバルセッション情報の数）−1で算出できます。これは，区切り文字には，グローバルセッション情報間の区切り文字と，各グローバルセッション情報のキーと値の区切り文字が含まれるためです。

注※2

HTTPセッションの有効期間情報の長さは4バイトです。

ただし，グローバルセッション情報がjava.lang.Stringクラスの場合，文字列をUTF-8の文字エンコーディングでURLエンコードして冗長化します（URLエンコードにはjava.net.URLEncoderクラスを使用します）。そのため，グローバルセッション情報の文字列長は，セッション情報の文字列長と異なることがあります。文字種ごとのURLエンコード後の文字列長を次の表に示します。

表12-15　文字種ごとのURLエンコード後の文字列長

このため，グローバルセッション情報のサイズは，セッション情報の文字列を文字種ごとにURLエンコード後の文字列長に変換してから，それらを合計して見積もる必要があります。

例えば，n種類のグローバルセッション情報を指定した場合は，グローバルセッション情報の最大サイズは次の式で算出できます。

参考

グローバルセッション情報のサイズ見積もり機能を使用すると，HTTPセッションに含まれるセッション情報ごとのバイト数が出力できます。出力されたサイズ情報を参考にして，グローバルセッション情報の最大サイズに適切な値を設定してください。グローバルセッション情報のサイズ見積もり機能については，「12.2.10　グローバルセッション情報のサイズの見積もり」を参照してください。

(b)　直列化可能クラスのオブジェクトであるセッション情報の引き継ぎを許可している場合

注

シリアライズは，一つのHTTPセッションに対して，一つのjava.io.ObjectOutputStreamのオブジェクトを使用して実施します。

注※

HTTPセッションの有効期間情報の長さは4バイトです。

例えば，n種類のグローバルセッション情報を設定した場合は，グローバルセッション情報の最大サイズは次の式で算出できます。

注

シリアライズは，一つのHTTPセッションに対して，一つのjava.io.ObjectOutputStreamのオブジェクトを使用して実施します。

参考

グローバルセッション情報のサイズ見積もり機能を使用すると，各情報のシリアライズ後のバイト数が出力できます。出力されたサイズ情報を参考にして，グローバルセッション情報の最大サイズに適切な値を設定してください。グローバルセッション情報のサイズ見積もり機能については，「12.2.10　グローバルセッション情報のサイズの見積もり」を参照してください。

グローバルセッション情報を格納するSFOサーバのサーバ名を指定します。サーバ名は，J2EEサーバのusrconf.propertiesのwebserver.sfo.sfo_serversキーに指定したSFOサーバ名から選択します。

usrconf.propertiesについては，マニュアル「Cosminexus　リファレンス　定義編」を参照してください。

グローバルセッションの制御方法を指定します。指定した値に応じて，Webクライアントに対するグローバルセッションIDの送信方法，およびWebクライアントからのグローバルセッションIDの受信方法が決まります。

指定できる値と意味を次の表に示します。

表12-16　GSessionControlの指定値の意味

また，GSessionControlに指定した値によって，次の制御が変わります。

• WebクライアントからJ2EEサーバに送信されるグローバルセッションIDの扱われ方
• J2EEサーバからWebクライアントへのレスポンスの設定内容

GSessionControlに指定する値とグローバルセッションの制御方法の関係を，次の表に示します。

表12-17　GSessionControlに指定する値とグローバルセッションの制御方法の関係

注※1

クライアントから送信されたリクエストが，HTTP CookieおよびURLのパスパラメタの両方にグローバルセッションIDを含んでいる場合は，HTTP Cookieで送信されたグローバルセッションIDが有効になります。

注※2

WebクライアントがHTTP Cookieをサポートしている場合は，URL書き換えは実行しません。

HTTP CookieまたはURL書き換えを使用したグローバルセッションの制御については，「12.3　HTTP Cookieによるグローバルセッションの制御」および「12.4　URL書き換えによるグローバルセッションの制御」を参照してください。

グローバルセッションIDをWebブラウザなどのクライアントに通知するときに使用するHTTP Cookieの名称を指定します。なお，グローバルセッションIDとは，グローバルセッション情報の識別に使用される情報です。

グローバルセッションIDをWebブラウザなどのクライアントに通知するときに使用するURLのパスパラメタ名を指定します。

GSessionControlパラメタに「cookie」を指定した場合，このパラメタに設定した値は無効になります。なお，GSessionControlパラメタに「cookie」を指定した場合，GIDURLParamNameパラメタに設定した値はチェックされません。このため，このパラメタに不正な値を設定した場合も，検出はされません。

注意

Webアプリケーション内で使用するURLのパスパラメタと同じ名称を，このパラメタで指定しないでください。指定した場合，セッションフェイルオーバ機能が正しく動作しません。

URL書き換えを使用したグローバルセッションの制御については，「12.4　URL書き換えによるグローバルセッションの制御」を参照してください。

すでにロックされた状態のセッションに対して，別のJ2EEサーバからロック要求があった場合に，ロック待ちがタイムアウトになるまでの時間を指定します。

J2EEサーバからSFOサーバに対してグローバルセッション情報のロック取得要求をしたあとに，J2EEサーバに障害が発生して停止した場合，SFOサーバ上のグローバルセッション情報がロックされたままの状態になってしまうおそれがあります。グローバルセッション情報のロック待ちタイムアウト時間は，このような場合に，J2EEサーバに障害が発生したと判断するために使用されます。

また，次のような場合にロックされたままの状態になったときにも，このタイムアウト時間が有効になります。これらの状態は，負荷分散機を使用している環境で発生することがあります。

• ページにフレームを使用している場合など，同じセッションを使用するリクエストが同時に送信され，それぞれのリクエストが負荷分散機のスケジュール機能によって異なるJ2EEサーバに分散されて転送されたとき
• ユーザの操作によってリクエストが二重に送信された場合など，リクエストを送信して応答が返されるよりも前に次のリクエストを送信したときに，それぞれのリクエストが負荷分散機のスケジュール機能によって異なるJ2EEサーバに分散されて転送されたとき

フレームを使用するアプリケーションの場合は，リクエスト処理が終わるまでのロック待ち時間も考慮して，タイムアウト時間を定義してください。

引き継ぎ可能なセッション情報のデータ型には，java.lang.Stringクラスのオブジェクト，byte型配列，および直列化可能クラスのオブジェクトがあります。

データ型がbyte型配列，または直列化可能クラスのオブジェクトであるセッション情報を引き継ぎ対象とする場合には，次の設定を有効にします。

• byte型配列であるセッション情報の引き継ぎ許可
• 直列化可能クラスのオブジェクトであるセッション情報の引き継ぎ許可

これらの設定を無効にした場合は，java.lang.Stringクラスのオブジェクトだけが引き継ぎ可能なセッション情報となります。

(a)　byte型配列であるセッション情報の引き継ぎ許可

byte型配列のセッション情報を引き継ぎ対象とするかどうかをGSInfoTypeByteArrayEnableパラメタに指定します。「true」を指定した場合は，java.lang.Stringクラスのオブジェクトに加え，byte型配列のセッション情報も引き継ぎ対象となります。

「false」を指定した場合は，byte型配列のセッション情報は引き継ぎ対象外となります。引き継ぎ対象外のオブジェクトが登録された場合の扱いについては，「12.2.3(3)　引き継ぎ対象外のオブジェクトの扱い」を参照してください。

(b)　直列化可能クラスのオブジェクトであるセッション情報の引き継ぎ許可

直列化可能クラスのオブジェクトであるセッション情報を引き継ぎ対象とするかどうかをGSInfoTypeSerializableEnableパラメタに指定します。「true」を指定した場合は，直列化可能クラスのオブジェクトであるセッション情報が引き継ぎ対象となります。この場合，java.lang.Stringクラスのオブジェクト，およびbyte型配列のセッション情報も区別なく，直列化可能クラスのオブジェクトであるセッション情報としてシリアライズして，グローバルセッション情報を作成します。

「false」を指定した場合は，直列化可能クラスのオブジェクトであるセッション情報は引き継ぎ対象外となります。引き継ぎ対象外のオブジェクトが登録された場合の扱いについては，「12.2.3(3)　引き継ぎ対象外のオブジェクトの扱い」を参照してください。

(c)　引き継ぎ可能なセッション情報のデータ型を指定する場合の注意事項

GSInfoTypeByteArrayEnableパラメタとGSInfoTypeSerializableEnableパラメタの指定値によって，引き継ぎ対象となるデータ型が異なります。各パラメタに指定する値と引き継ぎ対象となるデータ型の関係を次の表に示します。

表12-18　GSInfoTypeByteArrayEnableおよびGSInfoTypeSerializableEnableパラメタに指定する値と引き継ぎ対象となるデータ型の関係

注※1　byte型配列のセッション情報を引き継ぎ対象とするかどうかを指定するパラメタです。

注※2　直列化可能クラスのオブジェクトであるセッション情報を引き継ぎ対象とするかどうかを指定するパラメタです。

なお，引き継ぎ対象外のオブジェクトが登録された場合の扱いについては，「12.2.3(3)　引き継ぎ対象外のオブジェクトの扱い」を参照してください。

セッションフェイルオーバ機能を使用する場合のDDの定義例を示します。この例は，HTTP Cookieによってグローバルセッションを制御し，byte型配列のセッション情報を引き継ぐ場合の例です。

     ：
<!--The filter for Session Fail Over -->
<filter>
   <filter-name>com.hitachi.software.was.sfo.web.SFOFilter</filter-name>
   <filter-class>com.hitachi.software.was.sfo.web.SFOFilter</filter-class>
   <init-param>
     <param-name>GSInfoKey-RW</param-name>
     <param-value>page</param-value>
   </init-param>
 
   <init-param>
     <param-name>GSInfoKey-R</param-name>
     <param-value>userId;roll</param-value>
   </init-param>
 
   <init-param>
     <param-name>GSInfosLengthMax</param-name>
     <param-value>44</param-value>
   </init-param>
 
   <init-param>
     <param-name>SFOServerName</param-name>
     <param-value>sfo_server1</param-value>
   </init-param>
 
   <init-param>
     <param-name>GSessionControl</param-name>
     <param-value>cookie</param-value>
   </init-param>
 
   <init-param>
     <param-name>GIDCookieName</param-name>
     <param-value>SFOSESSIONID</param-value>
   </init-param>
 
   <init-param>
     <param-name>LockTimeout</param-name>
     <param-value>180</param-value>
   </init-param>
 
   <init-param>
     <param-name>GSInfoTypeByteArrayEnable</param-name>
     <param-value>true</param-value>
   </init-param>
</filter>
 
<!-- Specify the filter tags here. -->
<filter>
   <filter-name>UserFilter</filter-name>
   <filter-class>filter.UserFilter</filter-class>
</filter>
 
<!-- The filter mappings for the Session Fail Over-->
<filter-mapping>
   <filter-name>com.hitachi.software.was.sfo.web.SFOFilter</filter-name>
   <url-pattern>/*</url-pattern>
</filter-mapping>
 
<!-- Specify the filter-mapping tags here. -->
<filter-mapping>
   <filter-name>UserFilter</filter-name>
   <url-pattern>/servlet/*</url-pattern>
</filter-mapping>
     ：
</web-app>

この例で定義される内容は，次のとおりです。

• 書き換え可能グローバルセッション情報として，「page」の値を格納します。
• 読み込み専用グローバルセッション情報として，「userId」および「roll」の2種類の値を格納します。
• グローバルセッション情報の最大サイズとして，49を設定します。
  最大サイズは，次の式で算出します。ここでは，page（4文字）の値は1〜2文字のASCII文字列，userId（6文字）の値は1〜12バイトのbyte型配列，roll（4文字）の値は1〜7文字のASCII文字列とします。
  （4＋6＋4）+（2＋7＋（12＋5））＋（2×3-1）＋4＝49
  
• 使用するSFOサーバの名称は，sfo_server1とします。
• グローバルセッションIDのキー名称は，SFOSESSIONIDとします。
• SFOサーバでのロック待ちタイムアウト時間は，180秒とします。
• byte型配列のセッション情報を引き継ぎます。

セッションフェイルオーバ機能を使用する場合のDDの定義例を示します。この例は，URL書き換えによってグローバルセッションを制御する場合の例です。

なお，ここでは，URL書き換えによる制御の場合にHTTP Cookieによる制御と異なる設定だけについて示します。これ以外の項目については，「(10)　DDの定義例（HTTP Cookieによる制御の場合）」を参照してください。

     ：
<!--The filter for Session Fail Over -->
<filter>
   <filter-name>com.hitachi.software.was.sfo.web.SFOFilter</filter-name>
   <filter-class>com.hitachi.software.was.sfo.web.SFOFilter</filter-class>
     ：
   <init-param>
     <param-name>GSessionControl</param-name>
     <param-value>url-rewriting</param-value>
   </init-param>
 
   <init-param>
     <param-name>GIDURLParamName</param-name>
     <param-value>sfogid</param-value>
   </init-param>
     ：
</filter>
 

この例では，グローバルセッションIDの送信に使用するURLのパスパラメタ名は，「sfogid」としています。

セッションフェイルオーバ機能を使用する場合のDDの定義例を示します。この例は，制御方法としてGSessionControlに「both」を指定する場合の例です。bothは，WebクライアントがHTTP Cookieをサポートしているかどうかを判別して，必要に応じてHTTP Cookieによる制御とURL書き換えによる制御を切り替える方法です。

なお，ここでは，bothを指定する場合にHTTP Cookieによる制御と異なる設定だけについて示します。これ以外の項目については，「(10)　DDの定義例（HTTP Cookieによる制御の場合）」を参照してください。

     ：
<filter>
   <filter-name>com.hitachi.software.was.sfo.web.SFOFilter</filter-name>
   <filter-class>com.hitachi.software.was.sfo.web.SFOFilter</filter-class>
     ：
   <init-param>
     <param-name>GSessionControl</param-name>
     <param-value>both</param-value>
   </init-param>
 
   <init-param>
     <param-name>GIDCookieName</param-name>
     <param-value>SFOSESSIONID</param-value>
   </init-param>
 
   <init-param>
     <param-name>GIDURLParamName</param-name>
     <param-value>sfogid</param-value>
   </init-param>
     ：
</filter>

この例では，グローバルセッションIDの送信に使用するHTTP Cookieの名称は「SFOSESSIONID」としています。また，グローバルセッションIDの送信に使用するURLのパスパラメタ名は，「sfogid」としています。