2.2.6 War属性の詳細

cosminexus.xmlのWar属性の詳細について,タグごとに説明します。

なお,ここでは,「2.1 Cosminexusアプリケーション属性ファイル(cosminexus.xml)の指定内容」に記載されている順番にタグの詳細について説明しています。

<この項の構成>
(1) <war>
(2) <module-name>
(3) <security-role>
(4) <role-name>
(5) <linked-to>
(6) <resource-ref>
(7) <res-ref-name>
(8) <linked-to>
(9) <resource-env-ref>
(10) <resource-env-ref-name>
(11) <linked-queue>
(12) <resource-adapter>
(13) <queue>
(14) <linked-adminobject>
(15) <resourceadapter-name>
(16) <adminobject-name>
(17) <linked-to>
(18) <thread-control>
(19) <thread-control-max-threads>
(20) <thread-control-exclusive-threads>
(21) <thread-control-queue-size>
(22) <resource-watcher>
(23) <watcher-threshold>
(24) <watcher-interval>
(25) <watcher-enabled>
(26) <watcher-writefile-enabled>
(27) <urlgroup-thread-control>
(28) <urlgroup-thread-control-name>
(29) <urlgroup-thread-control-max-threads>
(30) <urlgroup-thread-control-exclusive-threads>
(31) <urlgroup-thread-control-queue-size>
(32) <urlgroup-thread-control-mapping>
(33) <url-pattern>
(34) <stats-monitor>
(35) <waiting-request-count>
(36) <enabled>
(37) <high-threshold>
(38) <low-threshold>
(39) <http-request>
(40) <encoding>
(41) <http-response>
(42) <encoding>
(43) <jsp>
(44) <page-encoding>
(45) <http-session>
(46) <http-session-max-number>
(47) <resource-watcher>
(48) <watcher-threshold>
(49) <watcher-interval>
(50) <watcher-enabled>
(51) <watcher-writefile-enabled>
(52) <dbsfo>
(53) <enabled>
(54) <application-id>
(55) <attribute-data-size-max>
(56) <exclude-extensions>
(57) <start-notify-error>
(58) <start-order>

(1) <war>

説明
WARについて定義します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(2) <module-name>

説明
WARを特定するためのキーとなります。
次の条件に従い設定値を指定します。
application.xmlを含むアプリケーションの場合
  • アーカイブ形式・展開ディレクトリ形式共通
    application.xmlの<application>-<module>-<web>-<web-uri>に指定した文字列を指定します。
application.xmlを含まないアプリケーションの場合
  • アーカイブ形式(cjimportappコマンド(-f/-d))
    J2EEアプリケーション中のWARファイルの場所をEARのルートからの相対パスで指定します。
  • 展開ディレクトリ形式(cjimportappコマンド(-a))
    WARディレクトリの,アプリケーションディレクトリからの相対パスの末尾の"_war"を".war"に置き換えた値を指定します。
相対パスで指定する場合の注意事項
  • パスの区切り文字にはスラント「/」を使用します。
  • パスの文字列の先頭にスラント「/」は指定できません。
  • パスの文字列中に,"./","../"および"//"は指定できません。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(3) <security-role>

説明
セキュリティロールを定義します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(4) <role-name>

説明
セキュリティロール名を指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(5) <linked-to>

説明
アクセスコントロールリスト(cjaddsecコマンドで定義したロール名)を指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できます。

(6) <resource-ref>

説明
Servletから参照するリソースを定義します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(7) <res-ref-name>

説明
リソース参照の名称を指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(8) <linked-to>

説明
対応するリソースアダプタ表示名,メール表示名を指定します。
  • Connector 1.0以前
    <リソースアダプタの表示名>
  • Connector 1.5以降のアウトバウンドリソースアダプタ
    <リソースアダプタ表示名>!<コネクション定義識別子>
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(9) <resource-env-ref>

説明
Servletから参照するリソース環境変数を定義します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(10) <resource-env-ref-name>

説明
リソース環境変数参照の名称を指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(11) <linked-queue>

説明
キュー名称を指定します。DDの要素<resource-env-ref-type>タグに「javax.jms.Queue」が指定された場合だけ有効です。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。
指定可能値
なし。
ほかのタグとの依存関係
DD<resource-env-ref-type>タグと依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(12) <resource-adapter>

説明
リソースアダプタの表示名を指定します。
Connector 1.5以降のリソースアダプタは指定できません。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(13) <queue>

説明
キュー名称を指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(14) <linked-adminobject>

説明
管理対象オブジェクトを指定します。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(15) <resourceadapter-name>

説明
リソースアダプタの表示名を指定します。
Connector 1.0以前のリソースアダプタは指定できません。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(16) <adminobject-name>

説明
管理対象オブジェクト名を指定します。
指定可能値
英数字,およびアンダースコア「_」を指定できます。
ただし,連続してアンダースコア「_」を指定することはできません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(17) <linked-to>

説明
JavaBeansリソースの表示名を指定します。
DDの要素<resource-env-ref-type>タグに「JavaBeansリソースのクラス名」が指定された場合だけ有効です。
なお,<linked-to>タグ,<linked-queue>タグ,<linked-adminobject>タグのうちどれか一つを指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
DD<resource-env-ref-type>タグと依存関係があります。
タグの省略
省略できます。
値の省略
省略できます。

(18) <thread-control>

説明
Webアプリケーションのスレッド制御を設定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(19) <thread-control-max-threads>

説明
Webアプリケーション単位の最大同時実行スレッド数を指定します。
占有スレッド数以上の値を指定します。
指定可能値
1~1024の整数値。
ほかのタグとの依存関係
<thread-control-exclusive-threads>タグと依存関係があります。
タグの省略
省略できません。
値の省略
省略できません。

(20) <thread-control-exclusive-threads>

説明
占有スレッド数を指定します。
Webアプリケーション単位の最大同時実行スレッド数以下を指定します。
指定可能値
0~1024の整数値。
ほかのタグとの依存関係
<thread-control-max-threads>タグ,および<urlgroup-thread-control-exclusive-threads>タグと依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(21) <thread-control-queue-size>

説明
Webアプリケーション単位の実行待ち行列数を指定します。
指定可能値
0~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(22) <resource-watcher>

説明
Webアプリケーション単位のリクエスト実行待ちキュー格納数の監視に関するプロパティを設定します。
このタグか,<watcher-threshold>,<watcher-interval>,<watcher-enabled>,または<watcher-writefile-enabled>を省略した場合,デフォルト値が有効になり,監視イベントが有効になります。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(23) <watcher-threshold>

説明
アラートメッセージを出力するしきい値を指定します。
指定可能値
1~100の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(24) <watcher-interval>

説明
監視間隔を指定します。
指定可能値
1~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(25) <watcher-enabled>

説明
Webアプリケーション単位のリクエスト実行待ちキュー格納数の監視を有効にするかどうかを指定します。
指定可能値
  • true
    有効にする。
  • false
    無効にする。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(26) <watcher-writefile-enabled>

説明
リソース使用状況をファイルに出力するかどうかを指定します。
指定可能値
  • true
    出力する。
  • false
    出力しない。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(27) <urlgroup-thread-control>

説明
URLグループ単位の同時実行スレッド数制御を設定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(28) <urlgroup-thread-control-name>

説明
URLグループ単位の同時実行スレッド数制御の定義名を指定します。
URLグループ単位の同時実行スレッド数制御の定義名はWebアプリケーション内で,一意な名称を指定します。
指定可能値
英数字,ハイフン「-」,アンダースコア「_」を使用できます。
文字の長さは1≦文字列長≦64で指定します。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(29) <urlgroup-thread-control-max-threads>

説明
URLグループ単位の最大同時実行スレッド数を整数値で指定します。
指定可能値
1~thread-control-max-threadsの整数値。
ほかのタグとの依存関係
<thread-control-max-threads>タグ,および<urlgroup-thread-control-exclusive-threads>タグと依存関係があります。
タグの省略
省略できません。
値の省略
省略できません。

(30) <urlgroup-thread-control-exclusive-threads>

説明
URLグループ単位の占有スレッド数を指定します。
指定可能値
0~urlgroup-thread-control-max-threadsかつthread-control-exclusive-threads以下の整数値。
ほかのタグとの依存関係
<thread-control-max-threads>タグ,<thread-control-exclusive-threads>タグ,および<urlgroup-thread-control-max-threads>タグと依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(31) <urlgroup-thread-control-queue-size>

説明
URLグループ単位の実行待ちキューのサイズを指定します。
指定可能値
0~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(32) <urlgroup-thread-control-mapping>

説明
制御対象となるURLのマッピング情報を設定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(33) <url-pattern>

説明
制御対象となるURLパターンを指定します。
一つのWebアプリケーション内で同じURLパターンを指定することはできません。
指定例を次に示します。

/soda/grape/*
/foo/*
/contents
*.foo

指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(34) <stats-monitor>

説明
稼働統計の監視の設定をします。
このタグか,<enabled>,<high-threshold>,または<low-threshold>を省略した場合,デフォルト値が有効になり,しきい値イベントが有効になります。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(35) <waiting-request-count>

説明
URLグループ単位の実行待ちリクエスト数の監視をします。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できません。
値の省略
省略できません。

(36) <enabled>

説明
URLグループ単位の実行待ちリクエスト数の監視のしきい値イベントを有効にするかどうかを指定します。
指定可能値
  • true
    有効にする。
  • false
    無効にする。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(37) <high-threshold>

説明
しきい値イベントを出力する上限しきい値(単位:%)を指定します。
指定可能値
1~100の整数値。
low-threshold以上でなければなりません。
ほかのタグとの依存関係
<low-threshold>と依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(38) <low-threshold>

説明
しきい値イベントを出力する下限しきい値(単位:%)を指定します。
指定可能値
0~99の整数値。
high-threshold以下でなければなりません。
ほかのタグとの依存関係
<high-threshold>と依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(39) <http-request>

説明
HTTPリクエストに関する各種設定をします。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(40) <encoding>

説明
リクエストボディ,およびクエリのデコードに使用するデフォルトのエンコーディングを指定します。
ただし,Servlet仕様に準拠した設定(ServletAPIおよびweb.xml)がある場合,無効となります。
JavaVMがサポートしている文字エンコーディングを指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(41) <http-response>

説明
HTTPレスポンスに関する各種設定をします。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(42) <encoding>

説明
レスポンスボディのエンコードに使用するデフォルトのエンコーディングを指定します。
ただし,Servlet仕様に準拠した設定(ServletAPIおよびweb.xml)がある場合,無効となります。
JavaVMがサポートしている文字エンコーディングを指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(43) <jsp>

説明
JSPに関する各種設定をします。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(44) <page-encoding>

説明
JSPファイルの読み込みに使用するデフォルトのエンコーディングを指定します。
ただし,Servlet仕様に準拠した設定(ServletAPIおよびweb.xml)がある場合,無効となります。
JavaVMがサポートしている文字エンコーディングを指定します。
指定可能値
入力は制限されません。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(45) <http-session>

説明
Webアプリケーション単位のHttpSession数の監視に関する情報を設定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(46) <http-session-max-number>

説明
使用可能なHttpSessionの最大数を指定します。
-1を指定した場合は無制限となります。
指定可能値
-1~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(47) <resource-watcher>

説明
HttpSession数の監視に関するプロパティを設定します。
このタグか,<watcher-threshold>,<watcher-interval>,<watcher-enabled>,または<watcher-writefile-enabled>を省略した場合,デフォルト値が有効になり,監視イベントが有効になります。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(48) <watcher-threshold>

説明
アラートメッセージを出力するしきい値を指定します。
指定可能値
1~100の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(49) <watcher-interval>

説明
監視間隔を指定します。
指定可能値
1~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(50) <watcher-enabled>

説明
HttpSession数の監視を有効にするかどうかを指定します。
ただし,<http-session-max-number>に0を指定した場合,この指定に関係なく監視は無効となります。
指定可能値
  • true
    有効にする。
  • false
    無効にする。
ほかのタグとの依存関係
<http-session-max-number>タグと依存関係があります。
タグの省略
省略できます。
値の省略
省略できません。

(51) <watcher-writefile-enabled>

説明
リソース使用状況をファイルに出力するかどうかを指定します。
指定可能値
  • true
    出力する。
  • false
    出力しない。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(52) <dbsfo>

説明
データベースセッションフェイルオーバ機能を設定します。
指定可能値
なし。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(53) <enabled>

説明
データベースセッションフェイルオーバ機能を有効にするかどうかを設定します。
指定可能値
  • true
    有効にする。
  • false
    無効にする。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(54) <application-id>

説明
アプリケーション識別子を設定します。
指定可能値
英数字,およびアンダースコア「_」を使用できます。
最大16文字まで指定できます。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(55) <attribute-data-size-max>

説明
グローバルセッション情報に含めることが可能なHTTPセッションの属性情報の最大サイズを設定します。
指定可能値
128~10485760の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(56) <exclude-extensions>

説明
データベースセッションフェイルオーバ機能を抑止する拡張子を設定します。
URLのパスが指定した拡張子と同じ場合に,該当するリクエストでデータベースセッションフェイルオーバ機能は無効となります。指定した拡張子とURLの比較では大文字,小文字の区別はしません。データベースセッションフェイルオーバ機能を抑止する拡張子を設定しない場合は空文字列を設定します。
指定可能値
次に示す文字を512文字以内で指定します。
  • 英数字
  • 括弧「( )」
  • エクスクラメーション「!」
  • パーセント「%」
  • ドル「$」
  • アンパサンド「&」
  • シングルクオート「'」
  • プラス「+」
  • ハイフン「-」
  • イコール「=」
  • 単価記号「@」
  • アンダースコア「_」
  • チルダ「~」
  • ピリオド「.」
  • コンマ「,」
なお,複数の拡張子を指定する場合,コンマ「,」で区切って指定します。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できます。

(57) <start-notify-error>

説明
J2EEアプリケーションの開始時にスタートアップ時のロードが指定されているServlet/JSPの初期化処理中や,taglibの解析中にエラーが発生した場合,エラーを通知してアプリケーションの開始を中断するかどうかを指定します。
初期表示値は,アプリケーションサーバのバージョンが06-00以降で新規に作成したJ2EEアプリケーションだけtrue,それ以外のJ2EEアプリケーションはfalseとなります。
指定可能値
  • true
    エラーを通知する。
  • false
    エラーを通知しない。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。

(58) <start-order>

説明
J2EEアプリケーションの開始時・停止時の順番を指定します。開始時は昇順で開始処理が行われ,終了時は降順に停止処理が行われます。
指定可能値
0~2147483647の整数値。
ほかのタグとの依存関係
なし。
タグの省略
省略できます。
値の省略
省略できません。