Oracle Application Server Web Services開発者ガイド 10g(10.1.3.1.0) B31868-01 |
|
oracle-webservices.xml
デプロイメント・ディスクリプタは、標準のwebservices.xml
とともに使用します。OracleAS Web Servicesに固有のデプロイメント情報およびランタイム情報が含まれています。たとえば、コンテキストURIやWebサービス・エンドポイントのアドレスなどが含まれています。このファイルの一部の要素の値は、WebServicesAssemblerのコマンドライン引数およびAntタスクを使用して変更できます。
oracle-webservices.xml
のすべての要素はオプションです。このファイルを指定しなくても、アプリケーションは、未指定の要素に適したデフォルト値を使用してデプロイおよび実行されます。
oracle-webservices.xml
デプロイメント・ディスクリプタには、セキュリティ、信頼性、監査およびロギングに関するWebサービスの管理情報が含まれます。デプロイ時には、このファイルが解析され、そのオブジェクト表現がキャッシュされます。Webサービスの管理情報はこのファイルから抽出され、OC4Jコンテナにwsmgmt.xml
として保存されます。
スキーマを調べてoracle-webservices.xml
を手動で作成することもできますが、通常は、WebServicesAssemblerによって作成されたバージョンのファイルを使用します。このファイルを編集し、必要な機能を生成できます。スキーマはoracle-webservices-10_0.xsd
ファイルで定義されており、oc4j-schemas.jar
ファイルにあります。
OC4J_HOME
\j2ee\home\lib\oc4j-schemas.jar
OC4J_HOME
は、Oracle Containers for J2EE(OC4J)をインストールしたディレクトリです。
関連項目
|
oracle-webservices.xml
ファイルの要素階層の概要を次に示します。
<oracle-webservices> <web-site> <context-root> <webservice-description> <expose-wsdl> <expose-testpage> <resolve-relative-imports> <download-external-imports> <port-component> <endpoint-address-uri> <ejb-transport-security-constraint> <wsdl-url> <soap-port> <role-name> <transport-guarantee> <!-- For a description of transport-level security constraints for EJBs, see "Securing EJB-Based Web Services at the Transport Level" on page C-15. --> <implementor> <param> <runtime> <owsm> <!-- For a description of the Oracle Web Services Manager (<owsm>) element, see the Oracle Web Services Manager Administrators Guide --> <security> <!-- For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide. --> <reliability> <repository> <!-- For a description and listing of port-level reliability elements, see "Port-Level Reliability Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. --> <logging> <operations> <operation> <runtime> <security> <!-- For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide. --> <reliability> <duplication-elimination-required> <guaranteed-delivery-required> <!-- For a listing and description of operation-level reliability elements, see "Operation Level Reliability Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. --> <auditing> <!-- For a listing and description of operation-level auditing elements, see "Server-Side Auditing Configuration Elements" in the Oracle Application Server Advanced Web Services Developers Guide. --> <logging> <!-- For a listing and description of operation-level logging elements, see "Operation Level Logging Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. --> <provider-description> <provider-description-name> <wsdl-file> <wsdl-service-name> <property> <provider-port> <provider-name> <wsdl-port> <expose-testpage> <expose-wsdl> <implementation-class> <servlet-link> <max-request-size> <property> <policy> <runtime> <operations> <operation> <!-- Here you can enter a management configuration for a particular operation --> <ejb-transport-login-config> <auth-method> <realm-name> <!-- For a listing and description of elements that define transport-level security for EJBs, see "Securing EJB-Based Web Services at the Transport Level" on page C-15. -->
ここでは、oracle-webservices.xmlファイルの要素をアルファベット順に説明します。階層については、「oracle-webservices.xmlでのXML要素の階層」を参照してください。サンプル・ファイルについては、「oracle-webservices.xmlファイルのリスト」を参照してください。
なし
オプション
このサブ要素を使用して、EJBアプリケーションの認証メカニズムを構成します。ユーザーに認証制約によって保護されたWebリソースにアクセスするために、構成したメカニズムを使用してユーザーは認証を受ける必要があります。このサブ要素の有効値は、BASIC
、DIGEST
、CLIENT-CERT
またはベンダー固有のシングル・サインオン認証スキームです。「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
なし
バージョン2.1のEJB Webサービスの場合のみ
この要素の値の型はstring
です。デフォルト: .jar
拡張子なしのEJBアーカイブ・ファイル名。
このサブ要素には、公開されるWebサービスのルート・コンテキストを指定します。このサブ要素が必要なのは、Webサービスとして公開されるバージョン2.1のEJBの場合のみです。context-root
を指定しない場合、デフォルトでこの属性は.jar
拡張子なしのEJBアーカイブ・ファイル名に設定されます。たとえば、EJBアーカイブ・ファイル名がfoo-ejb.jar
である場合、コンテキスト・ルートは/foo-ejb
になります。
JavaクラスのWebサービスの場合、コンテキスト・ルートはapplication.xml
内に指定します。
<context-root>
要素の詳細は、『Oracle Containers for J2EE構成および管理ガイド』を参照してください。
なし
オプション
このブール型要素には、相対インポートをダウンロードして絶対URLに解決するかどうかを指定します。デフォルトはfalse
です。
オプション
この要素を使用して、このEJBアプリケーションで使用する必要があるトランスポート・レベルの認証方式およびレルム名を構成します。Webサービスとして公開するEJBアプリケーションのURLは、port componentの<endpoint-address-uri>
要素によって指定します。詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
<role-name>、<soap-port>、<transport-guarantee>、<wsdl-url>
オプション
EJBをベースにしたWebサービスにトランスポート・レベルのセキュリティを定義します。この要素の使用方法の詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
なし
バージョン2.1のEJBに基づくWebサービスの場合のみ
EJB 2.1のWebサービスでのみ必要となるこのサブ要素には、このEJBをWebサービスとして公開する際に使用するHTTP URLのサブコンテキストを指定します。値を指定しない場合、デフォルトでport-component
名に設定されます。このURIを保護するために2つのトランスポート・レベルの要素が用意されています。これらの要素の詳細は、「<ejb-transport-security-constraint>」および「<ejb-transport-login-config>」を参照してください。また、「トランスポート・レベルでのEJBベースのWebサービスの保護」も参照してください。
Webモジュール(Javaクラスから導出されたWebサービス)の場合、この情報はすでにweb.xml
ファイルに含まれており、不要です。
なし
オプション
このブール型要素には、テスト・ページを公開するかどうかを指定します。デフォルトはtrue
です。
なし
オプション
このブール型要素には、テスト・ページを公開するかどうかを指定します。デフォルトはtrue
です。
なし
オプション
このブール型要素には、WSDLを公開するかどうかを指定します。デフォルトはtrue
です。
なし
オプション
このブール型要素には、WSDLを公開するかどうかを指定します。デフォルトはtrue
です。
なし
必須
oracle.webservices.provider.Provider
インタフェースを実装するクラスの名前を指定します。
オプション
このサブ要素には、デプロイ時に生成される、OC4J固有のWebサービスに関する情報が取得されます。このサブ要素には、param
サブ要素があります。
名前 | 説明 |
---|---|
type |
たとえば、データベース。 |
なし
オプション
JMS宛先情報を指定するために使用されるアドレス要素。これは、JMSを介してSOAPメッセージを送信するためにJMSトランスポートが指定されているときに使用されます。
なし
オプション
この要素を使用すると、Webサービスに渡されるメッセージの最大サイズ(バイト単位)を構成できます。このバイト数を超えるメッセージをWebサービスが読み取ると、送信が失敗し、接続が閉じられます。
この要素の値はlong integer
です。正でない値を割り当てると、制限がないものとみなされます。デフォルトの-1
は、無制限を意味します。サイズに関する制限がなくなります。
なし
オプション
正の値を指定すると、サービスはリクエストのサイズをその値(バイト単位)に制限します。最大長を超えるリクエストにはすべて、エラーが生成されます。デフォルトは-1
で、無制限を示します。
オプション
参照先のWebサービスにより提供される特定の操作に対する、サービスのクオリティ構成を指定します。この構成の指定は、この要素の<runtime>
サブ要素で行います。
名前 | 説明 |
---|---|
input |
WSDL内の操作の入力名を指定します。 |
name |
指定しているサービスのクオリティ構成を、この操作に関連付けます。属性の値は、WSDL内の操作名と一致させる必要があります。 |
output |
WSDL内の操作の出力名を指定します。 |
オプション
操作ごとに要素を1つずつ指定した、一連の要素を指定します。<operation>
サブ要素は、個々の操作に適用する管理ポリシーを記述します。
なし(ルート)
<context-root>、<ejb-transport-login-config>、<web-site>、<webservice-description>
必須
<oracle-webservices>
要素は、Webサービス用のOracleコンテナ固有の情報を取得します。
名前 | 説明 |
---|---|
noNamespaceSchemaLocation |
この属性は、XML文書が準拠するスキーマをパーサーに通知するための標準的な方法となります。 |
なし
オプション
実行時のデータソースのJNDI位置を指定します。
なし
オプション
プロバイダに対するWebサービス管理ポリシーを定義します。
<ejb-transport-security-constraint>、<endpoint-address-uri>、<implementor>、<jms-address>、<max-request-size>、<rest-support>、<runtime>、<use-dime-encoding>
オプション
この<port-component>
要素は、標準のデプロイメント・ディスクリプタwebservices.xml
内の同様の要素(ただし、-name
が後ろに追加されています)にマップするための参照として使用します。これらの要素には、特定のポートに関する情報が含まれます。
名前 | 説明 |
---|---|
name |
|
なし
オプション
グローバルに定義されたプロパティ、つまりすべての定義済プロバイダ・ポートで使用できるプロパティを指定します。この要素には、必須のstring属性name
があります。
なし
オプション
ローカルに定義されたプロパティです。特定の名前のプロパティがローカルとグローバルの両方で定義されている場合は、ローカルに定義されているプロパティの方がグローバルに定義されているプロパティより優先されます。
<property>、<provider-description-name>、<provider-port>, <wsdl-file>、<wsdl-service-name>
オプション
この要素は、Webサービスをプロバイダ対応にし、プロバイダ・ポートのコレクションを識別します。Webサービス・プロバイダの詳細は、『Oracle Application Server Web Servicesアドバンスト開発者ガイド』の「Webサービス・プロバイダの使用方法」を参照してください。
なし
必須
このstring型要素は、プロバイダの説明の名前を指定します。
なし
必須
プロバイダの名前です。<provider-port>
内の文字列<provider-name>
は、デプロイメント・ディスクリプタ内で一意である必要があります。
<expose-testpage>、<expose-wsdl>、<implementation-class>、<max-request-size>、<policy>、<property>、<provider-name>、<servlet-link>、<wsdl-port>
必須
WSDLポートをWebサービスのインタフェースおよび実装と関連付けます。ポートの名前をコンポーネントとして定義します。また、ポートとサーブレット・エンドポイントの関連付けも行います。wsdl-file
を指定しないと、provider-port
はパススルー・ゲートウェイを定義します。
なし
オプション
このサブ要素には、Webサービスとして公開するEJBに対するHTTP Basic認証内で使用するレルム名を指定します。詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
なし
オプション
このブール型要素は、相対インポートを絶対URLに解決するかどうかを指定します。デフォルトはfalse
です。
なし
オプション
このブール型rest要素は、RESTスタイルのGET
およびPOST
のリクエストおよびレスポンスをこのポートでサポートするかどうかを指定します。デフォルトはfalse
です。
<ejb-transport-security-constraint>
なし
オプション
このstring
型要素には、セキュリティ・ロールの名前を指定します。この名前は、トークンの字句ルールに準拠する必要があります。デフォルト値は定義されていません。
ここで使用するrole-name
は、次のどちらかに該当する必要があります。
このサブ要素に*
とロール名の両方が入力されている場合、このサブ要素はすべてのロールを意味するものとして解釈されます。ロールが定義されていない場合、ユーザーはセキュリティ制約に記述されているWebアプリケーションの部分にアクセスできません。ロール名は大文字と小文字が区別されて照合されます。
この要素の使用方法の詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
なし
オプション
実行時に読み取られるWebサービス管理情報の先頭を示しています。詳細は、『Oracle Application Server Web Servicesアドバンスト開発者ガイド』の「Webサービス管理スキーマの概要」を参照してください。
なし
オプション
参照先のWebサービスにより提供されるすべての操作に適用されるサーバー・サイドの、サービスのクオリティのランタイム情報(セキュリティ、信頼性、監査およびロギング)を指定します。各機能の構成は、それぞれの子要素に指定します。
なし
必須
provider-port
の値を、/WEB-INF/web.xml
ファイルで定義されているサーブレット・エンドポイントと関連付けます。
<ejb-transport-security-constraint>
なし
オプション
この要素を指定した場合は、セキュリティ制約をSOAPポートのみに適用する必要があることを示します。デフォルトは定義されていません。この要素の使用方法の詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
<ejb-transport-security-constraint>
なし
オプション
この要素には、クライアント/サーバー間で転送されるデータへのアクセスに関する制約を指定します。このサブ要素には、次のいずれかの値を指定できます。
NONE
: アプリケーションにおいてトランスポート保証を不要にします。
INTEGRAL
: アプリケーションにおいて、クライアントとサーバーの間で転送されるデータが転送中に変更できないようにします。
CONFIDENTIAL
: アプリケーションにおいて、他の実体が転送内容を確認できないようにデータを転送するようにします。
多くの場合、INTEGRAL
またはCONFIDENTIAL
フラグを指定するときはSSLを使用する必要があります。
この要素の使用方法の詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
なし
オプション
true
に設定すると、このサービスから戻される添付ファイル付きSOAPレスポンスはDIMEでエンコードされます。false
(デフォルト)の場合、添付ファイル付きSOAPレスポンスはMIMEエンコーディングで戻されます。DIMEでエンコードされた添付ファイルの詳細は、『Oracle Application Server Web Servicesアドバンスト開発者ガイド』のDIME添付ファイルの処理に関する項を参照してください。
なし
オプション
デフォルト: サービス・エンドポイント・インタフェースがインストールされている位置
このオプションの要素には、更新するWSDLポート位置内で代用するポート名およびホスト名を指定します。
たとえば、port-component-link
による解決を使用してWebサービスにアクセスする場合や、wsdl-publish-location
によって指定された位置にWSDLを公開する場合に、oracle-webservices.xml
ファイルにこのサブ要素を入力する必要があることがあります。
この要素を使用しない場合、WSDLを取得するために使用するHTTPのホストおよびポート値が代用されます。
名前 | 説明 |
---|---|
host |
更新するWSDLポート位置内で代用するホストの名前です。 |
port |
更新するWSDLポート位置内で代用するポートの名前です。 |
<download-external-imports>、<expose-testpage>、<expose-wsdl>、<port-component>、<resolve-relative-imports>、<wsdl-file>、<wsdl-publish-location>
オプション
この要素は、標準のデプロイメント・ディスクリプタwebservices.xml
の<webservice-description>
要素を拡張するものです。
名前 | 説明 |
---|---|
name |
|
なし
オプション
このstring型要素は、プロバイダに対する関連WSDLの位置を指定します。
なし
オプション
wsdl-file
型のこの要素は、デプロイ時に生成され、エンドユーザーは指定できません。最終的に更新されるWSDLの位置を指定します。
名前 | 説明 |
---|---|
final-location |
最終的に更新されるWSDLの位置を指定します。 |
なし
オプション
プロバイダと、wsdl-file
要素によって定義されるWSDLの特定のポートを関連付けます。WSDLファイルが定義されている場合、この要素は必要ありません。
なし
オプション
この要素を使用して、最終WSDLとその依存ファイル(インポート)を格納する位置を指定します。型はanyUriで、値はfile:/
location/
という書式に設定する必要があります。デフォルトは定義されていません。
なし
オプション
WSDLのサービス名と、プロバイダの名前を関連付けます。WSDLに複数のサービスがある場合は、この要素を指定する必要があります。WSDLファイルのサービスが1つのみの場合は、この要素は必要ありません。
<ejb-transport-security-constraint>
なし
オプション
この要素を指定した場合は、セキュリティ制約をWSDL URLのみに適用する必要があることを示します。デフォルト値は定義されていません。この要素の使用方法の詳細は、「トランスポート・レベルでのEJBベースのWebサービスの保護」を参照してください。
oracle-webservices.xml
デプロイメント・ディスクリプタには、EJBをベースにしたWebサービスに対してトランスポート・レベルのセキュリティを定義できるようにするために、<ejb-transport-security-constraint>
および<ejb-transport-login-config>
という2つの要素が用意されています。
<ejb-transport-security-constraint>
要素は、Webサービスとして公開されるバージョン2.1のEJBに、トランスポート・レベルのセキュリティの制約を適用するために使用します。Webサービスとして公開するEJBのURLは、port componentの<endpoint-address-uri>
要素によって指定します。<ejb-transport-security-constraint>
要素には次のサブ要素があります。
<role-name>
: セキュリティ・ロールの名前を指定します。詳細は、「<role-name>」を参照してください。
<soap-port>
: セキュリティ制約をSOAPポートのみに適用する必要があることを示します。詳細は、「<soap-port>」を参照してください。
<transport-guarantee>
: クライアント/サーバー間で転送されるデータへのアクセスに関する制約を指定します。詳細は、「<transport-guarantee>」を参照してください。
<wsdl-url>
: セキュリティ制約をWSDL URLのみに適用する必要があることを示します。詳細は、「<wsdl-url>」を参照してください。
サブ要素<wsdl-url>
および<soap-port>
は、セキュリティ制約をWSDL URLとSOAPポートのどちらに適用するかを選択する際に使用する識別子です。<ejb-transport-security-constraint>
に<wsdl-url>
と<soap-port>
の両方が存在する場合、または両方が存在しない場合、セキュリティ制約はWSDLとSOAPポートの両方に適用されます。
<ejb-transport-login-config>
要素を使用して、このEJBアプリケーションで使用する必要があるトランスポート・レベルの認証方式およびレルム名を構成します。Webサービスとして公開するEJBアプリケーションのURLは、port componentの<endpoint-address-uri>
要素によって指定します。
<auth-method>
: EJBアプリケーションの認証メカニズムを構成します。詳細は、「<auth-method>」を参照してください。
<realm-name>
: Webサービスとして公開するEJBに対するHTTP Basic認証内で使用するレルム名を指定します。詳細は、「<realm-name>」を参照してください。
例C-1は、oracle-webservices.xml
デプロイメント・ディスクリプタに対するテンプレートのリストです。なお、このテンプレート・ファイルには、Webサービス管理要素も含まれています。これらの要素の詳細は、このファイル内に記載された各参照先を参照してください。
<?xml version="1.0" encoding="UTF-8"?> <oracle-webservices xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://xmlns.oracle.com/oracleas/schema/oracle-webservic es-10_0.xsd" deployment-version="String" deployment-time="String" schema-major-version="10" schema-minor-version="0"> <web-site host="String" port="String"/> <context-root>String</context-root> <webservice-description name="String"> <expose-wsdl>true</expose-wsdl> <expose-testpage>true</expose-testpage> <resolve-relative-imports>false</resolve-relative-imports> <download-external-imports>false</download-external-imports> <port-component name="String"> <endpoint-address-uri>String</endpoint-address-uri> <ejb-transport-security-constraint> <wsdl-url/> <soap-port/> <role-name>Manager</role-name> <role-name>Administrator</role-name> <transport-guarantee>NONE</transport-guarantee> </ejb-transport-security-constraint>
<!-- For a listing and description of elements that define transport-level security constraints for EJBs, see "Securing EJB-Based Web Services at the Transport Level" on page C-15. -->
<implementor type="database"> <param name="String">String</param> </implementor> <runtime enabled="String"> <owsm/>
<!-- For a description of the element for the Oracle Web Services Manager (<owsm>) see the Oracle Web Services Manager Administrators Guide -->
<security>
<!-- For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide. -->
</security> <reliability> <repository jndiLocation="..." name="..." type="..."/>
<!-- For a description and listing of port-level reliability elements, see "Port-Level Reliability Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. -->
</reliability> <logging/> </runtime> <operations> <operation name="String" input="String"> <runtime> <security>
<!-- For a description and listing of security elements, see the Oracle Application Server Web Services Security Guide. -->
</security> <reliability> <duplication-elimination-required/> <guaranteed-delivery-required/>
<!-- For a listing and description of operation-level reliability elements, see "Operation Level Reliability Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. -->
</reliability> <auditing request="false" response="false" fault="false"/>
<!-- For a listing and description of operation-level auditing elements, see "Server-Side Auditing Configuration Elements" in the Oracle Application Server Advanced Web Services Developers Guide. -->
<logging>
<!-- For a listing and description of operation-level logging elements, see "Operation Level Logging Elements on the Server" in the Oracle Application Server Advanced Web Services Developers Guide. -->
</logging> </runtime> </operation> </operations> </port-component> </webservice-description> <ejb-transport-login-config> <auth-method>BASIC</auth-method> <realm-name>sec-ejb</realm-name> </ejb-transport-login-config>
<!-- For a listing and description of elements that define transport-level security for EJBs, see "Securing EJB-Based Web Services at the Transport Level" on page C-15. -->
</oracle-webservices>
|
![]() Copyright © 2006 Oracle Corporation. All Rights Reserved. |
|