配備時に指定するWebアプリケーションの設定をWebモジュール内に定義する方法について説明します。
Webモジュール定義ファイル(interstage-web.xml)を配備ファイルのMETA-INFディレクトリに格納し配備を行うことで、Interstage管理コンソールの[システム] > [ワークユニット] > [IJServer] > [配備] > [詳細設定] > [Webアプリケーション設定]で行う配備時の設定項目を事前に設定しておくことができます。
また、“サーバ上の任意の位置で実行するWebアプリケーション”を配備する場合は、Webモジュール定義ファイルをWebアプリケーション保管先ディレクトリ配下のMETA-INFディレクトリに格納し配備を行うことで、配備時に指定するWebアプリケーションの設定項目を事前に設定しておくことができます。
なお、Webモジュール定義ファイルは、スタンドアロン環境で配備を行った場合のみに有効となり、マルチサーバ環境の一括操作で配備を行った場合は有効となりません。
注意
配備後にモジュールの配備先に格納されているWebモジュール定義ファイルの設定値を変更した場合、設定値は有効になりません。
設定値を変更する場合は、下記のいずれかの操作を行ってください。
Interstage管理コンソールを使用して、当該モジュールの環境設定画面で設定値を入力し、[適用]操作を行ってください。
配備ファイルに格納されているWebモジュール定義ファイルの設定値を変更し、再配備を行ってください。
なお、“サーバ上の任意の位置で実行するWebアプリケーションを配備する”を選択して配備している場合は、ディレクトリに格納されているWebモジュール定義ファイルの設定値を変更し、再配備を行ってください。
Webモジュール定義ファイル(interstage-web.xml)
Webモジュール定義ファイル(interstage-web.xml)について説明します。
Webモジュール定義ファイルの記述形式
Webモジュール定義ファイルの記述形式はXML形式です。Webモジュール定義ファイルの記述形式を以下に示します。
<?xml version="1.0" encoding="UTF-8"?> <interstage-web-app> <war> <context-root>context-root</context-root> <shared-context>shared-context</shared-context> <session> <cookie>cookie</cookie> <web-browser>web-browser</web-browser> <cookie-security>cookie-security</cookie-security> </session> <encoding>encoding</encoding> <authentication> <web-server>web-server</web-server> </authentication> </war> </interstage-web-app>
注意
各タグの記載順序は、上記の記載順序に従ってください。
先頭の<?xml．．．>は、XML宣言を記述しているため、ファイルの先頭で必ず記述してください。また、マルチバイト文字を使用(コメントも含む)する場合は、エンコード形式(「encoding=」部分)に、“UTF-8”などの適切な値を指定してください。
<interstage-web-app>、</interstage-web-app>は、XMLファイルの開始と終了を示すルートタグです。必ず指定してください。
設定する値の先頭、および末尾に指定した空白やタブ文字、改行文字などの制御文字は無視されます。
各項目のデフォルト値を使用する場合は、タグに空値を設定するのではなく、タグ自体を省略してください。
Webモジュール定義ファイルのタグ一覧
Webモジュール定義ファイルのタグ一覧を以下に示します。
また、“Interstage管理コンソール画面との対応”欄に、Interstage管理コンソールの[システム] > [ワークユニット] > [IJServer] > [配備] > [詳細設定]画面との対応を示します。
タグ名 | タグの | 複数の | Interstage管理コンソール画面との対応 | ||
|---|---|---|---|---|---|
war | ○ | × | Webアプリケーション設定 | ||
| ○ | × | Webアプリケーション名 | ||
○ | × | コンテキストの共有 | |||
session | ○ | × | セッション | ||
| ○ | × | クッキーに設定する/クッキーに設定しない | ||
○ | × | Webブラウザでセッションを保存する | |||
○ | × | クッキーにSecure属性を常に付加する | |||
○ | × | エンコーディング | |||
authentication | ○ | × | 認証 | ||
| ○ | × | Webサーバの認証情報を使用する/しない | ||
Webモジュール定義ファイルのタグ詳細
各タグに指定する値についての説明を行います。各項目の詳細については、Interstage管理コンソールのヘルプの“IJServer：配備”を参照してください。
Webアプリケーション名を指定します。64文字以内の値を指定してください。
デフォルト値については、Interstage管理コンソールのヘルプの[配備]を参照してください。
なお、ijsdeploymentコマンドの-cオプションでWebアプリケーション名を指定して配備を行った場合、本タグで指定した値ではなく、-cオプションで指定した値が有効になります。
ijsdeploymentコマンドについては、“リファレンスマニュアル(コマンド編)”の“J2EE運用コマンド”を参照してください。
他のWebアプリケーションへのディスパッチを許可するかどうかを以下から選択します。大文字・小文字を区別しません。
True(許可する)
False(許可しない)・・・デフォルト値
クッキーを使用してセションを管理するかどうかを以下から選択します。大文字・小文字を区別しません。
True(クッキーに設定する)・・・デフォルト値
False(クッキーに設定しない)
Webブラウザをいったん終了して再起動した時に、セションの有効時間内であれば再度接続可能とするかどうかを以下から選択します。大文字・小文字を区別しません。
True(Webブラウザでセションを保存する)
False(Webブラウザでセションを保存しない)・・・デフォルト値
※cookieタグにFalseを指定した場合は、本設定値は無視されます。
セション管理用クッキーにSecure属性を常に付加するかどうかを以下から選択します。大文字・小文字を区別しません。
Always(常に付与する)
Auto(接続時のメソッドで判断する)・・・デフォルト値
※cookieタグにFalseを指定した場合は、本設定値は無視されます。
Webクライアントからのリクエストボディの処理に使用するエンコーディングを指定します。
指定できる値は、“SJIS”、“EUC_JP”など、Javaでサポートされているエンコーディングです。
Webサーバの認証情報を使用するかどうかを以下から選択します。大文字・小文字を区別しません。
True(Webサーバの認証情報を使用する)
False(Webサーバの認証情報を使用しない)・・・デフォルト値
Webモジュール定義ファイルの例
Webアプリケーション名のみを指定する場合
<?xml version="1.0" encoding="UTF-8"?>
<interstage-web-app>
<war>
<context-root>sampleWarModule</context-root>
</war>
</interstage-web-app>すべて指定する場合
<?xml version="1.0" encoding="UTF-8"?>
<interstage-web-app>
<war>
<context-root>sampleWarModule</context-root>
<shared-context>True</shared-context>
<session>
<cookie>True</cookie>
<web-browser>True</web-browser>
<cookie-security>Always</cookie-security>
</session>
<encoding>EUC_JP</encoding>
<authentication>
<web-server>True</web-server>
</authentication>
</war>
</interstage-web-app>