![]() |
![]() |
|
|
| |
web.xml デプロイメント記述子の要素
以下の節では、web.xml
ファイルで定義されているデプロイメント記述子の要素について説明します。web.xml
のルート要素は <web-app>
です。次の要素が <web-app>
要素の内部に定義されています。
icon
要素では、GUI ツールで Web アプリケーションを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Web アプリケーション内での位置を指定します(servlet 要素にも icon という要素があり、GUI ツール内にアイコンを提供してサーブレットを表すために使用されます)。
この要素は現在、WebLogic Server では使用されていません。
次の表では、icon
要素内で定義できる要素について説明します。
省略可能な display-name
要素では、Web アプリケーションの表示名(GUI ツールで表示できる短い名前)を指定します。
要素 |
必須/ |
説明 |
|
省略可能 |
この要素は現在、WebLogic Server では使用されていない。 |
省略可能な description 要素では、Web アプリケーションに関する説明文を示します。
要素 |
必須/ |
説明 |
|
省略可能 |
この要素は現在、WebLogic Server では使用されていない。 |
distributable 要素
distributable 要素は、WebLogic Server では使用されていません。
要素 |
必須/ |
説明 |
|
省略可能 |
この要素は現在、WebLogic Server では使用されていない。 |
省略可能な context-param
要素では、Web アプリケーションのサーブレット コンテキストの初期化パラメータを宣言します。<param-name
> 要素と <param-value
> 要素を使用して、各コンテキスト パラメータを 1 つの context-param 要素内に設定します。コードでは、javax.servlet.ServletContext.getInitParameter()
メソッドおよび javax.servlet.ServletContext.getInitParameterNames()
メソッドを使用して、これらのパラメータにアクセスできます。
次の表では、context-param
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
必須 |
パラメータの名前。 |
|
必須 |
パラメータの値。 |
|
省略可能 |
パラメータの説明文。 |
filter 要素
filter 要素は、フィルタ クラスとその初期化パラメータを定義します。フィルタの詳細については、 フィルタのコンフィグレーションを参照してください。
次の表では、servlet
要素内で定義できる要素について説明します。
filter-mapping 要素
次の表では、filter-mapping
要素内で定義できる要素について説明します。
listener 要素
listener 要素を使うアプリケーション リスナを定義します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
Web アプリケーション イベントに応答するクラスの名前。 |
詳細については、 イベント リスナのコンフィグレーションを参照してください。
servlet
要素では、サーブレットの宣言的なデータを指定します。
jsp-file
要素および <load-on-startup>
要素が指定されている場合、その JSP は、WebLogic Server の起動時にあらかじめコンパイルされ、ロードされます。
次の表では、servlet
要素内で定義できる要素について説明します。
これは、 servlet 要素内の要素です。
icon
要素では、GUI ツールでサーブレットを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Web アプリケーション内での位置を指定します。
次の表では、icon
要素内で定義できる要素について説明します。
これは、 servlet 要素内の要素です。
省略可能な init-param
要素では、サーブレットの初期化パラメータの名前と値の組み合わせを指定します。パラメータごとに init-param
タグの別個のセットを使用します。
javax.servlet.ServletConfig.getInitParameter()
メソッドを使用して、これらのパラメータにアクセスできます。
次の表では、init-param
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
必須 |
このパラメータの名前を定義する。 |
|
必須 |
このパラメータの |
<description> |
省略可能 |
初期化パラメータの説明文。 |
WebLogic Server では、使用可能な実行キューにサーブレットまたは JSP を割り当てる特別な初期化パラメータ、wl-dispatch-policy
が認識されます。次の例では、CriticalWebApp
という名前の実行キューの実行スレッドを使用するようにサーブレットを割り当てています。
<servlet>
...
<init-param>
<param-name>wl-dispatch-policy</param-name>
<param-value>CriticalWebApp</param-value>
</init-param>
</servlet>
CriticalWebApp
キューが使用できない場合は、デフォルトの WebLogic Server 実行キュー内の使用可能な実行キューを使用します。WebLogic Server での実行キューのコンフィグレーションについては、「スレッド数の設定」を参照してください。キューの作成と使用については、「実行キューによるスレッド使用の制御」を参照してください。
これは、 servlet 要素内の要素です。
security-role-ref
要素は、<security-role>
で定義されたセキュリティ ロール名を、サーブレットのロジックでハード コード化される代替ロール名にリンクします。この特別な抽象化レイヤによって、サーブレット コードを変更しなくてもデプロイメント時にサーブレットをコンフィグレーションできるようになります。
次の表では、security-role-ref
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
ロールの説明文。 |
|
必須 |
サーブレット コード内で使用されるセキュリティ ロールまたはプリンシパルの名前を定義する。 |
|
必須 |
後にデプロイメント記述子内の |
servlet-mapping
要素では、サーブレットと URL パターンの間のマッピングを定義します。
次の表では、servlet-mapping
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
必須 |
URL パターンのマッピング先のサーブレットの名前。この名前は、 |
|
必須 |
URL を解決する場合に使用されるパターンを記述する。 サンプル パターンを以下に示す。
URL は、サーブレット仕様 2.2 の第 10 節で指定されているルールに準拠している必要がある。 サーブレットのマッピングのその他の例については、 サーブレット マッピングを参照。 |
session-config
要素では、Web アプリケーションのセッションのパラメータを定義します。
次の表では、session-config
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
この Web アプリケーション内のセッションが期限切れになってからの分数。この要素で設定する値は、次に示す特殊な値のいずれか 1 つが入力されない限り、WebLogic 固有のデプロイメント記述子である デフォルト値 : -2 最大値 : Integer.MAX_VALUE ÷ 60 特殊な値 :
詳細については、 session-descriptor 要素を参照。 |
mime-mapping
要素では、拡張子と MIME タイプの間のマッピングを定義します。
次の表では、mime-mapping
要素内で定義できる要素について説明します。
省略可能な welcome-file-list
要素では、welcome-file
要素の順序付きリストを指定します。
URL 要求がディレクトリ名の場合、この要素で指定された最初のファイルが WebLogic Server によって返されます。そのファイルが見つからない場合は、WebLogic Server によってリスト内の次のファイルが返されます。
詳細については、 ウェルカム ページのコンフィグレーションと「WebLogic Server による HTTP リクエストの解決方法」を参照してください。
次の表では、welcome-file-list
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
デフォルトのウェルカム ファイルとして使用するファイル名(例 : index.html)。 |
省略可能な error-page
要素では、エラーコードや例外のタイプと Web アプリケーションにあるリソースのパスの間のマッピングを指定します。
WebLogic Server が HTTP リクエストに応答しているときにエラーが発生した場合や、Java 例外の結果としてエラーが発生した場合は、WebLogic Server によって HTTP エラー コードまたは Java エラー メッセージのいずれかを表示する HTML ページが返されます。独自の HTML ページを定義して、これらのデフォルトのエラー ページの代わりとして、または Java 例外の応答ページとして表示することができます。
詳細については、 HTTP エラー応答のカスタマイズと「WebLogic Server による HTTP リクエストの解決方法」を参照してください。
次の表では、error-page
要素内で定義できる要素について説明します。
注意: <error-code>
と <exception-type>
のどちらかを定義します。両方は定義しないでください。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
有効な HTTP エラー コード(例 : |
|
省略可能 |
Java 例外の完全修飾クラス名(例 : |
|
必須 |
エラーに応答して表示されるリソースの位置(例 : |
省略可能な taglib
要素では、JSP のタグ ライブラリを指定します。
JSP タグ ライブラリ記述子(TLD)の位置を URI パターンに関連付けます。TLD は、WEB-INF
ディレクトリを基準にした相対位置にある JSP 内に指定できますが、Web アプリケーションをデプロイするときに、<taglib>
タグを使用して TLD をコンフィグレーションすることもできます。TLD ごとに別個の要素を使用します。
次の表では、taglib
要素内で定義できる要素について説明します。
省略可能な resource-ref
要素では、外部リソースへの参照ルックアップ名を定義します。この定義により、サーブレット コードは、デプロイメント時に実際の位置にマップされる「仮想的な」名前でリソースをルックアップできるようになります。
別個の <resource-ref>
要素を使用して、各外部リソース名を定義します。外部リソース名は、デプロイメント時に WebLogic 固有のデプロイメント記述子 weblogic.xml
でリソースの実際の位置名にマップされます。
次の表では、resource-ref
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
説明文。 |
|
必須 |
JNDI ツリー内で使用されるリソースの名前。Web アプリケーション内のサーブレットはこの名前を使用して、リソースへの参照をルックアップする。 |
|
必須 |
参照名に対応するリソースの Java クラスのタイプ。Java の完全パッケージ名を使用する。 |
|
必須 |
セキュリティのためのリソース サインオンの指定に使用される。
|
|
省略可能 |
指定されたリソース マネージャ接続ファクトリ参照を経由して取得された接続を共有するかどうかを指定する。 有効な値 : |
security-constraint
要素では、<web-resource-collection>
要素で定義されたリソースの集合へのアクセス特権を定義します。
詳細については、 Web アプリケーションでのセキュリティのコンフィグレーションを参照してください。
次の表では、security-constraint
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
必須 |
このセキュリティ制約が適用される Web アプリケーションのコンポーネントを定義する。 |
|
省略可能 |
このセキュリティ制約で定義される Web リソースの集合にアクセスするグループまたはプリンシパルを定義する。 auth-constraint 要素も参照。 |
|
省略可能 |
クライアントによるサーバとの通信方法を定義する。 |
各 <security-constraint>
要素には、1 つまたは複数の <web-resource-collection>
要素が必要になります。これらの要素では、このセキュリティ制約が適用される Web アプリケーションの領域を定義します。
これは、 security-constraint 要素内の要素です。
次の表では、web-resource-collection
要素内で定義できる要素について説明します。
これは、 security-constraint 要素内の要素です。
省略可能な auth-constraint
要素では、このセキュリティ制約で定義された Web リソースの集合にアクセスするグループまたはプリンシパルを定義します。
次の表では、auth-constraint
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
セキュリティ制約の説明文。 |
|
省略可能 |
このセキュリティ制約で定義されたリソースにアクセスできるセキュリティ ロールを定義する。セキュリティ ロール名は、
|
これは、 security-constraint 要素内の要素です。
user-data-constraint
要素では、クライアントによるサーバとの通信方法を定義します。
次の表では、user-data-constraint
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
説明文。 |
|
必須 |
クライアントとサーバの間の通信方法を指定する。
指定できる値 : |
省略可能な login-config
要素を使って、ユーザの認証方法、このアプリケーションで使用されるレルムの名前、およびフォームによるログイン機能で必要になる属性をコンフィグレーションします。
この要素が指定されている場合、ユーザが Web アプリケーション内で定義されている <security-constraint>
によって制約されたすべてのリソースにアクセスするには認証を受ける必要があります。認証されると、ユーザは、ほかのリソースにアクセスする権限が与えられる場合もあります。
次の表では、login-config
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
ユーザを認証する場合に使用される方式を指定する。指定できる値は次のとおり。
|
|
省略可能 |
ユーザの資格を認証する場合に参照されるレルムの名前。省略した場合、Administration Console の [Web アプリケーション|コンフィグレーション|その他] タブにある [認証レルム名] フィールドで定義されたレルムがデフォルトで使用される。詳細については、「セキュリティ レルムの指定」を参照。 注意: 注意: システム セキュリティ レルムは、サーバで特定の操作が実行されるときにチェックされるセキュリティ情報の集合である。サーブレット セキュリティ レルムは、これとは別のセキュリティ情報の集合であり、ページがアクセスされて基本認証が使われる際にチェックされる。 |
|
省略可能 |
|
これは、 login-config 要素内の要素です。
<auth-method>
を FORM
にコンフィグレーションする場合に、<form-login-config>
要素を使用します。
要素 |
必須/ |
説明 |
---|---|---|
|
必須 |
ユーザを認証する場合に使用される、ドキュメント ルートを基準にした Web リソースの相対的な URI。これは、HTML ページ、JSP、または HTTP サーブレットのいずれかになり、特定の命名規約に従うフォームを表示する HTML ページを返す。詳細については、 Web アプリケーション用の認証の設定を参照。 |
|
必須 |
失敗した認証ログインに応答してユーザに送信される、ドキュメント ルートを基準にした Web リソースの相対的な URI。 |
次の表では、security-role
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
セキュリティ ロールの説明文。 |
|
必須 |
ロール名。ここで使用する名前は、WebLogic 固有のデプロイメント記述子 |
省略可能な env-entry
要素では、アプリケーションの環境エントリを宣言します。環境エントリごとに別個の要素を使用します。
次の表では、env-entry
要素内で定義できる要素について説明します。
省略可能な ejb-ref
要素では、EJB リソースへの参照を定義します。この参照は、WebLogic 固有のデプロイメント記述子ファイル weblogic.xml
でマッピングを定義することにより、デプロイメント時に EJB の実際の位置にマップされます。別個の <ejb-ref>
要素を使用して、各参照 EJB 名を定義します。
次の表では、ejb-ref
要素内で定義できる要素について説明します。
要素 |
必須/ |
説明 |
---|---|---|
|
省略可能 |
参照の説明文。 |
|
必須 |
Web アプリケーションで使用される EJB の名前。この名前は、WebLogic 固有のデプロイメント記述子 |
|
必須 |
参照 EJB の期待される Java クラスのタイプ。 |
|
必須 |
EJB ホーム インタフェースの完全修飾クラス名。 |
|
必須 |
EJB リモート インタフェースの完全修飾クラス名。 |
|
省略可能 |
含まれている J2EE アプリケーション パッケージでの EJB の |
|
省略可能 |
参照される EJB にセキュリティ コンテキストが適用されるセキュリティ ロール。 |
![]() |
![]() |
![]() |