A web.xmlデプロイメント記述子の要素

WebLogic Serverにおける標準のJava EEデプロイメント記述子の要素について説明します。

Java EEアノテーションの使用により、標準のweb.xmlデプロイメント記述子は省略可能になりました。サーブレット3.1仕様(http://jcp.org/en/jsr/detail?id=340)によると、サーブレット、フィルタ、リスナー、タグ・ハンドラなどの特定のWebコンポーネントでアノテーションを定義できます。アノテーションを使用すると、外部リソースに対する依存関係を宣言できます。「Webコンポーネント用のWebLogicアノテーション」を参照してください。

この付録の内容は次のとおりです。

web.xmlのネームスペース宣言とスキーマの場所

web.xmlファイルのネームスペース宣言とスキーマの場所を表す正確なテキストは次のとおりです。

<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd" 
id="WebApp_ID" version="3.0">

web.xmlのスキーマについては、http://www.oracle.com/webfolder/technetwork/jsc/xml/ns/javaee/web-app_3_0.xsdを参照してください。

context-param

context-param要素には、Webアプリケーションのサーブレット・コンテキストの初期化パラメータの宣言が含まれます。

表A-1 context-parameter要素

要素必須/省略可能説明

要素	必須/省略可能	説明
weblogic.httpd. clientCertProxy	省略可能	この属性は、プロキシ・プラグインまたは`HttpClusterServlet`によって送信される特別な`WL-Proxy-Client-Cert`ヘッダーに、Webアプリケーションのクライアントからの証明書を含めることを指定します。この設定は、ユーザー認証がプロキシ・サーバーで実行される場合に役立ちます。`clientCertProxy`を設定すると、プロキシ・サーバーにより`WL-Proxy-Client-Cert`という特別なヘッダーでクラスタに証明書が渡されます。 `WL-Proxy-Client-Cert`ヘッダーは、WebLogic Serverにアクセスする、どのクライアントでも指定できます。WebLogic Serverは、安全なソース(プラグイン)からのものであることを信用してヘッダーの証明書情報を受け取り、その情報を使用してユーザーを認証します。このため、`clientCertProxy`を設定した場合は、接続フィルタを使用して、このプラグインが実行しているマシンからの接続のみをWebLogic Serverが受け入れるようにする必要があります。この属性は、個々のWebアプリケーションに設定するのみでなく、次のように定義することもできます。サーバー・インスタンスを利用するすべてのWebアプリケーションに対して、WebLogic Server管理コンソールの「サーバー」→「構成」→「一般」ページで設定します。クラスタ内のサーバー・インスタンスを利用するすべてのWebアプリケーションに対して、「クラスタ」→「構成」→「一般」ページで設定します。

weblogic.httpd.
clientCertProxy

省略可能

この属性は、プロキシ・プラグインまたはHttpClusterServletによって送信される特別なWL-Proxy-Client-Certヘッダーに、Webアプリケーションのクライアントからの証明書を含めることを指定します。

この設定は、ユーザー認証がプロキシ・サーバーで実行される場合に役立ちます。clientCertProxyを設定すると、プロキシ・サーバーによりWL-Proxy-Client-Certという特別なヘッダーでクラスタに証明書が渡されます。

WL-Proxy-Client-Certヘッダーは、WebLogic Serverにアクセスする、どのクライアントでも指定できます。WebLogic Serverは、安全なソース(プラグイン)からのものであることを信用してヘッダーの証明書情報を受け取り、その情報を使用してユーザーを認証します。

このため、clientCertProxyを設定した場合は、接続フィルタを使用して、このプラグインが実行しているマシンからの接続のみをWebLogic Serverが受け入れるようにする必要があります。

この属性は、個々のWebアプリケーションに設定するのみでなく、次のように定義することもできます。

サーバー・インスタンスを利用するすべてのWebアプリケーションに対して、WebLogic Server管理コンソールの「サーバー」→「構成」→「一般」ページで設定します。クラスタ内のサーバー・インスタンスを利用するすべてのWebアプリケーションに対して、「クラスタ」→「構成」→「一般」ページで設定します。

次の表では、Webアプリケーション・コンテナで使用される予約済のコンテキスト・パラメータについて説明します。これらは非推奨となり、weblogic.xmlでは置き換えられています。

表A-2 非推奨のcontext-param要素

非推奨のパラメータ	説明	weblogic.xmlでの代替要素
weblogic.httpd.inputCharset	Unicode以外の処理でコード・セット動作を定義します。	weblogic.xmlの`input-charset` (charset-param内で定義)。「input-charset」を参照してください。
weblogic.httpd.servlet.reloadCheckSecs	サーブレットが変更されたかどうかをチェックする頻度と、変更されている場合はそれを再ロードするかどうかを定義します。値が -1の場合は再ロードせず、0の場合は常に再ロードします。デフォルトでは1秒に設定されます。	`weblogic.xml`の`servlet-reload-check-secs` (`container-descriptor`内で定義)。auth-filterを参照してください。
weblogic.httpd.servlet.classpath	この値を設定すると、このパスがコンテナによってWebアプリケーションのクラスパスに追加されます。この方法は非推奨で、後方互換性のためのみにサポートされています。	なし。マニフェスト・クラスパス、`WEB-INF/lib`、`WEB-INF/classes`、仮想ディレクトリなどの方法を使用します。
weblogic.httpd.defaultServlet	Webアプリケーションのデフォルト・サーブレットを設定します。これは非推奨方法で、後方互換性のためのみにサポートされています。	なし。`web.xml`の`servlet`要素および`servlet-mapping`要素を使用してデフォルト・サーブレットを定義します。`default-servlet`のURLパターンは"/"。「servlet-mapping」を参照してください。サーブレット・マッピングのその他の例については、「サーブレット・マッピング」を参照してください。

description

省略可能なdescription要素では、Webアプリケーションに関する説明文を示します。

表A-3 description要素

要素	必須/省略可能	説明
<description>	省略可能	この要素は現在、WebLogic Serverでは使用されていません。

display-name

省略可能なdisplay-name要素では、Webアプリケーションの表示名(GUIツールで表示できる短い名前)を指定します。

表A-4 display-name要素

要素	必須/省略可能	説明
<display-name>	省略可能	この要素は現在、WebLogic Serverでは使用されていません。

distributable

distributable要素は、WebLogic Serverでは使用されていません。

表A-5 description要素

要素	必須/省略可能	説明
<distributable>	省略可能	この要素は現在、WebLogic Serverでは使用されていません。

ejb-local-ref

ejb-local-ref要素は、エンタープライズBeanのローカル・ホームへの参照の宣言に使用されます。この宣言は以下のもので構成されます。

省略可能な説明
エンタープライズBeanを参照するWebアプリケーションのコードで使用されるEJB参照名。参照されるエンタープライズBeanの予期されるタイプ
参照されるエンタープライズBeanの予期されるローカル・ホーム・インタフェースとローカル・インタフェース
参照されるエンタープライズBeanの指定に使用するejb-link情報(オプション)

次の表では、ejb-local-ref要素内で定義できる要素について説明します。

表A-6 ejb-local-ref要素

要素	必須/省略可能	説明
<description>	省略可能	参照の説明文。
<ejb-ref-name>	必須	EJB参照の名前を指定します。EJB参照はWebアプリケーションの環境内のエントリで、`java:comp/env`コンテキストに対して相対的。名前はWebアプリケーション内で一意である必要があります。名前の前に`ejb/`を付けることを推奨します。例: <ejb-ref-name>ejb/Payroll</ejb-ref-name>
<ejb-ref-type>	必須	`ejb-ref-type`要素には、参照されるエンタープライズBeanの予期されるタイプが含まれます。`ejb-ref-type`要素は以下のいずれかである必要があります: <ejb-ref-type>Entity</ejb-ref-type> <ejb-ref-type>Session</ejb-ref-type>
<local-home>	必須	エンタープライズBeanのローカル・ホーム・インタフェースの完全修飾名。
<local>	必須	エンタープライズBeanのローカル・インタフェースの完全修飾名。
<ejb-link>	省略可能	`ejb-link`要素は、`ejb-ref`または`ejb-local-ref`要素内で、EJB参照がEJBにリンクされることを示すために使用されます。 `ejb-link`要素内の名前は、パス名で構成されます。このパス名には、参照先のEJBが含まれる`ejb-jar`、`#`、対象Beanの`ejb-name`を順に指定します。パス名は、EJBを参照するWebアプリケーションを含むWARファイルに対して相対的に指定します。このため、同じ`ejb-name`を含む複数のEJBを一意に識別することが可能です。使用される場所: `ejb-local-ref`および`ejb-ref`要素例: <ejb-link>EmployeeRecord</ejb-link> <ejb-link>../products/product.jar#ProductEJB</ejb-link>
<lookup-name>	省略可能	リソース参照を解決するためにルックアップするJNDI名。

ejb-ref

省略可能なejb-ref要素では、EJBリソースへの参照を定義します。この参照は、WebLogic固有のデプロイメント記述子ファイルweblogic.xmlでマッピングを定義することにより、デプロイメント時にEJBの実際の位置にマップされます。各参照EJB名の定義には別々の<ejb-ref>要素を使用します。

次の表では、ejb-ref要素内で定義できる要素について説明します。

表A-7 ejb-ref要素

要素	必須/省略可能	説明
<description>	省略可能	参照の説明文。
<ejb-ref-name>	必須	Webアプリケーションで使用されるEJBの名前。この名前は、WebLogic固有のデプロイメント記述子`weblogic.xml`でJNDIツリーにマップされます。「ejb-reference-description」を参照してください。
<ejb-ref-type>	必須	参照EJBの期待されるJavaクラスのタイプ。
<home>	必須	EJBホーム・インタフェースの完全修飾クラス名。
<remote>	必須	EJBリモート・インタフェースの完全修飾クラス名。
<ejb-link>	省略可能	含まれているJava EEアプリケーション・パッケージでのEJBの`<ejb-name>`。
<run-as>	省略可能	参照されるEJBにセキュリティ・コンテキストが適用されるセキュリティ・ロール。`<security-role>`要素で定義されたセキュリティ・ロールである必要があります。
<lookup-name>	省略可能	リソース参照を解決するためにルックアップするJNDI名。

env-entry

省略可能なenv-entry要素では、アプリケーションの環境エントリを宣言します。環境エントリごとに別個の要素を使用します。

次の表では、env-entry要素内で定義できる要素について説明します。

表A-8 env-entry要素

要素	必須/省略可能	説明
<description>	省略可能	説明文。
<env-entry-name>	必須	環境エントリの名前。
<env-entry-value>	必須	環境エントリの値。
<env-entry-type>	必須	環境エントリの型。次のJavaクラスのタイプからいずれか1つを選択できます。 java.lang.Boolean java.lang.String java.lang.Integer java.lang.Double java.lang.Float
<lookup-name>	省略可能	リソース参照を解決するためにルックアップするJNDI名。

error-page

省略可能なerror-page要素では、エラー・コードや例外のタイプとWebアプリケーションにあるリソースのパスの間のマッピングを指定します。

WebLogic ServerがHTTPリクエストに応答しているときにエラーが発生した場合や、Java例外の結果としてエラーが発生した場合は、WebLogic ServerによってHTTPエラー・コードまたはJavaエラー・メッセージのいずれかを表示するHTMLページが返されます。独自のHTMLページを定義して、これらのデフォルトのエラー・ページの代わりとして、またはJava例外のレスポンス・ページとして表示することができます。

「HTTPエラー・レスポンスのカスタマイズ」を参照してください。

次の表では、error-page要素内で定義できる要素について説明します。

注意:

<error-code>と<exception-type>のどちらかを定義します。両方は定義しないでください。

表A-9 error-page要素

要素	必須/省略可能	説明
<error-code>	省略可能	有効なHTTPエラー・コード(例: `404`)。
<exception-type>	省略可能	Java例外の完全修飾クラス名(例: `java.lang.string`)。
<location>	必須	エラーに応答して表示されるリソースの位置たとえば、`/myErrorPg.html`です。

filter

filter要素は、フィルタ・クラスとその初期化属性を定義します。フィルタの詳細は、「フィルタの構成」を参照してください。

次の表では、filter要素内で定義できる要素について説明します。

表A-10 filter要素

要素	必須/省略可能	説明
<icon>	省略可能	GUIツールでフィルタを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Webアプリケーション内での位置を指定します。small-icon要素とlarge-icon要素があります。この要素は現在、WebLogic Serverでは使用されていません。
<filter-name>	必須	フィルタの名前を定義します。この名前は、デプロイメント記述子内のほかの場所でそのフィルタ定義を参照する場合に使用されます。
<display-name>	省略可能	GUIツールによって表示されることを想定した短い名前。
<description>	省略可能	フィルタの説明文。
<filter-class>	必須	フィルタの完全修飾クラス名。
<init-param>	省略可能	フィルタの初期化属性の名前と値の組み合わせを指定します。属性ごとに`<init-param>`タグの別個のセットを使用します。

filter-mapping

次の表では、filter-mapping要素内で定義できる要素について説明します。

表A-11 filter-mapping要素

要素	必須/省略可能	説明
<dispatcher>	省略可能	フィルタがリクエスト・ディスパッチャ`forward()`および`include()`コールの下で起動される必要があるかどうかを示します。`<dispatcher>`要素を使用してfilter-mappingに対し、フィルタが様々なタイプのリクエストに適用されるかどうかを示すことができます。使用可能な値は次のとおりです。 `REQUEST` `FORWARD` `INCLUDE` `ERROR` `ASYNC` `<dispatcher>`要素がない場合は、リクエストがクライアントから直接来た場合にフィルタが適用されます。サーブレット3.1仕様(`https://jcp.org/en/jsr/detail?id=340`)のフィルタおよびRequestDispatcherに関する項を参照してください。
<filter-name>	必須	URLパターンまたはサーブレットのマッピング先のフィルタの名前。この名前は、`<filter-name>`要素で`<filter>`要素に割り当てられている名前に対応します。
<servlet>	必須 - または`<url-pattern>`によってマップされる	呼び出された場合に、このフィルタを実行するサーブレットの名前。
<url-pattern>	必須 - または`<servlet>`によってマップされる	URLを解決する場合に使用されるパターンを記述します。`http://host:port` (「host」はホスト名、「port」はポート番号) + `ContextPath`に続くURLの部分は、WebLogic Serverによって`<url-pattern>` と比較されます。パターンが一致すれば、この要素でマップされているフィルタが呼び出されます。サンプル・パターンを次に示します。 /soda/grape/* /foo/* /contents *.foo URLは、サーブレット3.1仕様で指定されているルールに準拠している必要があります。

icon

icon要素では、GUIツールでWebアプリケーションを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Webアプリケーション内での位置を指定します(servlet要素にもiconという要素があり、GUIツール内でサーブレットを表すアイコンを提供するために使用されます。)

次の表では、icon要素内で定義できる要素について説明します。

表A-12 Icon要素

要素	必須/省略可能	説明
<small-icon>	省略可能	GUIツールでWebアプリケーションを表すために使用される、小さい(16x16ピクセル) `.gif`画像または`.jpg`画像の位置。この要素は現在、WebLogic Serverでは使用されていません。
<large-icon>	省略可能	GUIツールでWebアプリケーションを表すために使用される、、大きい(32x32ピクセル) `.gif`画像または`.jpg`画像の位置。この要素は現在、WebLogic Serverでは使用されていません。

jsp-config

jsp-config要素は、Webアプリケーション内のJSPファイルのグローバル構成情報を提供するために使用します。2つの下位要素taglibおよびjsp-property-groupがあります。

次の表では、jsp-config要素内で定義できる要素について説明します。

表A-13 jsp-config要素

要素	必須/省略可能	説明
<taglib>	省略可能	Webアプリケーション内のJSPページで使用するタグ・ライブラリに関する情報を提供します。
<jsp-property-group>	省略可能	複数のファイルをグループ化して、それらのファイルにグローバル・プロパティ情報を提供できるようにします。このように記述されたすべてのファイルはJSPファイルと見なされます。

taglib

これは、jsp-config内の要素です。

taglibは必須の要素で、Webアプリケーション内のJSPページで使用するタグ・ライブラリに関する情報を提供するために使用します。

JSPタグ・ライブラリ記述子(TLD)の位置をURIパターンに関連付けます。TLDは、WEB-INFディレクトリを基準にした相対位置にあるJSP内に指定できますが、Webアプリケーションをデプロイするときに、<taglib>タグを使用してTLDを構成することもできます。TLDごとに別個の要素を使用します。

次の表では、taglib要素内で定義できる要素について説明します。

表A-14 taglib要素

要素必須/省略可能説明

要素	必須/省略可能	説明
<taglib-location>	省略可能	Webアプリケーションのルートを基準にしたタグ・ライブラリ記述子の相対ファイル名を指定します。タグ・ライブラリ記述子ファイルを`WEB-INF`ディレクトリの下に格納して、HTTPリクエストを通じて外部から入手できないようにするとよいでしょう。
<taglib-uri>	省略可能	`web.xml`ドキュメントの位置を基準にした相対位置にあるURIを指定します。このURIによって、Webアプリケーションで使用されるタグ・ライブラリが識別されます。 URIがJSPページのtaglibディレクティブで使用されているURI文字列と一致する場合、このタグ・ライブラリが使用されます。

<taglib-location>

省略可能

Webアプリケーションのルートを基準にしたタグ・ライブラリ記述子の相対ファイル名を指定します。タグ・ライブラリ記述子ファイルをWEB-INFディレクトリの下に格納して、HTTPリクエストを通じて外部から入手できないようにするとよいでしょう。

<taglib-uri>

省略可能

web.xmlドキュメントの位置を基準にした相対位置にあるURIを指定します。このURIによって、Webアプリケーションで使用されるタグ・ライブラリが識別されます。

URIがJSPページのtaglibディレクティブで使用されているURI文字列と一致する場合、このタグ・ライブラリが使用されます。

jsp-property-group

これは、jsp-config内の要素です。

jsp-property-groupは必須の要素で、複数のファイルをグループ化して、それらのファイルにグローバル・プロパティ情報を提供できるようにするために使用します。このように記述されたすべてのファイルはJSPファイルと見なされます。

次の表で、jsp-property-group要素内に定義できる要素について説明します。

表A-15 jsp-property-group要素

要素	必須/省略可能	説明
<el-ignored>	省略可能	ELを無視するかどうかを制御します。ELの評価は、サーブレット2.4以降の`web.xml`を使用するWebアプリケーションではデフォルトで有効になっており、それ以外の場合は無効になっています。
<scripting-invalid>	省略可能	JSPページのグループで、スクリプト記述要素を無効にするかどうかを制御します。スクリプト記述は、デフォルトでは有効になっています。
<page-encoding>	省略可能	pageEncoding情報を示します。JSPページのページ・ディレクティブのpageEncoding属性と、そのページに一致するJSP構成要素との間で、エンコーディングが異なることを示す変換時エラー。XML構文内のドキュメントのプロログまたはテキスト宣言と、そのドキュメントに一致するJSP構成要素との間で、エンコーディングが異なることを示す場合もあります。複数のメカニズムに同じエンコーディングを指定しても構いません。
<is-xml>	省略可能	リソースがJSPドキュメント(XML)であることを示します。trueの場合は、URLパターンが一致するリソースのグループがJSPドキュメントで、XMLドキュメントとして解釈する必要があることを示します。falseの場合は、リソースがJSPドキュメントであることを示す他のプロパティ・グループがない限り、JSPドキュメントではないと見なされます。
<include-prelude>	省略可能	Webアプリケーション内の要素に対応している必要があるコンテキスト相対パス。この要素が存在する場合、指定されたパスが、このjsp-property-group内の各JSPページの最初に自動的に(includeディレクティブの場合のように)含まれます。
<include-coda>	省略可能	Webアプリケーション内の要素に対応している必要があるコンテキスト相対パス。この要素が存在する場合、指定されたパスが、この`jsp-property-group`内の各JSPページの最後に自動的に(includeディレクティブの場合のように)インクルードされます。
<deferred-syntax-allowed-as-literal>	省略可能	文字シーケンス`#{`を文字列リテラルとして使用できるどうかを制御します。
<trim-directive-whitespaces>	省略可能	ホワイト・スペースのみを含むテンプレート・テキストを、レスポンス出力から削除しなければならないかどうかを制御します。
<url-pattern>	必須	URLを解決する場合に使用されるパターンを記述します。`http://host:port` (「host」はホスト名、「port」はポート番号) + `ContextPath`に続くURLの部分は、WebLogic Serverによって`<url-pattern>` と比較されます。サンプル・パターンを次に示します。 /soda/grape/* /foo/* /contents *.foo URLは、サーブレット3.1仕様で指定されているルールに準拠している必要があります。
default-content-type	省略可能	デフォルトの`contentType`プロパティを指定します。有効な値は、`contentType`ページ・ディレクティブの値です。ページ・ディレクティブに`contentType`属性が含まれていない場合、デフォルトのレスポンス`contentType`が指定されます。
buffer	省略可能	`JspWriter`のデフォルトのバッファリング・モデルを指定します。有効な値は、ページ・ディレクティブのバッファ属性の値です。レスポンスへの出力にバッファリングを使用するかどうかを指定します。バッファリングを使用する場合は、使用するバッファ・サイズを指定します。
error-on-undeclared-namespace	省略可能	JSPドキュメント内に未宣言のタグが使用されている場合にエラーを発生させるかどうかを制御します。 trueに設定した場合、JSPドキュメントで未宣言のタグが使用されていれば、変換時にエラーを発生させる必要があります。デフォルトでは無効(false)になっています。

listener

listener要素を使用するアプリケーション・リスナーを定義します。

表A-16 listener要素

要素	必須/省略可能	説明
<listener-class>	省略可能	Webアプリケーション・イベントに応答するクラスの名前。

「イベント・リスナー・クラスの構成」を参照してください。

login-config

省略可能なlogin-config要素を使って、ユーザーの認証方法、このアプリケーションで使用されるレルムの名前、およびフォームによるログイン機能で必要になる属性を構成します。

この要素が指定されている場合、ユーザーがWebアプリケーション内で定義されている<security-constraint>によって制約されたすべてのリソースにアクセスするには、認証を受ける必要があります。認証されると、ユーザーは、ほかのリソースにアクセスする権限が与えられる場合もあります。

次の表では、login-config要素内で定義できる要素について説明します。

表A-17 config

要素必須/省略可能説明

要素	必須/省略可能	説明
<auth-method>	省略可能	ユーザーの認証に使用する方法を指定します。指定できる値は次のとおりです。 `BASIC` - ブラウザ認証を使用します。(これがデフォルト値です。) `FORM` - ユーザーが作成したHTMLフォームを使用します。 `CLIENT-CERT` フォールバック・メカニズムを提供するために、複数の認証方法をカンマ区切りのリストとして定義できます。認証は、auth-methodで値が定義されている順序で試行されます。『WebLogicセキュリティ・サービスによるアプリケーションの開発』の認証方式に対するフォールバック・メカニズムの提供に関する項を参照してください。
<realm-name>	省略可能	ユーザーの資格証明を認証する場合に参照されるレルムの名前。省略した場合、WebLogic Server管理コンソールの「Webアプリケーション」→「構成」→「その他」タブにある「認証レルム名」フィールドで定義されたレルムがデフォルトで使用されます。 `<realm-name>`要素はWebLogic Server内のシステム・セキュリティ・レルムを参照しません。この要素ではHTTPベーシック認証で使用するレルム名を定義します。システム・セキュリティ・レルムは、サーバーでなんらかの操作が実行されるときにチェックされるセキュリティ情報の集合。サーブレット・セキュリティ・レルムは、ページがアクセスされてベーシック認証が使用されるときにチェックされる、セキュリティ情報の別の集合。
<form-login- config>	省略可能	`<auth-method>`を`FORM`に構成する場合に、この要素を使用します。「form-login-config」を参照してください。

<auth-method>

省略可能

ユーザーの認証に使用する方法を指定します。指定できる値は次のとおりです。

BASIC - ブラウザ認証を使用します。(これがデフォルト値です。)

FORM - ユーザーが作成したHTMLフォームを使用します。

CLIENT-CERT

フォールバック・メカニズムを提供するために、複数の認証方法をカンマ区切りのリストとして定義できます。認証は、auth-methodで値が定義されている順序で試行されます。『WebLogicセキュリティ・サービスによるアプリケーションの開発』の認証方式に対するフォールバック・メカニズムの提供に関する項を参照してください。

<realm-name>

省略可能

ユーザーの資格証明を認証する場合に参照されるレルムの名前。省略した場合、WebLogic Server管理コンソールの「Webアプリケーション」→「構成」→「その他」タブにある「認証レルム名」フィールドで定義されたレルムがデフォルトで使用されます。

<realm-name>要素はWebLogic Server内のシステム・セキュリティ・レルムを参照しません。この要素ではHTTPベーシック認証で使用するレルム名を定義します。システム・セキュリティ・レルムは、サーバーでなんらかの操作が実行されるときにチェックされるセキュリティ情報の集合。サーブレット・セキュリティ・レルムは、ページがアクセスされてベーシック認証が使用されるときにチェックされる、セキュリティ情報の別の集合。

<form-login-
config>

省略可能

<auth-method>をFORMに構成する場合に、この要素を使用します。「form-login-config」を参照してください。

form-login-config

これは、login-config内の要素です。

<auth-method>をFORMに構成する場合に、<form-login-config>要素を使用します。

表A-18 form-login-config要素

要素	必須/省略可能	説明
<form-login-page>	必須	ユーザーを認証する場合に使用される、ドキュメント・ルートを基準にしたWebリソースの相対的なURI。これは、HTMLページ、JSP、またはHTTPサーブレットのいずれかになり、特定のネーミング・ルールに従う`FORM`ベースの認証を表示するHTMLページを戻します。
<form-error-page>	必須	失敗した認証ログインに応答してユーザーに送信される、ドキュメント・ルートを基準にしたWebリソースの相対的なURI。

message-destination-ref

message-destination-ref要素(省略可能)は、リソースに関連付けられたメッセージ宛先への参照を指定します。この要素で記述された論理宛先は、デプロイメント記述子内の物理宛先にマップされます。

次の表では、message-destination-ref要素内で定義できる要素について説明します。

表A-19 message-destination-ref要素

要素	必須/省略可能	説明
description	省略可能	メッセージ宛先参照の説明を入力します。
message-destination-name	必須	メッセージ宛先の名前を指定します。この名前は、デプロイメント記述子内のメッセージ宛先名にわたって一意である必要があります。
mapped-name	省略可能	このメッセージ宛先を論理名にマップします。
lookup-name	省略可能	メッセージ宛先を解決するためにルックアップするJNDI名。
message-destination-type	必須	宛先のタイプを指定します。このタイプは、宛先での実装が想定されるJavaインタフェースで指定します。インジェクション・ターゲットが指定されていない場合は、これを指定する必要があります。インジェクション・ターゲットが指定されていれば、そのターゲットのタイプが使用されます。両方とも指定した場合、このタイプはインジェクション・ターゲットのタイプの割当てと矛盾していない必要があります。
message-destination-usage	省略可能	参照で示されたメッセージ宛先の使用を指定します。この値は、メッセージをメッセージ宛先から消費するか、宛先に対して生成するか、またはその両方を行うことを指定します。有効な値は次のいずれかです。 `Consumes` `Produces` `ConsumesProduces` 値を指定しない場合は、`ConsumesProduces`が指定されたものとみなされます。
message-destination-link	省略可能	メッセージ宛先参照またはメッセージドリブンBeanをメッセージ宛先にリンクします。

mime-mapping

mime-mapping要素では、拡張子とMIMEタイプの間のマッピングを定義します。

次の表では、mime-mapping要素内で定義できる要素について説明します。

表A-20 mime-mapping要素

要素	必須/省略可能	説明
<extension>	必須	拡張子を記述する文字列(例: `txt`)。
<mime-type>	必須	定義されているMIMEタイプを記述する文字列(例: `text/plain`)。

resource-env-ref

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要素内で定義できる要素について説明します。

表A-21 resource-env-ref

要素	必須/省略可能	説明
<description>	省略可能	リソース環境参照の説明を指定します。
<resource-env-ref-name>	必須	リソース環境参照の名前を指定します; 値は、Webアプリケーションのコードで使用される環境エントリ名です。名前は`java:comp/env`に対して相対的なJNDI名で、Webアプリケーション内で一意でなければなりません。
<resource-env-ref-type>	必須	リソース環境参照のタイプを指定します。Java言語のクラスまたはインタフェースの完全修飾名。
<lookup-name>	省略可能	リソース参照を解決するためにルックアップするJNDI名。

resource-ref

省略可能なresource-ref要素では、外部リソースへの参照ルックアップ名を定義します。この定義により、サーブレット・コードは、デプロイメント時に実際の位置にマップされる「仮想的な」名前でリソースをルックアップできるようになります。

各外部リソース名の定義には別々の<resource-ref>要素を使用します。外部リソース名は、デプロイメント時にWebLogic固有のデプロイメント記述子weblogic.xmlでリソースの実際の位置名にマップされます。

次の表では、resource-ref要素内で定義できる要素について説明します。

表A-22 resource-ref要素

要素	必須/省略可能	説明
<description>	省略可能	説明文。
<res-ref-name>	必須	JNDIツリー内で使用されるリソースの名前。Webアプリケーション内のサーブレットはこの名前を使用して、リソースへの参照をルックアップします。
<res-type>	必須	参照名に対応するリソースのJavaクラスのタイプ。Javaの完全パッケージ名を使用します。
<res-auth>	必須	セキュリティのためのリソース・サインオンの指定に使用されます。 `APPLICATION`を指定した場合、アプリケーション・コンポーネント・コードによってプログラムでリソース・サインオンが行われます。`Container`を指定した場合、WebLogic Serverでは、`login-config`要素で定義されたセキュリティ・コンテキストが使用されます。「login-config」を参照してください。
<res-sharing-scope>	省略可能	指定されたリソース・マネージャ接続ファクトリ参照を経由して取得された接続を共有するかどうかを指定します。有効な値: Shareable Unshareable
<lookup-name>	省略可能	リソース参照を解決するためにルックアップするJNDI名。

security-constraint

security-constraint要素では、<web-resource-collection>要素で定義されたリソースの集合へのアクセス権限を定義します。

Webアプリケーションのセキュリティ構成の詳細な手順や例は、『Oracle WebLogic Serverロールおよびポリシーによるリソースの保護』を参照してください。また、WebLogicセキュリティの詳細は、『WebLogicセキュリティ・サービスによるアプリケーションの開発』を参照してください。

次の表では、security-constraint要素内で定義できる要素について説明します。

表A-23 security-constraint要素

要素	必須/省略可能	説明
<web-resource- collection>	必須	このセキュリティ制約が適用されるWebアプリケーションのコンポーネントを定義します。
<auth-constraint>	省略可能	このセキュリティ制約で定義されるWebリソースの集合にアクセスするグループまたはプリンシパルを定義します。「auth-constraint」を参照してください。
<user-data- constraint>	省略可能	クライアントによるサーバーとの通信方法を定義します。「user-data-constraint」も参照してください。

要素

必須/省略可能

説明

<web-resource-
collection>

必須

このセキュリティ制約が適用されるWebアプリケーションのコンポーネントを定義します。

<auth-constraint>

省略可能

このセキュリティ制約で定義されるWebリソースの集合にアクセスするグループまたはプリンシパルを定義します。「auth-constraint」を参照してください。

<user-data-
constraint>

省略可能

クライアントによるサーバーとの通信方法を定義します。

「user-data-constraint」も参照してください。

web-resource-collection

各<security-constraint>要素では、1つまたは複数の<web-resource-collection>要素が必要です。これらの要素では、このセキュリティ制約が適用されるWebアプリケーションの領域を定義します。

これは、security-constraint内の要素です。

次の表では、web-resource-collection要素内で定義できる要素について説明します。

表A-24 web-resource-collection要素

要素	必須/省略可能	説明
<web-resource- name>	必須	Webリソースの集合の名前。
<description>	省略可能	このセキュリティ制約の説明文。
<url-pattern>	省略可能	`<url-pattern>`要素を1つまたは複数使用して、このセキュリティ制約の適用先となるURLパターンを宣言します。この要素を1つも使用しない場合、この`<web-resource-collection>`はWebLogic Serverから無視されます。
<http-method>	省略可能	`<http-method>`要素を1つまたは複数使用して、認可制約の対象になるHTTPメソッド(通常は`GET`または`POST`)を宣言します。`<http-method>`要素を省略した場合には、デフォルトの動作として、セキュリティ制約がすべてのHTTPメソッドに適用されます。

auth-constraint

これは、security-constraint内の要素です。

省略可能なauth-constraint要素では、このセキュリティ制約で定義されたWebリソースの集合にアクセスするグループまたはプリンシパルを定義します。

次の表では、auth-constraint要素内で定義できる要素について説明します。

表A-25 auth-constraint要素

要素	必須/省略可能	説明
<description>	省略可能	このセキュリティ制約の説明文。
<role-name>	省略可能	このsecurity-constraintで定義されたリソースにアクセスできるセキュリティ・ロールを定義します。セキュリティ・ロール名は、security-role-refを使用してプリンシパルにマップされます。

user-data-constraint

これは、security-constraint内の要素です。

user-data-constraint要素では、クライアントによるサーバーとの通信方法を定義します。

次の表では、user-data-constraint要素内で定義できる要素について説明します。

表A-26 user-data-constraint要素

要素必須/省略可能説明

<description>

省略可能

説明文。

<transport-
guarantee>

必須

クライアントとサーバーの間の通信方法を指定します。

INTEGRALまたはCONFIDENTIALのトランスポート保証を使用してユーザーが認証を受けた場合、WebLogic ServerはSecure Sockets Layer (SSL)接続を確立します。

指定できる値:

NONE - トランスポートの保証が不要な場合に指定します。

INTEGRAL - クライアントとサーバーの間で、転送中にデータが変更されない方法でデータを転送する必要がある場合に指定します。

CONFIDENTIAL - 転送中にデータの中味を覗かれないようにデータを転送する必要がある場合に指定します。

security-role

次の表では、security-role要素内で定義できる要素について説明します。

表A-27 security-role要素

要素	必須/省略可能	説明
<description>	省略可能	セキュリティ・ロールの説明文。
<role-name>	必須	ロール名。ここで使用する名前は、WebLogic固有のデプロイメント記述子`weblogic.xml`で対応するエントリが必要になる。weblogic.xmlによって、ロールはセキュリティ・レルムにあるプリンシパルにマップされる。「security-role-assignment」を参照してください。

servlet

servlet要素では、サーブレットの宣言的なデータを指定します。

jsp-file要素および<load-on-startup>要素が指定されている場合、そのJSPは、WebLogic Serverの起動時にあらかじめコンパイルされ、ロードされます。

次の表では、servlet要素内で定義できる要素について説明します。

表A-28 servlet要素

要素	必須/省略可能	説明
<icon>	省略可能	GUIツールでサーブレットを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Webアプリケーション内での位置。small-icon要素とlarge-icon要素があります。この要素は現在、WebLogic Serverでは使用されていません。
<servlet-name>	必須	サーブレットの標準名を定義します。この名前は、デプロイメント記述子内の他の場所でそのサーブレット定義を参照する場合に使用されます。
<display-name>	省略可能	GUIツールによって表示されることを想定した短い名前。
<description>	省略可能	サーブレットの説明文。
<servlet-class>	省略可能	サーブレットの完全修飾クラス名。サーブレット3.1以降、`<servlet-class>`および`<jsp-file>`は省略可能です。`<servlet-class>`および`<jsp-file>`のないサーブレット構成は仮の構成とみなされるため、プログラムによるサーブレットAPIを使用して、サーブレットを動的に登録する必要があります。そうしない場合、デプロイメントは失敗します。
<jsp-file>	省略可能	Webアプリケーションのルート・ディレクトリを基準にした、Webアプリケーション内のJSPファイルへのフルパス。サーブレット3.1以降、`<servlet-class>`および`<jsp-file>`は省略可能です。`<servlet-class>`および`<jsp-file>`のないサーブレット構成は仮の構成とみなされるため、プログラムによるサーブレットAPIを使用して、サーブレットを動的に登録する必要があります。そうしない場合、デプロイメントは失敗します。
<init-param>	省略可能	サーブレットの初期化属性の名前と値の組み合わせを指定します。属性ごとに`<init-param>`タグの別個のセットを使用します。
<load-on-startup>	省略可能	この要素が指定されたサーブレットは、WebLogic Serverの起動時にWebLogic Serverによって初期化されます。この要素の省略可能なコンテンツは、サーブレットがロードされる順序を示す正の整数です。整数の小さい方から順にロードされます。値の指定がない、または値が正の整数でない場合は、WebLogic Serverによって、アプリケーションの起動時にある任意の順序でサーブレットがロードされます。
<run-as>	省略可能	Webアプリケーションの実行に使用するrun-as IDを指定します。この要素には、省略可能な説明とセキュリティ・ロールの名前が含まれます。
<security-role- ref>	省略可能	`<security-role>`で定義されたセキュリティ・ロール名を、サーブレットのロジックでハード・コード化される代替ロール名にリンクする場合に使用されます。この特別な抽象化レイヤーによって、サーブレット・コードを変更しなくてもデプロイメント時にサーブレットを構成できるようになります。

icon

これは、servlet内の要素です。

icon要素では、GUIツールでWebアプリケーションを表示する場合に使用される画像(小さいアイコンと大きいアイコン)の、Webアプリケーション内での位置を指定します。

次の表では、icon要素内で定義できる要素について説明します。

表A-29 icon要素

要素必須/省略可能説明

要素	必須/省略可能	説明
<small-icon>	省略可能	GUIツールでサーブレットを表すために使用される、小さい(16x16ピクセル) `.gif`画像または`.jpg`画像のWebアプリケーション内での位置を指定します。この要素は現在、WebLogic Serverでは使用されていません。
<large-icon>	省略可能	GUIツールでサーブレットを表すために使用される、大きい(32x32ピクセル) `.gif`画像または`.jpg`画像のWebアプリケーション内での位置を指定します。この要素は現在、WebLogic Serverでは使用されていません。

<small-icon>

省略可能

GUIツールでサーブレットを表すために使用される、小さい(16x16ピクセル) .gif画像または.jpg画像のWebアプリケーション内での位置を指定します。

この要素は現在、WebLogic Serverでは使用されていません。

<large-icon>

省略可能

GUIツールでサーブレットを表すために使用される、大きい(32x32ピクセル) .gif画像または.jpg画像のWebアプリケーション内での位置を指定します。

この要素は現在、WebLogic Serverでは使用されていません。

init-param

これは、servlet内の要素です。

省略可能なinit-param要素では、サーブレットの初期化属性の名前と値の組み合わせを指定します。属性ごとにinit-paramタグの別個のセットを使用します。

javax.servlet.ServletConfig.getInitParameter()メソッドを使用して、これらの属性にアクセスできます。

次の表では、init-param要素内で定義できる要素について説明します。

表A-30 init-param要素

要素	必須/省略可能	説明
<param-name>	必須	この属性の名前を定義します。
<param-value>	必須	この属性の`String`値を定義します。
<description>	省略可能	初期化属性の説明文。

security-role-ref

これは、servlet内の要素です。

security-role-ref要素は、<security-role>で定義されたセキュリティ・ロール名を、サーブレットのロジックでハード・コード化される代替ロール名にリンクします。この特別な抽象化レイヤーによって、サーブレット・コードを変更しなくてもデプロイメント時にサーブレットを構成できるようになります。

次の表では、security-role-ref要素内で定義できる要素について説明します。

表A-31 security-role-ref要素

要素	必須/省略可能	説明
<description>	省略可能	ロールの説明文。
<role-name>	必須	サーブレット・コード内で使用されるセキュリティ・ロールまたはプリンシパルの名前を定義します。
<role-link>	必須	後にデプロイメント記述子内の`<security-role>`要素で定義されるセキュリティ・ロールの名前を定義します。

servlet-mapping

servlet-mapping要素では、サーブレットとURLパターンの間のマッピングを定義します。

次の表では、servlet-mapping要素内で定義できる要素について説明します。

表A-32 servlet-mapping要素

要素必須/省略可能説明

要素	必須/省略可能	説明
<servlet-name>	必須	URLパターンのマッピング先のサーブレットの名前。この名前は、`<servlet>`宣言タグでサーブレットに割り当てた名前に対応します。
<url-pattern>	必須	URLを解決する場合に使用されるパターンを記述します。`http://host:port` (「host」はホスト名、「port」はポート番号) + `WebAppName`に続くURLの部分は、WebLogic Serverによって`<url-pattern>`と比較されます。パターンが一致すれば、この要素でマップされているサーブレットが呼び出されます。サンプル・パターンを次に示します。 /soda/grape/* /foo/* /contents *.foo URLは、サーブレット3.1仕様で指定されているルールに準拠している必要があります。サーブレット・マッピングのその他の例については、「サーブレット・マッピング」を参照してください。

<servlet-name>

必須

URLパターンのマッピング先のサーブレットの名前。この名前は、<servlet>宣言タグでサーブレットに割り当てた名前に対応します。

<url-pattern>

必須

URLを解決する場合に使用されるパターンを記述します。http://host:port (「host」はホスト名、「port」はポート番号) + WebAppNameに続くURLの部分は、WebLogic Serverによって<url-pattern>と比較されます。パターンが一致すれば、この要素でマップされているサーブレットが呼び出されます。

サンプル・パターンを次に示します。

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

URLは、サーブレット3.1仕様で指定されているルールに準拠している必要があります。

サーブレット・マッピングのその他の例については、「サーブレット・マッピング」を参照してください。

session-config

session-config要素では、Webアプリケーションのセッション属性を定義します。

次の表では、session-config要素内で定義できる要素について説明します。

表A-33 session-config要素

要素必須/省略可能説明

要素	必須/省略可能	説明
<session-timeout>	省略可能	このWebアプリケーション内のセッションが期限切れになるまでの分数。この要素で設定する値は、次に示す特殊な値のいずれか1つが入力されない限り、WebLogic固有のデプロイメント記述子である`weblogic.xml`の`<session-descriptor>`要素の`TimeoutSecs`属性に設定された値をオーバーライドします。デフォルト値: 60 最大値: Integer.MAX_VALUE/60 特殊な値: -1 = セッションはタイムアウトしません。`weblogic.xml`の`<session-descriptor>`要素に設定された値は無視されます。「session-descriptor」を参照してください。

<session-timeout>

省略可能

このWebアプリケーション内のセッションが期限切れになるまでの分数。この要素で設定する値は、次に示す特殊な値のいずれか1つが入力されない限り、WebLogic固有のデプロイメント記述子であるweblogic.xmlの<session-descriptor>要素のTimeoutSecs属性に設定された値をオーバーライドします。

デフォルト値: 60

最大値: Integer.MAX_VALUE/60

特殊な値:

-1 = セッションはタイムアウトしません。weblogic.xmlの<session-descriptor>要素に設定された値は無視されます。

「session-descriptor」を参照してください。

web-app

サーブレット3.1デプロイメント記述子のXMLスキーマです。WebLogic Serverでは、https://jcp.org/en/jsr/detail?id=340に定義されているように、HTTPサーブレットを完全にサポートしています。しかし、version属性は、3.1の動作を施行するために3.1に設定する必要があります。

次の表では、web-app要素内で定義できる要素について説明します。

表A-34 web-app要素

要素	必須/省略可能	説明
<version>	必須	サーブレット3.1の動作を施行するために、すべてのサーブレット・デプロイメント記述子がスキーマの3.1バージョンを指定している必要があります。

welcome-file-list

省略可能なwelcome-file-list要素では、welcome-file要素の順序付きリストを指定します。

URLリクエストがディレクトリ名の場合、WebLogic Serverは、この要素で指定された最初のファイルを処理します。そのファイルが見つからない場合、サーバーはリスト内の次のファイルを試します。

「ウェルカム・ファイルの構成」を参照してください。

次の表では、welcome-file-list要素内で定義できる要素について説明します。

表A-35 welcome-file-list

要素	必須/省略可能	説明
<welcome-file>	省略可能	デフォルトのウェルカム・ファイルとして使用するファイル名(index.htmlなど)