Red Hat Training

A Red Hat training course is available for Red Hat JBoss Enterprise Application Platform

第21章 設定リファレンス

21.1. jboss-web.xml 設定リファレンス

はじめに

jboss-web.xml および web.xml デプロイメント記述子は両方ともデプロイメントの WEB-INF ディレクトリーに配置されます。jboss-web.xml は、JBoss EAP の Web アプリケーションデプロイメント記述子であり、JBossWeb の追加機能のための追加の設定オプションが含まれています。この記述子を使用して、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 の必要性を満たします。

表21.1 jboss-web.xml の一般的なトップレベル属性

属性 Description
servlet
サーブレット要素は、サーブレット固有のバインディングを指定します。
max-active-sessions
許可されるアクティブなセッションの最大数を決定します。セッションマネージャーによって管理されるセッションの数がこの値を超え、パッシベーション が有効になっている場合、設定された passivation-min-idle-time に 基づいて超過分がパッシベーションされます。
-1 に設定すると、制限がないことを意味します。
replication-config
Replication-config 要素は、jboss-web.xml ファイルでセッションレプリケーションを設定するために使用されます。
passivation-config
passivation-config 要素は、jboss-web.xml ファイルでセッションパッシベーションを設定するために使用されます。
distinct-name
個別の名前 要素は、Web アプリケーションの EJB3 の個別の名前を指定します。
data-source
web.xml に必要な データソース へのマッピング。
context-root アプリケーションのルートコンテキスト。デフォルト値は、.war 接尾辞のないデプロイメントの名前です。
virtual-host アプリケーションが要求を受け入れる HTTP 仮想ホストの名前。HTTP ホスト ヘッダーの内容を参照します。
アノテーション アプリケーションで使用される注釈について説明します。詳細は、<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 許可生成エージェントが WebResourcePermission 許可を生成する必要があるかどうかを指定します。
use-jboss-authorization この要素が存在し、大文字と小文字を区別しない値 true が含まれている場合、JBossWeb 認証スタックが使用されます。存在しないか、true ではない値が含まれている場合は、JavaEnterpriseEdition 仕様で指定されている許可メカニズムのみが使用されます。この要素は JBoss EAP 6 の新機能です。
disable-audit このブール要素を false に設定すると有効になり、true に設定すると Web 監査が無効になります。Web セキュリティー監査は JavaEE 仕様の一部ではありません。この要素は JBoss EAP 6 の新機能です。
disable-cross-context false の場合、アプリケーションは別のアプリケーションコンテキストを呼び出すことができます。デフォルトは true です。
enable-websockets jboss-web.xml でこの要素を true に設定して、Web アプリケーションで WebSocket アクセスを有効にするかどうかを指定します。
次の要素にはそれぞれ子要素があります。
<annotation>
アプリケーションで使用される注釈について説明します。次の表に、<annotation> の子要素を示します。

表21.2 注釈設定要素

属性 説明
class-name
注釈のクラスの名前
servlet-security
サーブレットのセキュリティーを表す @ServletSecurity などの要素。
run-as
実行情報を表す @RunAs などの要素。
multipart-config
multipart-config 情報を表す @MultiPart などの要素。
<listener>
リスナーについて説明します。次の表に、<listener> の子要素を示します。

表21.3 リスナー設定要素

属性 説明
class-name
リスナーのクラスの名前
listener-type
アプリケーションのコンテキストに追加するリスナーの種類を示す 条件 要素のリスト。有効な選択肢は次のとおりです。
CONTAINER
ContainerListener をコンテキストに追加します。
ライフサイクル
LifecycleListener をコンテキストに追加します。
SERVLET_INSTANCE
InstanceListener をコンテキストに追加します。
SERVLET_CONTAINER
WrapperListener をコンテキストに追加します。
SERVLET_LIFECYCLE
WrapperLifecycle をコンテキストに追加します。
module
リスナークラスを含むモジュールの名前。
param
パラメーター。<param-name> と <param-value> の 2 つの子要素が含まれます。
<valve>
アプリケーションのバルブについて説明します。に似ています<listener>、には class-name、module、および param 要素があります。
バグの報告