| ドキュメントのダウンロード | サイト マップ | Glossary | |
|
|||
| BEA ホーム | 製品 | dev2dev | support | askBEA |
|
|
|
|||||||
 |
| e-docs > WebLogic Server > Web アプリケーションのアセンブルとコンフィグレーション > web.xml デプロイメント記述子の要素 |
|
Web アプリケーションのアセンブルとコンフィグレーション
|
この章では、web.xml ファイルで定義されているデプロイメント記述子の要素について説明します。web.xml のルート要素は <web-app> です。次の要素が <web-app> 要素の内部に定義されています。
icon 要素では、GUI ツールで Web アプリケーションを表示する場合に使用される画像 (小さいアイコンと大きいアイコン) の、Web アプリケーション内での位置を指定します (servlet 要素にも icon という要素があり、GUI ツール内にアイコンを提供してサーブレットを表すために使用されます)。
この要素は現在、WebLogic Server では使用されていません。
次の表では、icon 要素内で定義できる要素について説明します。
|
GUI ツールで Web アプリケーションを表す小さい (16x16 ピクセル) .gif 画像または .jpg 画像の位置。この要素は現在、WebLogic Server では使用されていない。 |
||
|
GUI ツールで Web アプリケーションを表す大きい (32x32 ピクセル) .gif 画像または .jpg 画像の位置。この要素は現在、WebLogic Server では使用されていない。 |
省略可能な display-name 要素では、Web アプリケーションの表示名 (GUI ツールで表示できる短い名前) を指定します。
省略可能な description 要素では、Web アプリケーションに関する説明文を示します。
distributable 要素は、WebLogic Server では使用されていません。
context-param 要素では、Web アプリケーションのサーブレット コンテキストの初期化パラメータを宣言します。<param-name> 要素と <param-value> 要素を使用して、各コンテキスト パラメータを 1 つの context-param 要素内に設定します。コードでは、javax.servlet.ServletContext.getInitParameter() メソッドおよび javax.servlet.ServletContext.getInitParameterNames() メソッドを使用して、これらのパラメータにアクセスできます。
次の表では、context-param 要素内で定義できる要素について説明します。
filter 要素は、フィルタ クラスとその初期化パラメータを定義します。
次の表では、servlet 要素内で定義できる要素について説明します。
|
GUI ツールでフィルタを表示する場合に使用される画像 (小さいアイコンと大きいアイコン) の、Web アプリケーション内での位置を指定する。small-icon 要素と large-icon 要素がある。 |
||
次の表では、filter-mapping 要素内で定義できる要素について説明します。
listener 要素を使うアプリケーション リスナを定義します。
詳細については、イベント リスナのコンフィグレーションを参照してください。
servlet 要素では、サーブレットの宣言的なデータを指定します。
jsp-file 要素および <load-on-startup> 要素が指定されている場合、その JSP は、WebLogic Server の起動時にあらかじめコンパイルされ、ロードされます。
次の表では、servlet 要素内で定義できる要素について説明します。
これは、servlet内の要素です。
icon 要素では、GUI ツールで Web アプリケーションを表示する場合に使用される画像 (小さいアイコンと大きいアイコン) の、Web アプリケーション内での位置を指定します
次の表では、icon 要素内で定義できる要素について説明します。
|
GUI ツールでサーブレットを表示する場合に使用される小さい (16x16 ピクセル) .gif 画像または .jpg 画像の Web アプリケーション内での位置を指定する。 |
||
|
GUI ツールでサーブレットを表示する場合に使用される大きい (32x32 ピクセル) .gif 画像または .jpg 画像の Web アプリケーション内での位置を指定する。 |
これは、servlet内の要素です。
省略可能な init-param 要素では、サーブレットの初期化パラメータの名前と値の組み合わせを指定します。パラメータごとに init-param タグの別個のセットを使用します。
javax.servlet.ServletConfig.getInitParameter() メソッドを使用して、これらのパラメータにアクセスできます。
次の表では、init-param 要素内で定義できる要素について説明します。
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 パターンのマッピング先のサーブレットの名前。この名前は、<servlet> 宣言タグでサーブレットに割り当てた名前に対応する。 |
||
|
URL を解決する場合に使用されるパターンを記述する。http://host:port (「host」はホスト名、「port」はポート番号) + WebAppName に続く URL の部分は、WebLogic Server によって <url-pattern> と比較される。パターンが一致すれば、この要素でマップされているサーブレットが呼び出される。 /soda/grape/* URL は、サーブレット仕様 2.3 で指定されているルールに準拠している必要がある。 サーブレットのマッピングのその他の例については、サーブレット マッピングを参照。 |
session-config 要素では、Web アプリケーションのセッションのパラメータを定義します。
次の表では、session-config 要素内で定義できる要素について説明します。
|
この Web アプリケーション内のセッションが期限切れになるまでの分数。この要素で設定する値は、次に示す特殊な値のいずれか 1 つが入力されない限り、WebLogic 固有のデプロイメント記述子である weblogic.xml の <session-descriptor> 要素の TimeoutSecs パラメータに設定された値をオーバーライドする。 詳細については、jsp-descriptorを参照。 |
mime-mapping 要素では、拡張子と MIME タイプの間のマッピングを定義します。
次の表では、mime-mapping 要素内で定義できる要素について説明します。
省略可能な welcome-file-list 要素では、welcome-file 要素の順序付きリストを指定します。
URL 要求がディレクトリ名の場合、この要素で指定された最初のファイルが WebLogic Server によって返されます。そのファイルが見つからない場合は、WebLogic Server によってリスト内の次のファイルが返されます。
詳細については、ウェルカム ページのコンフィグレーションと「WebLogic Server による HTTP リクエストの解決方法」を参照してください。
次の表では、welcome-file-list 要素内で定義できる要素について説明します。
省略可能な error-page 要素では、エラーコードや例外のタイプと Web アプリケーションにあるリソースのパスの間のマッピングを指定します。
WebLogic Server が HTTP リクエストに応答しているときにエラーが発生した場合や、Java 例外の結果としてエラーが発生した場合は、WebLogic Server によって HTTP エラー コードまたは Java エラー メッセージのいずれかを表示する HTML ページが返されます。独自の HTML ページを定義して、これらのデフォルトのエラー ページの代わりとして、または Java 例外の応答ページとして表示することができます。
詳細については、HTTP エラー応答のカスタマイズと「WebLogic Server による HTTP リクエストの解決方法」を参照してください。
次の表では、error-page 要素内で定義できる要素について説明します。
注意: <error-code> と <exception-type> のどちらかを定義します。両方は定義しないでください。
省略可能な taglib 要素では、JSP タグ ライブラリを記述します。
JSP タグ ライブラリ記述子 (TLD) の位置を URI パターンに関連付けます。TLD は、WEB-INF ディレクトリを基準にした相対位置にある JSP 内に指定できますが、Web アプリケーションをデプロイするときに、<taglib> タグを使用して TLD をコンフィグレーションすることもできます。TLD ごとに別個の要素を使用します。
次の表では、taglib 要素内で定義できる要素について説明します。
resource-env-ref 要素には、Web アプリケーションの環境内のリソースに関連付けられた管理対象オブジェクトに対する Web アプリケーションの参照の宣言が含まれます。省略可能な説明、リソース環境参照名、Web アプリケーション コードが予期するリソース環境参照のタイプで構成されます。
<resource-env-ref>
<resource-env-ref-name>jms/StockQueue</resource-env-ref-name>
<resource-env-ref-type>javax.jms.Queue</resource-env-ref-type>
</resource-env-ref>
次の表では、resource-env-ref 要素内で定義できる要素について説明します。
|
リソース環境参照の名前を指定する。値は、Web アプリケーションのコードで使用される環境エントリ名。名前は java:comp/env に対して相対的な JNDI 名で、Web アプリケーション内でユニークでなければならない。 |
||
省略可能な resource-ref 要素では、外部リソースへの参照ルックアップ名を定義します。この定義により、サーブレット コードは、デプロイメント時に実際の位置にマップされる「仮想的な」名前でリソースをルックアップできるようになります。
各外部リソース名の定義には別々の <resource-ref> 要素を使用します。外部リソース名は、デプロイメント時に WebLogic 固有のデプロイメント記述子 weblogic.xml でリソースの実際の位置名にマップされます。
次の表では、resource-ref 要素内で定義できる要素について説明します。
|
JNDI ツリー内で使用されるリソースの名前。Web アプリケーション内のサーブレットはこの名前を使用して、リソースへの参照をルックアップする。 |
||
|
セキュリティのためのリソース サインオンの指定に使用される。 APPLICATION を指定した場合、アプリケーション コンポーネント コードによってプログラムでリソース サインオンが行われる。CONTAINER を指定した場合、WebLogic Server では、login-config 要素で定義されたセキュリティ コンテキストが使用される。 login-configを参照。 |
||
security-constraint 要素では、<web-resource-collection> 要素で定義されたリソースの集合へのアクセス特権を定義します。
詳細については、Web アプリケーションでのセキュリティのコンフィグレーションを参照してください。
次の表では、security-constraint 要素内で定義できる要素について説明します。
|
このセキュリティ制約で定義される Web リソースの集合にアクセスするグループまたはプリンシパルを定義する。auth-constraintも参照。 |
||
各 <security-constraint> 要素では、1 つまたは複数の <web-resource-collection> 要素が必要です。これらの要素では、このセキュリティ制約が適用される Web アプリケーションの領域を定義します。
これは、security-constraint内の要素です。
次の表では、web-resource-collection 要素内で定義できる要素について説明します。
これは、security-constraint内の要素です。
省略可能な auth-constraint 要素では、このセキュリティ制約で定義された Web リソースの集合にアクセスするグループまたはプリンシパルを定義します。
注意: 認可制約 (<auth-constraint> タグで定義) は、認証の要件を確立し、制約されたリクエストの実行が許可される認証ロール (セキュリティ ロール) を指定します。 <auth-constraint> タグを使用して認可制約を定義する場合は、以下の点に注意してください。
認可制約の詳細については、http://jcp.org/aboutJava/communityprocess/final/jsr154/index.html の Java サーブレット仕様バージョン 2.4 を参照してください。
次の表では、auth-constraint 要素内で定義できる要素について説明します。
|
このセキュリティ制約で定義されたリソースにアクセスできるセキュリティ ロールを定義する。セキュリティ ロール名は、security-role-ref を使用してプリンシパルにマップされる。 security-role-refを参照。 |
これは、security-constraint内の要素です。
user-data-constraint 要素では、クライアントによるサーバとの通信方法を定義します。
次の表では、user-data-constraint 要素内で定義できる要素について説明します。
省略可能な login-config 要素を使って、ユーザの認証方法、このアプリケーションで使用されるレルムの名前、およびフォームによるログイン機能で必要になる属性をコンフィグレーションします。
この要素が指定されている場合、ユーザが Web アプリケーション内で定義されている <security-constraint> によって制約されたすべてのリソースにアクセスするには認証を受ける必要があります。認証されると、ユーザは、ほかのリソースにアクセスする権限が与えられる場合もあります。
次の表では、login-config 要素内で定義できる要素について説明します。
|
ユーザの認証に使用する方法を指定する。指定できる値は次のとおり。 BASIC - ブラウザ認証を使用する。 |
||
|
ユーザの資格を認証する場合に参照されるレルムの名前。 省略した場合、Administration Console の [Web ApplicationWeb アプリケーション｜Configurationコンフィグレーション｜Otherその他] タブにある [Auth Realm Name認証レルム名] フィールドで定義されたレルムがデフォルトで使用される。 詳細については、『WebLogic Security の管理』を参照。 注意: <realm-name> 要素は WebLogic Server 内のセキュリティ レルムを参照しません。この要素では HTTP ベーシック認証で使用するレルム名を定義します。 注意: システム セキュリティ レルムは、サーバで何らかの操作が実行されるときにチェックされるセキュリティ情報の集合です。サーブレット セキュリティ レルムは、ページがアクセスされてベーシック認証が使用されるときにチェックされる、セキュリティ情報の別の集合です。 |
||
|
<auth-method> を FORM にコンフィグレーションする場合に、この要素を使用する。 form-login-configを参照。 |
これは、login-config内の要素です。
<auth-method> を FORM にコンフィグレーションする場合に、<form-login-config> 要素を使用します。
|
ユーザを認証する場合に使用される、ドキュメント ルートを基準にした Web リソースの相対的な URI。これは、HTML ページ、JSP、または HTTP サーブレットのいずれかになり、特定の命名規約に従うフォームを表示する HTML ページを返す。 詳細については、Web アプリケーション用の認証の設定を参照。 |
||
|
失敗した認証ログインに応答してユーザに送信される、ドキュメント ルートを基準にした Web リソースの相対的な URI。 |
次の表では、security-role 要素内で定義できる要素について説明します。
|
ロール名。ここで使用する名前は、WebLogic 固有のデプロイメント記述子 weblogic.xml で対応するエントリが必要になる。weblogic.xml によって、ロールはセキュリティ レルムにあるプリンシパルにマップされる。 詳細については、security-role-assignmentを参照。 |
省略可能な env-entry 要素では、アプリケーションの環境エントリを宣言します。環境エントリごとに別個の要素を使用します。
次の表では、env-entry 要素内で定義できる要素について説明します。
省略可能な ejb-ref 要素では、EJB リソースへの参照を定義します。この参照は、WebLogic 固有のデプロイメント記述子ファイル weblogic.xml でマッピングを定義することにより、デプロイメント時に EJB の実際の位置にマップされます。各参照 EJB 名の定義には別々の <ejb-ref> 要素を使用します。
次の表では、ejb-ref 要素内で定義できる要素について説明します。
|
Web アプリケーションで使用される EJB の名前。この名前は、WebLogic 固有のデプロイメント記述子 weblogic.xml で JNDI ツリーにマップされる。 詳細については、ejb-reference-descriptionを参照。 |
||
|
参照される EJB にセキュリティ コンテキストが適用されるセキュリティ ロール。<security-role> 要素で定義されたセキュリティ ロールである必要がある。 |
ejb-local-ref 要素は、エンタープライズ Bean のローカル ホームへの参照の宣言に使用されます。この宣言は以下のもので構成されます。
次の表では、ejb-local-ref 要素内で定義できる要素について説明します。
|
|
|
|
||
 |
|
|
 |
 |
 |
|
||
