WebLogic Web サービス プログラマーズ ガイド
WebLogic Web サービス デプロイメント記述子の要素
web-services.xml ファイルについて説明します。
web-services.xml デプロイメント記述子ファイルには、1 つまたは複数の WebLogic Web サービスを記述する情報が入っています。この情報には、Web サービスのオペレーションを実装するバックエンド コンポーネント、パラメータおよび戻り値として使用される非組み込みデータ型、SOAP メッセージをインターセプトする SOAP メッセージ ハンドラなどの詳細情報が含まれます。他のすべてのデプロイメント記述子の場合と同様に、web-services.xml も XML ファイルです。
web-services.xml 要素の階層を示しています。
web-services.xml ファイルの各要素を説明します。
<enforce-precision> 要素を false に設定します。詳細については、「enforce-precision」を参照してください。
<clocks-synchronized> と一緒に指定する必要があります。
<timestamp> の子要素です。
true の場合、WebLogic Server は、WebLogic Web サービスを呼び出すクライアント アプリケーションからの SOAP リクエストの有効期限を (存在する場合は) 適用します。このため、タイム スタンプが期限切れになった場合、WebLogic Server は Web サービス オペレーションを呼び出しません。false の場合、WebLogic Server は有効期限が指定されている SOAP リクエストをすべて拒否します。
True および False です。デフォルト値は false です。
<timestamp> の子要素です。
|
|
|
|
|
|
|
jar-name#ejb-name
jar-name は、ステートレス セッション EJB を含んでいる JAR ファイル (Web サービス EAR ファイル内に含まれている) の名前を指す。名前には、最上位の EAR ファイルへの相対パス名が含まれている必要がある。
ejb-name は、EJB JAR ファイル内の ejb-jar.xml デプロイメント記述子内の <ejb-name> 要素に対応するステートレス セッション EJB の名前を指す。
myapp.jar#StockQuoteBean
|
|
|
<name> 下位要素で、パスワードは <password> 下位要素で指定します。
false に設定した場合、WebLogic Server は、<clock-precision> 要素で指定したクロック精度期間より有効期限が短い SOAP リクエストを拒否しません。デフォルトでは、WebLogic Server はこれらの SOAP 応答を拒否します。これは、クライアント アプリケーションと WebLogic Server 間のクロック精度の不一致のため、WebLogic Server はメッセージが期限切れになったかどうかを判断できないからです。
True および False です。デフォルト値は true です。
<timestamp> の子要素です。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
True および False です。デフォルト値は true です。
<timestamp> の子要素です。
<handler> 要素の <init-params> 子要素を任意に使用してパラメータを指定します。
|
|
|
|
|
|
|
|
|
|
<handler> 子要素により定義される) がリストされる順番は重要です。デフォルトでは、ハンドラの handleRequest() メソッドは、<handler-chain> 要素の子要素としてリストされている順に実行されます。ハンドラの handleResponse() メソッドは、リストされているものとは逆の順序で実行されます。
|
|
|
|
|
|
|
|
|
|
web-services.xml ファイルで記述された Web サービスに使用されている SOAP メッセージ ハンドラ チェーンを記述する <handler-chain> 要素のリストを含んでいます。1 つの WebLogic Web サービスでは、任意数のハンドラ チェーンを定義できます (0 でもかまわない)。
-1 に設定します。
-1 です。
<clocks-synchronized> 要素を true に設定して、WebLogic Server とクライアント アプリケーションのクロックが同期されていることを指定する必要があります。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<name> 要素は、親要素に応じて以下の名前を指定します。
<user> の場合)<encryptionKey> の場合)<signatureKey> の場合)
component 属性をステートレス セッション EJB または Java クラス コンポーネントの名前に設定し、method 属性をメソッドの名前に設定します。component 属性を JMS コンポーネントの名前に設定します。component 属性をコンポーネントの名前に設定し、handler-chain 属性を対象のハンドラ チェーンの名前に設定します。component 属性と method 属性を設定せずに、handler-chain 属性を対象のハンドラ チェーンの名前に設定します。
<params> 子要素を使用します。
|
|
|
|
|
|
|
<component> 要素の name 属性に対応する。
|
|
|
|
|
component および method 属性と一緒に指定すると、オペレーションはメソッドとハンドラ チェーンの両方で実装される。ただし、component および method 属性を指定せずに、handler-chain だけを指定した場合、オペレーションは SOAP メッセージ ハンドラ チェーンのみで実装される。
<handler-chain> 要素の name 属性に対応する。
|
|
|
|
|
<spec:SecuritySpec> 要素の Id 属性に対応する。
|
|
|
|
|
request-response (デフォルト値) または one-way のいずれかの値のみを指定できる。
one-way に設定すると、メソッドにより void が返される。
|
|
|
|
|
component 属性でオペレーションがステートレス セッション EJB または Java クラスで実装されることを指定した場合)。
|
|
|
|
|
|
|
|
|
|
<spec:SecuritySpec> 要素の Id 属性に対応する。
|
|
|
|
|
<portType> 要素が指定したポートの種類ごとに作成される。
<web-service> 要素の portType 属性の値。
|
|
|
<operations> 要素は、この Web サービスの明示的に宣言されたオペレーションをグループ化します。
-1 に設定します。
-1 です。
<param> 要素はオペレーションの単一パラメータを指定します。
<param> 要素の数は、メソッドのパラメータ数と一致する必要があります。
|
|
|
|
|
|
|
xsd:int はデフォルトでは Java プリミティブ int 型にマップされるため、これを java.lang.Integer にマップするにはこの属性を使用する。
|
|
|
|
|
attachment。デフォルト値は Body。
Body を指定すると、RPC オペレーションの呼び出しに関する通常の SOAP 規則に基づき、パラメータの値が SOAP 本文から抽出される。Header を指定すると、type 属性の値を名前に持つ SOAP ヘッダ要素から値が抽出される。
attachment を指定すると、SOAP エンベロープではなく SOAP 添付ファイルからパラメータの値が抽出される。JAX-RPC 仕様で指定されているように、SOAP 添付ファイルから抽出できるのは、以下の Java データ型のみ。
|
|
|
|
|
|
|
|
|
|
in、out、または inout。
out または inout に指定すると、バックエンド コンポーネントのメソッド内のパラメータの Java クラスが javax.xml.rpc.holders.Holder インタフェースを実装する。
|
|
|
|
|
|
|
|
<params> 要素は、オペレーションの明示的に宣言されたパラメータとオペレーションの戻り値をグループ化します。
<operation> 要素に <params> 子要素がない場合、WebLogic Server はオペレーションを実装するバックエンド コンポーネントを参照してパラメータと戻り値を決定します。Web サービスの WSDL の生成時に、WebLogic Server は対応するメソッドのパラメータと戻り値の名前を使用します。
<param> 子要素を使用します。
<return-param> 子要素を使用します。
<params> 要素は、属性を持ちません。
<password> 要素は、親要素に応じて以下のパスワードを指定します。
<user> の場合)<encryptionKey> の場合)<signatureKey> の場合)
<reliable-delivery> 要素は、信頼性のある SOAP メッセージングを使用してオペレーションを非同期に呼び出すことができることを指定します。これにより、Web サービスを呼び出すアプリケーションでは、SOAP メッセージが Web サービス オペレーションに配信されたことが保証されます。配信されなかった場合には、その旨を明示的に示す例外を受信します。
<reliable-delivery> 要素は、1 つのオペレーションに対して 1 つだけ指定できます。
|
|
|
|
|
|
|
True に設定すると、Web サービスは重複呼び出しを排除できるようにクライアント アプリケーションからのメッセージ ID を保持する。False に設定した場合、Web サービスは重複呼び出しを管理しない。つまり、クライアントが呼び出しを再試行した場合、どちらの呼び出しも値を返すことができる。
True および False。デフォルト値は True。
|
|
|
|
|
|
|
|
true に設定し、SOAP リクエストにタイムスタンプが含まれていない場合、WebLogic Server は応答を拒否します。
True および False です。デフォルト値は true です。
<timestamp> の子要素です。
<return-param> 要素は、Web サービス オペレーションの戻り値を指定します。
<return-param> 要素は 1 つのみです。
|
|
|
|
|
|
|
|
|
|
|
|
attachment。デフォルト値は Body。
Body を指定すると、戻りパラメータの値が SOAP 本文に追加される。Header を指定すると、type 属性の値を名前に持つ SOAP ヘッダ要素として値が追加される。
attachment を指定すると、SOAP エンベロープではなく SOAP 添付ファイルにパラメータの値が追加される。JAX-RPC 仕様で規定されているように、SOAP 添付ファイルに追加できるのは以下の Java データ型のみ。
|
|
|
|
|
result になる。
|
|
|
|
|
|
|
|
<user> 子要素)。<encryptionKey> および <signatureKey> 子要素)。<spec:SecuritySpec> 子要素)。
|
|
|
|
|
|
|
|
|
|
<name> 下位要素で、パスワードは <password> 下位要素で指定します。
xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext"
wsse ネームスペースで修飾する必要があります。
|
|
|
|
|
|
|
wsse:Base64Binary のみ。
|
|
|
|
|
wsse:X509v3 のみ (X.509 証明書の場合)。
|
|
|
<spec:SignatureSpec> または <spec:EncryptionSpec> の子要素として指定します。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
header または body。この値を指定しないと、要素の識別時に SOAP メッセージ全体が検索対象になる。
|
|
|
EncryptBody="True" を設定すると、SOAP 本文全体を暗号化の対象に指定できます。また、<spec:ElementIdentifier> 子要素を使用して、SOAP メッセージ中の暗号化する特定の要素を指定することもできます。
EncryptBody="True" の指定と <spec:ElementIdentifier> 子要素による要素の指定を同時には行わないでください。暗号化する SOAP メッセージの要素を指定する方法には、どちらか一方のみを採用してください。
EncryptionMethod 属性を使用します。
|
|
|
|
|
|
|
EncryptBody="True" の指定と <spec:ElementIdentifier> 子要素による要素の指定を同時には行わないこと。暗号化する SOAP メッセージの要素を指定する方法には、どちらか一方のみを採用すること。
True および False。
|
|
|
|
|
http://www.w3.org/2001/04/xmlenc#tripledes-cbc
http://www.w3.org/2001/04/xmlenc#kw-tripledes
http://www.w3.org/2001/04/xmlenc#tripledes-cbc。
|
|
|
|
|
http://www.w3.org/2001/04/xmlenc#rsa-1_5 (REQUIRED RSA-v1.5 アルゴリズムを指定)
http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p (REQUIRED RSA-OAEP アルゴリズムを指定)
KeyWrappingMethod="http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p"
http://www.w3.org/2001/04/xmlenc#rsa-1_5。
|
|
|
<spec:UsernameTokenSpec> 子要素)<spec:BinarySecurityTokenSpec> 子要素)<spec:SignatureSpec> 子要素)<spec:EncryptionSpec> 子要素)
<spec:SecuritySpec> 要素の情報は Web サービスの生成された WSDL に組み込まれます。これにより、Web サービスを呼び出すクライアントでは、すべてのセキュリティ仕様に沿った SOAP リクエストの作成方法がわかります。
<spec:SecuritySpec> 要素で SOAP メッセージのある部分にデジタル署名するよう指定されていれば、WebLogic Server はこれについて SOAP リクエストの受信時にチェックする必要があるとわかります。チェック後、WebLogic Server は同じ情報を使って SOAP 応答メッセージのセキュリティ情報を作成します。
xmlns:spec="http://www.openuri.org/2002/11/wsse/spec"
<spec:SecuritySpec> 要素の子要素はすべて spec ネームスペースで修飾する必要があります。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SignBody="True" を設定すると、SOAP 本文全体にデジタル署名するように指定できます。デジタル署名する対象として SOAP メッセージの特定の要素を追加指定するには、<spec:ElementIdentifier> 子要素を使用します。
CanonicalizationMethod 属性および SignatureMethod 属性を使用します。
|
|
|
|
|
|
|
http://www.w3.org/2001/10/xml-exc-cl4n#
|
|
|
|
|
http://www.w3.org/2000/09/xmldsig#rsa-sha1
http://www.w3.org/2000/09/xmldsig#dsa-sha1
|
|
|
|
|
<spec:ElementIdentifier> 子要素で指定した特定の要素に加え、SOAP 本文全体にもデジタル署名するかどうかを指定する。
True および False。
|
|
|
<security> 要素の <user> 子要素の情報を使用します。
xmlns:wsse="http://schemas.xmlsoap.org/ws/2002/07/secext"
wsse ネームスペースで修飾する必要があります。
|
|
|
|
|
|
|
wsse:PasswordText (ユーザ名に対応する実際のパスワード) のみ。
|
|
|
|
|
|
|
|
|
|
web-services.xml ファイル内のもので、ejb-jar.xml ファイル内の EJB の名前は参照しない。
|
|
|
<timestamp> 要素は、WebLogic Server のタイムスタンプ動作をコンフィグレーションするために使用する要素をグループ化したものです。WebLogic Server は、暗号化またはデジタル署名される SOAP メッセージに対してだけタイムスタンプを追加または要求します。
web-services.xml デプロイメント記述子の <security> 要素に <timestamp> 子要素が存在せず、Web サービスでメッセージ セキュリティ (暗号化とデジタル署名) がコンフィグレーションされている場合、WebLogic Server は次のように動作します。
<type-mapping> 要素には、<types> 要素に定義されている XML データ型とその Java 表現間のマッピングのリストが含まれています。
<types> 要素内の各データ型に対し、そのデータ型を実装する Java クラスや、データをシリアライズ/デシリアライズする方法などをリストした <type-mapping-entry> 要素があります。
<types> 要素内の単一 XML データ型とその Java 表現間のマッピングを指定します。
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<element> 要素を使用する場合にのみ指定する。
|
|
element または type のいずれか 1 つ (両方ではない) が必須。
|
|
|
|
|
|
|
|
<type> 要素を使用する場合にのみ指定する。
|
|
element または type のいずれか 1 つ (両方ではない) が必須。
|
stockSymbol (String データ型) と numberTraded (Integer 型) の 2 つの要素を含む TradeResult というデータ型の XML スキーマ宣言を示します。
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:stns="java:examples.webservices"
attributeFormDefault="qualified"
elementFormDefault="qualified"
targetNamespace="java:examples.webservices">
<xsd:complexType name="TradeResult">
<xsd:sequence>
<xsd:element maxOccurs="1"
name="stockSymbol"
type="xsd:string" minOccurs="1">
</xsd:element>
<xsd:element maxOccurs="1"
name="numberTraded"
type="xsd:int"
minOccurs="1">
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:schema>
</types>
|
|
|
|
|
|
|
US-ASCII、UTF-8、Shift_JIS などがある。
US-ASCII。
US-ASCII であるが、これは Web サービスの web-service.xml ファイルでこの属性を明示的に指定しない場合、WebLogic Web サービス呼び出しへの応答で常に US-ASCII の文字セットが使用されるという意味ではない。詳細については、「WebLogic Server が使用する文字セット コンフィグレーションの優先順位」を参照。
|
|
|
|
|
True および False。デフォルト値は True。すなわち、デフォルトではホーム ページは外部からアクセス可能。
|
|
|
|
|
True および False。デフォルト値は True。すなわち、デフォルトでは WSDL は外部からアクセス可能。
|
|
|
|
|
Authorization HTTP ヘッダを無視することを指定する。
True に設定すると、WebLogic Server は、たとえアクセス制御のセキュリティ制約が Web サービスを構成する EJB、Web アプリケーション、またはエンタープライズ アプリケーションに対して定義されていても、Web サービスを呼び出そうとしているクライアント アプリケーションの認証を行わない。つまり、認証資格を提供しないクライアント アプリケーションでも、セキュリティ制約が定義されていれば、Web サービスを呼び出すことが可能となる。
True および False。デフォルト値は False。
|
|
|
|
|
connection_factory_name/queue_name
connection_factory_name は JMS 接続ファクトリの JNDI 名、queue_name は JMS 転送用にコンフィギュレーションした JMS キューの JNDI 名。次に例を示す。
jmsURI="JMSTransFactory/JMSTransQueue"
clientgen Ant タスクは、この Web サービスの呼び出しに使用されるスタブの生成時に、デフォルトの getServicePort() メソッド (HTTP/S 用) に加え getServicePortJMS() メソッド (JMS 用) を生成する。
|
|
|
|
|
|
|
|
|
|
<service> 要素の <port> 子要素の名前。
name 属性に Port を付加した値。たとえば、この Web サービスの名前が TraderService の場合、ポート名は TraderServicePort になる。
|
|
|
|
|
<portType> 要素の名前。
name 属性に Port を付加した値。たとえば、この Web サービスの名前が TraderService の場合、portType 名は TraderServicePort になる。
|
|
|
|
|
http または https。デフォルトは http。
|
|
|
|
|
document と documentwrapped は、ドキュメント指向の Web サービス オペレーションを指定する。
document を指定した場合、Web サービスはパラメータを 1 つしか取らない。このため、このオペレーションを実装するメソッドもパラメータを 1 つしか取らない。
documentwrapped を指定した場合、Web サービス オペレーションはパラメータをいくつでも取ることができる。ただし、これらのパラメータの値は、SOAP メッセージの中に 1 つの複合データ型としてラップされる。Web サービスを実装するステートレス セッション EJB または Java クラスの複数のメソッドが同じパラメータ数とデータ型を取り、オペレーションをドキュメント指向にしたい場合、この属性値として document ではなく documentwrapped を指定する必要がある。
rpc、documentwrapped、および document。デフォルト値は rpc。
style 属性は Web サービス全体に適用されるので、1 つの <web-service> 要素で指定されたすべてのオペレーションが RPC 指向またはドキュメント指向のいずれかである必要がある。同じ Web サービスで 2 つのスタイルを混在させることはできない。
|
|
|
|
|
|
|
|
|
|
/TraderService のように、先頭に「/」を必ず指定すること。
|
|
|
|
|
useSOAP12="True" を指定した場合、デプロイされた WebLogic Web サービスの生成された WSDL には、メッセージ フォーマット プロトコルとして SOAP 1.1 用のバンディングを指定する標準ポートと、SOAP 1.2 を使用する第 2 ポートの 2 つのポートが含まれる。メッセージ フォーマット プロトコルに SOAP 1.2 を使用したい場合、クライアント アプリケーションは Web サービスの呼び出し時に第 2 ポートを使用できる。
True および False。デフォルト値は False。
|
|
|
web-services.xml デプロイメント記述子のルート要素です。
