A.5. jboss-web.xml 設定リファレンス
はじめに
jboss-web.xml および web.xml デプロイメント記述子はいずれもデプロイメントの WEB-INF ディレクトリーに配置されます。jboss-web.xml は JBoss EAP の Web アプリケーションデプロイメント記述子で、JBoss Web の追加機能の追加設定オプションが含まれます。この記述子を使用すると web.xml 記述子の設定を上書きし、JBoss EAP 固有の設定を設定できます。
グローバルリソースの WAR 要件へのマッピング
アプリケーションの web.xml で設定される利用可能な設定要件の多くをローカルリソースにマップします。web.xml 設定の説明は、を参照してください http://docs.oracle.com/cd/E13222_01/wls/docs81/webapp/web_xml.html。
たとえば、
web.xml に jdbc/MyDataSource が必要な場合、jboss-web.xml はグローバルデータソース java:/DefaultDS をマップしてこのニーズに対応する場合があります。WAR はグローバルデータソースを使用して、jdbc/MyDataSource の必要性を埋めます。
| 属性 | 説明 |
|---|---|
| servlet |
servlet 要素はサーブレット固有のバインディングを指定します。
|
| max-active-sessions |
許可されるアクティブなセッションの最大数を決定します。セッションマネージャーが管理するセッションの数がこの値を超え、パッシベーションが有効な場合には、設定された
に基づいて超過がパッシベートされます。
-1 に設定すると、無制限を意味します。
|
| replication-config | replication-config 要素は、jboss-web.xml ファイルでセッションレプリケーションを設定するために使用されます。
|
| passivation-config | passivation-config 要素は、jboss-web.xml ファイルでセッションパッシベーションを設定するために使用されます。
|
| distinct-name | distinct-name 要素は、Web アプリケーションの EJB 3 固有名を指定します。
|
| data-source | web.xml が必要とする データソース へのマッピング。
|
| context-root | アプリケーションのルートコンテキスト。デフォルト値は、.war サフィックスのないデプロイメントの名前です。 |
| virtual-host | アプリケーションが要求を受け入れる HTTP virtual-host の名前。HTTP Host ヘッダーの内容を参照します。 |
| アノテーション | アプリケーションによって使用されるアノテーションを記述します。詳細は、<annotation> を参照してください。 |
| listener | アプリケーションによって使用されるリスナーを記述します。詳細は、<listener> を参照してください。 |
| session-config | この要素は web.xml の < session-config> 要素と同じ関数を埋め、互換性のためにのみ含まれます。 |
| バルブ | は、アプリケーションによって使用されるバルブを表しています。詳細は、<valve> を参照してください。 |
| overlay | アプリケーションに追加するオーバーレイの名前。 |
| security-domain | アプリケーションによって使用されるセキュリティードメインの名前。セキュリティードメイン自体は Web ベースの管理コンソールまたは管理 CLI で設定されます。 |
| security-role | この要素は web.xml の < security-role> 要素 と同じ関数を入力し、互換性のためにのみ含まれます。 |
| jacc-star-role-allow | jacc-star-role-allow 要素は、jacc プロバイダーが承認をバイパスできるように、Web レイヤーでエージェントを生成する jacc パーミッションを生成する必要があるかどうかを指定します。
|
| use-jboss-authorization | この要素が存在し、大文字と小文字を区別しない値「true」が含まれている場合は、JBoss Web 認証スタックが使用されます。これが存在しないか、「true」ではない値が含まれている場合は、Java Enterprise Edition 仕様で指定された承認メカニズムのみが使用されます。この要素は JBoss EAP 6 の新機能です。 |
| disable-audit | このブール値要素を false に設定して有効にし、Web 監査を無効にするには true に設定します。Web セキュリティー監査は Java EE 仕様の一部ではありません。この要素は JBoss EAP 6 の新機能です。 |
| disable-cross-context | false の場合、アプリケーションは別のアプリケーションコンテキストを呼び出すことができます。デフォルトは true です。 |
| enable-websockets | jboss-web.xml でこの要素を true に設定して、Web アプリケーションに対して WebSocket アクセスを有効にするかどうかを指定します。 |
以下の要素にはそれぞれ子要素があります。
<annotation>
アプリケーションによって使用されるアノテーションを記述します。以下の表は、<
annotation> の子要素を示してい ます。
| 属性 | 説明 |
|---|---|
| class-name |
アノテーションのクラス名
|
| servlet-security |
サーブレットセキュリティーを表す
@ServletSecurity などの要素。
|
| run-as |
run-as 情報を表す
@RunAs などの要素。
|
| multipart-config |
マルチパート設定情報を表す
@MultiPart などの要素。
|
<listener>
リスナーを記述します。以下の表は、<
listener> の子要素を示してい ます。
| 属性 | 説明 |
|---|---|
| class-name |
リスナーのクラス名
|
| listener-type |
アプリケーションのコンテキストに追加するリスナーの種類を示す
条件 要素の一覧。有効な選択肢は以下の通りです。
|
| モジュール |
リスナークラスが含まれるモジュールの名前。
|
| パラメーター |
パラメーター。<
param-name> と <param- ます。
|
<valve>
アプリケーションのバルブを示します。<listener> と同様に、Class-name、module、および param 要素があります。