|
|
以下の節では、Web サービスの信頼性のあるメッセージングの使用方法について説明します。
| 注意 : | Web サービスの信頼性のあるメッセージングは、WebLogic Web サービスの非同期の要求と応答機能に依存しています。先に進む前に、「非同期の要求と応答を使用した Web サービスの呼び出し」で説明する概念を理解する必要があります。 |
Web サービスの信頼性のあるメッセージングとは、ある 1 つのアプリケーション サーバで実行中のアプリケーションが、別のアプリケーション サーバで実行中の Web サービスを確実に呼び出せるフレームワークです。ここでは、双方のサーバで WS-ReliableMessaging 仕様が実装されていることが前提となっています。信頼性のある、とは 2 つの Web サービス間でのメッセージの配信を保証できるということです。
| 注意 : | Web サービスの信頼性のあるメッセージングは、WS-ReliableMessaging 仕様が実装された任意の 2 つのアプリケーション サーバ間で機能します。しかしこのマニュアルでは、この 2 つのアプリケーション サーバを、WebLogic Server インスタンスであると想定しています。 |
WebLogic Web サービスは、WS-ReliableMessaging 仕様 (2007 年 6 月) に準拠しています。これは、別々のアプリケーション サーバで実行されている 2 つの Web サービスが、ソフトウェア コンポーネント、システム、またはネットワークに障害が発生していても、確実に通信できる方法について記述したものです。具体的には、この仕様ではソース エンドポイント (つまりクライアント Web サービス) から送り先エンドポイント (つまりオペレーションを確実に呼び出せる Web サービス) へ送信されるメッセージが、1 つまたは複数の配信保証に基づいて確実に配信されるか、そうでなければ必ずエラーが送出される、相互運用性を備えたプロトコルについて説明しています。
信頼性のある WebLogic Web サービスには、以下の配信保証が備わっています。
| 注意 : | Web サービスの信頼性のあるメッセージングは、JMS 転送機能ではサポートされません。 |
ここでは、信頼性のあるクライアント Web サービスを作成し、その Web サービスがデプロイされる 2 つの WebLogic Server インスタンスをコンフィグレーションする方法について説明します。Web サービスの信頼性のあるメッセージングのアーキテクチャの詳細については、WS-ReliableMessaging 仕様を参照してください。
WebLogic Web サービスでは、送り先エンドポイントが Web サービスの信頼性のあるメッセージングの機能と要件を記述および公開できるようにする、WS-Policy ファイルを使用します。WS-Policy ファイルは、サポートされている WS-ReliableMessaging 仕様のバージョンやサービス品質の要件などが記述された XML ファイルです。WS-Policy 仕様では、Web サービスのポリシーを記述して通信するための、汎用的なモデルと構文が提供されています。
WebLogic Server には、標準的な信頼性のあるメッセージング アサーションが含まれた、あらかじめパッケージ化されている WS-Policy ファイルがあります。「信頼性のあるメッセージング用にパッケージ化されている WS-Policy ファイル」を参照してください。あらかじめパッケージ化されている WS-Policy ファイルがニーズを満たさない場合、独自の WS-Policy ファイルを作成する必要があります。詳細は、「Web サービスの信頼性のあるメッセージングの WS-Policy ファイルの作成」を参照してください。信頼性のあるメッセージングのポリシーのアサーションに関するリファレンス情報については、『WebLogic Web サービス リファレンス』の「Web サービスの信頼性のあるメッセージングのポリシー アサーションに関するリファレンス」を参照してください。
「信頼性のあるメッセージ シーケンス」は、RM 送信元と RM 送り先の間で確実に交換されるメッセージ セットの進捗状況を追跡する際に使用されます。シーケンスは、0 個以上のメッセージの送信に使用でき、文字列識別子で識別されます。この識別子は、信頼性のあるメッセージングを使用する際に、そのシーケンスを参照するために使用されます。
Web サービス クライアント アプリケーションは、RM 送信元が RM 送り先へ送信する信頼性のある配信のメッセージを送信します。RM 送り先は、信頼性のあるメッセージを受信したことを応答確認し、そのメッセージを Web サービス アプリケーションに配信します。RM 送信元は、応答確認を受け取るまでメッセージを再送信できます。
Web サービス クライアントは、JAX-RPC スタブに対するメソッドの呼び出しを行い、対象 Web サービスへメッセージを送信します。スタブは、信頼性のある Web サービスのポート タイプに関連付けられており、その Web サービスのプログラム的なインタフェースを表します。WebLogic では、このスタブ内に、信頼性のあるメッセージ シーケンスの識別子が格納されます。これによって、信頼性のあるメッセージ シーケンスが単一の JAX-RPC スタブに接続されます。特定のスタブを使用して送信されるすべてのメッセージは、そのメッセージの数に関係なく、同じ信頼性のあるメッセージング シーケンスを使用します。JAX-RPC スタブは、jwsc Ant タスクの子要素 <clientgen> によって作成されます。
WebLogic Server では、リソースが信頼性のあるシーケンスに関連付けられた状態で維持されるため、これらのリソースを適時に開放する措置を講じることをお勧めします。WebLogic Server には、Web サービスの信頼性のあるメッセージングで使用できるユーティリティ クラス weblogic.wsee.reliability.WsrmUtils があります。このクラスを使用すると、オプションのコンフィグレーション、シーケンス ID の取得、信頼性のあるシーケンスの終了、といった一般的なタスクを実行できます。
通常の環境下では、信頼性のあるシーケンスは、すべてのメッセージが送信され、RM 送り先によって確認応答されるまで保持する必要があります。シーケンスを容易に適時終了するには、信頼性のあるメッセージ シーケンスの最終メッセージを識別することが推奨されます。識別すると、RM 送り先へのメッセージの送信が完了したこと、および WebLogic Server が信頼性のあるシーケンスを自動的に終了する前に最終確認応答の検出を開始できることを示します。最終メッセージは、weblogic.wsee.reliability.WsrmUtils.setFinalMessage() メソッドを使用し、メッセージの送信に使用されている JAX-RPC スタブを RM 送り先に渡して示します。
最終メッセージを識別すると、最終メッセージまでの最終メッセージを含むすべてのメッセージが確認応答され、信頼性のあるメッセージ シーケンスが終了し、すべてのリソースが開放されます。識別しない場合、シーケンスは、コンフィグレーションしたシーケンスの有効期限に達した後で自動的に終了します。
これは推奨されませんが、terminateSequence() メソッドを使用すると、すべてのメッセージが確認応答されているかどうかに関係なく、信頼性のあるメッセージ シーケンスを終了できます。このメソッドを発行すると、このスタブ上で信頼性のあるメッセージをそれ以降送信することはできません。
| 注意 : | JAX-RPC スタブは、最初のメソッドが信頼性のある Web サービスに対して呼び出された直後まで完全に初期化されません。最初のメソッドが呼び出されると、RM 送信元は CreateSequence() メッセージを RM 送り先へ送信し、信頼性のあるシーケンスを作成および登録するよう RM 送り先に要求します。その後、RM 送り先は新たに作成されたシーケンスにその ID で応答します。RM 送信元は、この応答 ID を受信するまで RM 送り先と通信できず、RM 送り先の対象サービスを表す JAX-RPC スタブは使用できません。 |
| 注意 : | 信頼性のあるメッセージ シーケンスに対しては、そのシーケンスが完全に初期化されるまで操作を行うことはできません。操作するとエラーが返されます。信頼性のあるメッセージ シーケンスが初期化されているかどうかをモニタするには、weblogic.wsee.reliability.WsrmUtils.waitForSequenceInitialization() メソッドを使用します。このメソッドは、信頼性のあるシーケンスが初期化されると、そのシーケンスの ID を返します。 |
WsrmUtils ユーティリティ クラスの詳細については、Javadoc の weblogic.wsee.reliability.WsrmUtils を参照してください。
WebLogic Web サービスの信頼性のあるメッセージングのコンフィグレーションには、JMS サーバやストア アンド フォワード (SAF) エージェントの作成など標準的な JMS タスクと共に、JWS ファイルへの付加的な JWS アノテーションの追加など Web サービス固有のタスクが必要です。また必要に応じて、あらかじめパッケージ化されているファイルを使用しない場合は、信頼性のある Web サービスの信頼性のあるメッセージング機能を記述した WS-Policy ファイルをユーザ側で作成します。
信頼性のある Web サービスの呼び出しに WebLogic クライアント API を使用している場合、クライアント アプリケーションは WebLogic Server 上で実行される必要があります。したがってコンフィグレーション タスクは、信頼性のある Web サービスを確実に呼び出すクライアント コードを含む Web サービスがデプロイされたソース WebLogic Server インスタンスと、信頼性のある Web サービスそのものがデプロイされた送り先 WebLogic Server インスタンスの、双方の上で実行される必要があります。
以下の表では、信頼性のある Web サービスと、そのオペレーションを呼び出すクライアント Web サービスを作成する手順を説明しています。この手順では、2 つの Web サービスを実装する JWS ファイルをゼロから作成する方法を示しています。既存の JWS ファイルを更新する場合は、この手順をガイドとして利用してください。またこの手順では、ソース WebLogic Server インスタンスと送り先 WebLogic Server インスタンスのコンフィグレーション方法も示しています。
jwsc タスクの使用に関する全般的な情報については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「jwsc WebLogic Web サービス Ant タスクの実行」を参照。
|
||
xs:base64Binary 型の XML データの送信を最適化する信頼性のある Web サービスを開発します。
詳細については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「WebLogic Web サービスの開発」を参照してください。
信頼性のある Web サービスがデプロイされる WebLogic Server インスタンスをコンフィグレーションするには、JMS およびストア アンド フォワード (SAF) リソースをコンフィグレーションします。
これらのリソースは手作業でもコンフィグレーションできますが、コンフィグレーション ウィザードで、Web サービス固有の拡張テンプレートを使用して WebLogic Server ドメインを拡張することもできます。コンフィグレーション ウィザードを使用すると、必要なコンフィグレーション手順が大幅に簡素化されます。詳細については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「Web サービス機能用のドメイン コンフィグレーション」を参照してください。
| 注意 : | または、WLST を使用してリソースをコンフィグレーションすることもできます。WLST によるドメインの拡張については、『WebLogic Scripting Tool ガイド』の「既存ドメインのコンフィグレーション」を参照してください。 |
リソースを手作業でコンフィグレーションする場合、以下の手順を実行します。
|
|
||
|
|
||
|
|
||
クライアント Web サービスがデプロイされる WebLogic Server インスタンスをコンフィグレーションする際には、JMS およびストア アンド フォワード (SAF) リソースがコンフィグレーションされます。
これらのリソースは手作業でもコンフィグレーションできますが、コンフィグレーション ウィザードで、Web サービス固有の拡張テンプレートを使用して WebLogic Server ドメインを拡張することもできます。コンフィグレーション ウィザードを使用すると、必要なコンフィグレーション手順が大幅に簡素化されます。詳細については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「Web サービス機能用のドメイン コンフィグレーション」を参照してください。
| 注意 : | または、WLST を使用してリソースをコンフィグレーションすることもできます。WLST によるドメインの拡張については、『WebLogic Scripting Tool ガイド』の「既存ドメインのコンフィグレーション」を参照してください。 |
リソースを手作業でコンフィグレーションする場合、以下の手順を実行します。
|
|
||
|
|
||
WS-Policy ファイルは、WS-Policy 仕様に準拠するポリシー アサーションを含む XML ファイルです。この場合には、WS-Policy ファイルに Web サービスの信頼性のあるメッセージング ポリシーのアサーションが含まれています。
WebLogic Server には、標準的な信頼性のあるメッセージング アサーションを含む WS-Policy ファイルがあらかじめパッケージ化されています。独自の WS-Policy ファイルを作成しない場合は、これらのファイルを使用できます。次の表に、あらかじめパッケージ化されている WS-Policy ファイルを示します。
| 注意 : | このリリースでは、DefaultReliability.xml ファイルと LongRunningReliability.xml ファイルは非推奨となっています。代わりに、DefaultReliability1.1.xml、Reliability1.1_SequenceTransportSecurity、または Reliability1.0_1.1.xml の各ファイルの使用が推奨され、バージョン 1.1 の WS-ReliableMessaging 仕様に準拠するにはこれらのファイルの使用が必須です。 |
WebLogic Server に含まれる、あらかじめパッケージ化されている信頼性のあるメッセージング WS-Policy ファイルの 1 つを使用できます。これらのファイルは、ほとんどの場合に適合しています。あらかじめパッケージ化されているファイルは変更できません。値がニーズを満たさない場合は、カスタムの WS-Policy ファイルを作成する必要があります。以下の節で、カスタム WS-Policy ファイルの作成方法を説明します。
この節では、WS Reliable Messaging Policy Assertion Version 1.1 に基づく、Web サービスの信頼性のあるメッセージング アサーションを格納するカスタム WS-Policy ファイルの作成方法を説明します。現在のリリースでは、信頼性のあるメッセージング ポリシー アサーションの多くが、JWS のアノテーションまたはコンフィグレーションを通じて管理されます。
WS-Policy ファイルのルート要素は <Policy> であり、次のネームスペース宣言が含まれている必要があります。
<wsp:Policy
xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
Web サービスの信頼性のあるメッセージング ポリシーのアサーションはすべて、<wsrmp:RMAssertion> 要素の内部でラップします。この要素には、Web サービスの信頼性のあるメッセージング ポリシー アサーションを使用するため、次のネームスペース宣言が含まれている必要があります。
<wsrmp:RMAssertion
xmlns:wsrmp="http://docs.oasis-open.org/ws-rx/wsrmp/200702">
次の表に、WS-Policy ファイルで指定可能な Web サービスの信頼性のあるメッセージング アサーションを示します。アサーションの指定順序は重要です。以下のアサーションを指定できますが、WS-Policy ファイルでは以下の一覧の順序どおりに指定する必要があります。
次の例では、簡単な Web サービスの信頼性のあるメッセージングの WS-Policy ファイルを示します。
<?xml version="1.0"?>
<wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
<wsrmp:RMAssertion
xmlns:wsrmp="http://docs.oasis-open.org/ws-rx/wsrmp/200702">
<wsrmp:SequenceTransportSecurity/>
<wsrmp:DeliveryAssurance>
<wsp:Policy>
<wsrmp:ExactlyOnce/>
</wsp:Policy>
</wsrmp:DeliveryAssurance>
</wsrmp:RMAssertion>
</wsp:Policy>
WS-Policy ファイルの信頼性のあるメッセージング ポリシー アサーションの詳細については、『WebLogic Web サービス リファレンス』の「Web サービスの信頼性のあるメッセージングのポリシー アサーションに関するリファレンス」を参照してください。
この節では、WS Reliable Messaging Policy Assertion Version 1.0 に基づく、Web サービスの信頼性のあるメッセージング アサーションを格納するカスタム WS-Policy ファイルの作成方法を説明します。
| 注意 : | 現在のリリースでは、信頼性のあるメッセージング ポリシー アサーションの多くが、JWS のアノテーションまたはコンフィグレーションを通じて管理されます。 |
WS-Policy ファイルのルート要素は <Policy> です。Web サービスの信頼性のあるメッセージング ポリシーのアサーションを使用するには、これに以下のネームスペース宣言が含まれていることが必要です。
<wsp:Policy
xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm"
xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
xmlns:beapolicy="http://www.bea.com/wsrm/policy">
Web サービスの信頼性のあるメッセージング ポリシーのアサーションはすべて、<wsrm:RMAssertion> 要素の内部でラップします。wsrm: ネームスペースを使用するアサーションは、WS-ReliableMessaging 仕様で定義される標準的なアサーションです。beapolicy: ネームスペースを使用するアサーションは、WebLogic 固有のものです。詳細については、『WebLogic Web サービス リファレンス』の「Web サービスの信頼性のあるメッセージングのポリシー アサーションに関するリファレンス」を参照してください。
次の表に、WS-Policy ファイルで指定可能な Web サービスの信頼性のあるメッセージング アサーションを示します。Web サービスの信頼性のあるメッセージングのアサーションは、すべて任意指定なので、デフォルト値が不適切なものだけを設定します。アサーションの指定順序は重要です。以下のアサーションを指定できますが、WS-Policy ファイルでは以下の一覧の順序どおりに指定する必要があります。
Expires という 1 つの属性があり、この属性のデータ型は XML スキーマ期間型である。たとえば、有効期限までを 1 日と設定する場合は、<beapolicy:Expires Expires="P1D" /> とする。
|
|
QOS という 1 つの属性があり、この属性は AtMostOnce、AtLeastOnce、ExactlyOnce の各値のうちの 1 つに設定する。また、メッセージを順序通りにすることを指定するために InOrder 文字列を含めることもできる。デフォルト値は ExactlyOnce InOrder。この要素は通常、設定されない。
|
次の例では、簡単な Web サービスの信頼性のあるメッセージングの WS-Policy ファイルを示します。
<?xml version="1.0"?>
<wsp:Policy
xmlns:wsrm="http://schemas.xmlsoap.org/ws/2005/02/rm/policy"
xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy"
xmlns:beapolicy="http://www.bea.com/wsrm/policy"
>
<wsrm:RMAssertion >
<wsrm:InactivityTimeout
Milliseconds="600000" />
<wsrm:BaseRetransmissionInterval
Milliseconds="500" />
<wsrm:ExponentialBackoff />
<wsrm:AcknowledgementInterval
Milliseconds="2000" />
</wsrm:RMAssertion>
</wsp:Policy>
WS-Policy ファイルの信頼性のあるメッセージング ポリシー アサーションの詳細については、『WebLogic Web サービス リファレンス』の「Web サービスの信頼性のあるメッセージングのポリシー アサーションに関するリファレンス」を参照してください。
カスタム ポリシー ファイルを作成することによって、単一の Web サービスに複数のポリシー選択肢 (適切なポリシー選択肢) をコンフィグレーションできます。実行時には、適用されるポリシーがそれらの中から自動的に選択されます。その際は、サポートされていないポリシーやアサーションが衝突しているポリシーが除外され、コンフィグレーションされている設定に基づいて、受信メッセージの検証と応答メッセージの構築に適したポリシーが選択されます。
以下に、1.1 と 1.0 の両方の WS-Reliable メッセージングをサポートするセキュリティ ポリシーのサンプルを示します。各ポリシー選択肢は、<wsp:All> 要素で囲まれています。
| 注意 : | 1.0 の Web サービスの信頼性のあるメッセージング アサーションには、プレフィックスとして wsrmp10 が付加されます。 |
<wsp:Policy xmlns:wsp="http://schemas.xmlsoap.org/ws/2004/09/policy">
<wsp:ExactlyOne>
<wsp:All>
<wsrmp10:RMAssertion
xmlns:wsrmp10="http://schemas.xmlsoap.org/ws/2005/02/rm/policy">
<wsrmp10:InactivityTimeout Milliseconds="1200000"/>
<wsrmp10:BaseRetransmissionInterval Milliseconds="60000"/>
<wsrmp10:ExponentialBackoff/>
<wsrmp10:AcknowledgementInterval Milliseconds="800"/>
</wsrmp10:RMAssertion>
</wsp:All>
<wsp:All>
<wsrmp:RMAssertion
xmlns:wsrmp="http://docs.oasis-open.org/ws-rx/wsrmp/200702">
<wsrmp:SequenceSTR/>
<wsrmp:DeliveryAssurance>
<wsp:Policy>
<wsrmp:AtMostOnce/>
</wsp:Policy>
</wsrmp:DeliveryAssurance>
</wsrmp:RMAssertion>
</wsp:All>
</wsp:ExactlyOne>
</wsp:Policy>
複数のポリシー選択肢の詳細については、『Securing WebLogic Web Services』の「メッセージレベルのセキュリティのコンフィグレーション」の「適切なポリシーの選択」を参照してください。
この節では、信頼性のある Web サービスを実装する JWS ファイルの作成方法を説明します。
信頼性のある Web サービスを実装する JWS ファイルでは、次の JWS アノテーションが使用されます。
次のサンプルでは、信頼性のある Web サービスを実装する簡単な JWS ファイルを示します。太字で示された Java コードに対応するコーディングのガイドラインについては、サンプルの後の説明を参照してください。
package examples.webservices.reliable;
import javax.jws.WebMethod;
import javax.jws.WebService;import javax.jws.Oneway;
import weblogic.jws.WLHttpTransport;
import weblogic.jws.ReliabilityBuffer;
import weblogic.jws.BufferQueue;
import weblogic.jws.Policy;/**
* 簡単な信頼性のある Web サービス
*/
@WebService(name="ReliableHelloWorldPortType",
serviceName="ReliableHelloWorldService")
@WLHttpTransport(contextPath="ReliableHelloWorld",
serviceUri="ReliableHelloWorld",
portName="ReliableHelloWorldServicePort")
@Policy(uri="ReliableHelloWorldPolicy.xml",
direction=Policy.Direction.both,
attachToWsdl=true)@BufferQueue(name="webservices.reliable.queue")public class ReliableHelloWorldImpl {@WebMethod()@Oneway()
@ReliabilityBuffer(retryCount=10, retryDelay="10 seconds")
public void helloWorld(String input) {
System.out.println(" Hello World " + input);}
}
このサンプルでは、ReliableHelloWorldPolicy.xml ファイルがクラス レベルで Web サービスに追加されています。つまり、ポリシー ファイルは Web サービスのすべてのパブリック オペレーションに適用されます。ポリシー ファイルは、リクエスト Web サービス メッセージ (信頼性のあるメッセージング機能によって要求される) のみに適用され、WSDL ファイルに追加されます。
WebLogic Server が、Web サービスの信頼性のあるメッセージングを有効化するために内部で使用する JMS キューの JNDI 名は、@BufferQueue アノテーションで指定されているように、webservices.reliable.queue です。
helloWorld() メソッドは、@WebMethod と @Oneway、どちらの JWS アノテーションでもマークされています。これは、このメソッドが helloWorld というパブリック オペレーションであるということです。@Policy アノテーションがあるために、オペレーションを確実に呼び出すことができます。@ReliabilityBuffer アノテーションに記述されているとおり、Web サービスのランタイムでは、最大で 10 回、10 秒間隔で、信頼性のあるメッセージをサービスに配信しようとします。たとえば、トランザクションがロールバックされる場合や、コミットしない場合などには、メッセージの再配信が必要となることがあります。
信頼性のあるメッセージングのアサーションが含まれる WS-Policy ファイルを Web サービスに追加するよう指定するには、JWS ファイルで @Policy アノテーションを使用します。WebLogic Server では、あらかじめパッケージ化された WS-Policy ファイルのセットが提供されます。「信頼性のあるメッセージング用にパッケージ化されている WS-Policy ファイル」を参照してください。
Web サービスの信頼性のあるメッセージングで @Policy アノテーションを使用する場合は、次のガイドラインに従います。
uri 属性を使用して、ポリシー ファイルのビルド時の場所を以下のように指定します。@Policy(uri="ReliableHelloWorldPolicy.xml",
direction=Policy.Direction.both,
attachToWsdl=true)
この例では、ReliableHelloWorldPolicy.xml ファイルが JWS ファイルと同じディレクトリに置かれています。
policy: プレフィックスを使用する。この構文ではビルド時の jwsc Ant タスクに、ファイル システムの実際のファイルを探させず、Web サービスが、サービスのデプロイ時に WebLogic Server から WS-Policy ファイルを取得することを通知しています。| 注意 : | 共有 Java EE ライブラリは、さまざまなエンタープライズ アプリケーション内にパッケージ化されている複数の Web サービスと WS-Policy ファイルを共有する場合に有用です。WS-Policy ファイルが共有 Java EE ライブラリの META-INF/policies または WEB-INF/policies ディレクトリに置かれている限り、ポリシー ファイルは Web サービスの同じアーカイブにパッケージ化されている場合と同様に指定できます。ライブラリの作成、および Web サービスがポリシー ファイルを見つけることができるようにするための環境設定については、『WebLogic Server アプリケーションの開発』の「共有 Java EE ライブラリおよびオプション パッケージの作成」を参照してください。 |
http: プレフィックスを使用する。@Policy(uri="http://someSite.com/policies/mypolicy.xml"
direction=Policy.Direction.both,
attachToWsdl=true)
direction 属性を Policy.Direction.inbound または Policy.Direction.outbound に設定すると変更できます。uri で指定されるポリシー ファイル内で wsp:optional 属性を使用し、Web サービスでオペレーションが確実に呼び出され、その応答が確実に配信されるよう要求するかどうかを指定できます。
任意のオペレーションでの発信に対して optional 属性を false に設定する場合 :
<wsrm: Offer...>。WS-ReliableMessaging 仕様を参照) を提供する必要がある。
すべてのオペレーションでの発信に対して optional 属性を true に設定する場合 :
@Policy アノテーションの attachToWsdl 属性を設定して、ポリシー ファイルを Web サービスのパブリック規約が記述された WSDL ファイルに付加するかどうかを指定できます。通常は、クライアント アプリケーションで Web サービスの信頼性のあるメッセージング機能が認識されるよう、パブリックなものとしてポリシーを公開します。そのため、この属性のデフォルト値は true です。
@Policy アノテーションの詳細については、『WebLogic Web サービス リファレンス』の「weblogic.jws.Policy」を参照してください。
信頼性のある Web サービスのオペレーションを同期的に呼び出す (すなわち、非同期の要求と応答機能を使用しない) 場合は、実装メソッドに @Oneway アノテーションを付けて、そのメソッドが一方向のものであることを指定する必要があります。つまり、メソッドは値を返すことができず、明示的に void を返すことになります。
反対に、メソッドに @Oneway アノテーションが付いていなければ、非同期の要求と応答機能を使用して呼び出す必要があります。オペレーションの呼び出し方法がわからない場合は、同期と非同期の 2 種類のオペレーションを作成することを検討してください。
「非同期の要求と応答を使用した Web サービスの呼び出し」および「非同期機能の併用」を参照してください。
信頼性のあるメッセージを内部に格納するために WebLogic Server が使用する JMS キューの JNDI 名を指定するには、@BufferQueue アノテーションを使用します。JNDI 名は、「送り先 WebLogic Server インスタンスのコンフィグレーション」の手順 4 での JMS キューの作成時にコンフィグレーションしたものです。
@BufferQueue アノテーションは、省略可能です。これを JWS ファイルで指定しなければ、WebLogic Server は weblogic.wsee.DefaultQueue の JNDI 名を持つキューを使用します。ただし、それでもこの JNDI 名を持つ JMS キューを Administration Console で明示的に作成する必要はあります。
@BufferQueue アノテーションの詳細については、『WebLogic Web サービス リファレンス』の「weblogic.jws.BufferQueue」を参照してください。
@ReliabilityBuffer アノテーションは、WebLogic Server による JMS キューから Web サービス実装へのメッセージ配信試行回数、およびサーバが待機すべき再試行間隔の指定に使用します。
再試行回数の指定には retryCount 属性を、待機時間の指定には retryDelay 属性を使用します。retryDelay 属性の形式としては、数字の後に以下の文字列のうち 1 つを続けます。
たとえば、再試行回数を 20、再試行の遅延を 2 日と指定するには、次の構文を使用します。
@ReliabilityBuffer(retryCount=20, retryDelay="2 days")
再試行の回数と遅延のデフォルト値はそれぞれ、3 と 5 です。
@ReliabilityBuffer アノテーションの詳細については、『WebLogic Web サービス リファレンス』の「weblogic.jws.ReliabilityBuffer」を参照してください。
必要に応じて、アプリケーションのデプロイメント プランを更新し、weblogic-webservices.xml 記述子に格納される、信頼性のある Web サービスの信頼性のあるメッセージ コンフィグレーション オプションを編集することができます。新しい値は、デプロイメント プランにより、現在のアプリケーションの記述子の特定の場所に関連付けられます。デプロイメント時に、デプロイメント プランは変数割り当ての値を、その変数のリンク先アプリケーション記述子内の場所に適用することによって、そのアプリケーション内の記述子に結合されます。
次の表に、信頼性のある Web サービスに対してコンフィグレーション可能な信頼性のあるメッセージング オプションをまとめます。詳細については、Administration Console オンライン ヘルプの「Web サービス : コンフィグレーション : ポート コンポーネント : 信頼性のあるメッセージ」を参照してください。
信頼性のあるメッセージング コンフィグレーション オプションは、Administration Console や WLST を使用して設定できます。以降の節を参照してください。
Administration Console を使用してアプリケーションのデプロイメント プランを更新し、信頼性のあるメッセージングをコンフィグレーションするには、[コンフィグレーション｜ポート コンポーネント] タブの下にある [デプロイメント] テーブルの信頼性のある Web サービスの信頼性のあるメッセージング コンフィグレーション オプションにアクセスします。Administration Console の起動と Web サービス デプロイメントへのアクセスについては、『JAX-RPC を使用した WebLogic Web サービスの開始』の「Administration Console の起動」を参照してください。
アプリケーションのデプロイメント プランを更新して信頼性のあるメッセージングをコンフィグレーションする際に WLST を使用する詳細や例については、『WebLogic Scripting Tool ガイド』の「Updating a Deployment Plan」を参照してください。
以下の表に、WS-RM コンフィグレーション オプションの XPath 値を参考としてまとめます。
WebLogic クライアント API を使用している場合は、信頼性のある Web サービスを Web サービス内から呼び出す必要があります。スタンドアロンのクライアント アプリケーションからは呼び出せません。
次の例では、「信頼性のある JWS ファイルに関するプログラミングのガイドライン」で説明した、サービスから信頼性のあるオペレーションを呼び出す Web サービス用の簡単な JWS ファイルを示します。
package examples.webservices.reliable;
import java.rmi.RemoteException;
import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.xml.rpc.Stub;
import weblogic.jws.WLHttpTransport;import weblogic.jws.ServiceClient;
import weblogic.jws.ReliabilityErrorHandler;
import examples.webservices.reliable.ReliableHelloWorldPortType;import weblogic.wsee.reliability.ReliabilityErrorContext;
import weblogic.wsee.reliability.ReliableDeliveryException;
import weblogic.wsee.reliability.WsrmUtils;@WebService(name="ReliableClientPortType",
serviceName="ReliableClientService")
@WLHttpTransport(contextPath="ReliableClient",
serviceUri="ReliableClient",
portName="ReliableClientServicePort")
public class ReliableClientImpl
{
@ServiceClient(
serviceName="ReliableHelloWorldService",
portName="ReliableHelloWorldServicePort") private ReliableHelloWorldPortType port;@WebMethod
public void callHelloWorld(String input, String serviceUrl)
throws RemoteException {
((Stub)port)._setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serviceUrl);WsrmUtils.setFinalMessage((Stub)port);port.helloWorld(input);
System.out.println(" Invoked the ReliableHelloWorld.helloWorld operation reliably."}
@ReliabilityErrorHandler(target="port")
public void onReliableMessageDeliveryError(ReliabilityErrorContext ctx) { ReliableDeliveryException fault = ctx.getFault();
String message = null;
if (fault != null) {
message = ctx.getFault().getMessage();
}
String operation = ctx.getOperationName();
System.out.println("Reliable operation " + operation + " may have not invoked.The error message is " + message);
}}
信頼性のある Web サービスを呼び出す JWS ファイルをプログラミングする際は、以下のガイドラインに従います。ガイドラインのサンプル コードは、上述のサンプル内では太字で示されています。
@ServiceClient および @ReliabitliyErrorHandler JWS アノテーションをインポートする。import weblogic.jws.ServiceClient;
import weblogic.jws.ReliabilityErrorHandler;
jwsc Ant タスクの <clientgen> 子要素によって後から作成されます。スタブ パッケージは、<clientgen> の packageName 属性によって指定され、スタブの名前は呼び出された Web サービスの WSDL によって決まります。import examples.webservices.reliable.ReliableHelloWorldPortType;
import weblogic.wsee.reliability.ReliabilityErrorContext;
import weblogic.wsee.reliability.ReliableDeliveryException;
import javax.xml.rpc.Stub;
import weblogic.wsee.reliability.WsrmUtils;
@ServiceClient JWS アノテーションを使用して、呼び出したい信頼性のある Web サービスの名前とポートを指定する。このアノテーションは、プライベート変数のフィールド レベルで指定します。この変数のデータ型は、呼び出している Web サービスの JAX-RPC ポート タイプとなります。 @ServiceClient(
serviceName="ReliableHelloWorldService",
portName="ReliableHelloWorldServicePort")
private ReliableHelloWorldPortType port;
port._setProperty メソッドを使用して、対象サービス エンドポイント アドレスを Web サービス クライアント内で動的に指定する。詳細については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「Web サービスの実行時情報へのアクセス」を参照してください。((Stub)port)._setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, serviceUrl);
setFinalMessage メソッドは、このメッセージがこのシーケンスで送信される最終メッセージであることを指定します。これにより、信頼性のあるメッセージング サブシステムは、信頼性のあるシーケンスをタイムアウトさせる前にクリーンアップすることができます。WsrmUtils.setFinalMessage((Stub)port);
@ServiceClient アノテーションを付けたスタブを使用して、信頼性のあるオペレーションを呼び出す。port.helloWorld(input);
オペレーションは一方向のものとしてマークされているので、値は返しません。
@weblogic.jws.ReliabilityErrorHandler アノテーションを付ける。@ReliabilityErrorHandler(target="port")
public void onReliableMessageDeliveryError(ReliabilityErrorContext ctx) {
ReliableDeliveryException fault = ctx.getFault();
String message = null;
if (fault != null) {
message = ctx.getFault().getMessage();
}
String operation = ctx.getOperationName();
System.out.println("Reliable operation " + operation + " may have not invoked.The error message is " + message);
}
このメソッドは、唯一のパラメータとして ReliabilityErrorContext を取り、void を返します。
このエラー処理メソッドのプログラミングに関する詳細については、『WebLogic Web サービス リファレンス』の「weblogic.jws.ReliabilityErrorHandler」を参照してください。
クライアント Web サービスをプログラミングする際、以下のガイドラインに従います。
build.xml ファイルを更新し、信頼性のある Web サービスのオペレーションを呼び出す JWS ファイルを生成するには、次のような taskdefs および build-reliable-client ターゲットを追加します。
<taskdef name="jwsc"
classname="weblogic.wsee.tools.anttasks.JwscTask" />
<target name="build-reliable-client">
<jwsc
enableAsyncService="true"
srcdir="src"
destdir="${client-ear-dir}" >
<jws file="examples/webservices/reliable/ReliableClientImpl.java">
<clientgen
wsdl="http://${wls.destination.host}:${wls.destination.port}/ReliableHelloWorld/ReliableHelloWorld?WSDL"
packageName="examples.webservices.reliable"/></jws>
</jwsc>
</target>
jwsc Ant タスクの完全なクラス名を定義するには、taskdef Ant タスクを使用します。
クライアント Web サービスをコンパイルする jwsc Ant タスクを更新して、<jws> 要素の <clientgen> 子要素を含めます。これにより、デプロイされた ReliableHelloWorld Web サービスの JAX-RPC スタブが生成およびコンパイルされるようになります。jwsc Ant タスクでは、これらのスタブが生成された WAR ファイルに自動的にパッケージ化されるため、即座にクライアント Web サービスからアクセスできるようになります。このようにするのは、生成されたクラスの 1 つを ReliableClientImpl JWS ファイルでインポートして使用するためです。
次に、信頼性のある Web サービスを実装し、MTOM/XOP を使用して SOAP メッセージ内の xs:base64Binary 型の XML データの転送を最適化する簡単な JWS ファイルの例を示します。コーディング ガイドラインとして、サンプル コードの後の説明を参照してください。このガイドラインは Java コード内の太字部分に対応しています。このサンプルは、「信頼性のある Web サービスを呼び出す JWS ファイルに関するプログラミングのガイドライン」のサンプルを元に作成しています。
package examples.webservices.reliable;
import javax.jws.WebMethod;
import javax.jws.WebService;
import javax.jws.Oneway;
import weblogic.jws.WLHttpTransport;
import weblogic.jws.ReliabilityBuffer;
import weblogic.jws.BufferQueue;
import weblogic.jws.Policy;import weblogic.jws.Policies;
/**
* 簡単な信頼性のある Web サービス
*/
@WebService(name="ReliableHelloWorldPortType",
serviceName="ReliableHelloWorldService")
@WLHttpTransport(contextPath="ReliableHelloWorld",
serviceUri="ReliableHelloWorld",
portName="ReliableHelloWorldServicePort")
@Policies({@Policy(uri="ReliableHelloWorldPolicy.xml",
direction=Policy.Direction.both,
attachToWsdl=true),
@Policy(uri = "policy:Mtom.xml")})@BufferQueue(name="webservices.reliable.queue")public class ReliableHelloWorldImpl {@WebMethod()
@Oneway()
@ReliabilityBuffer(retryCount=10, retryDelay="10 seconds")
public void helloWorld(String input) {
System.out.println(" Hello World " + input);}
@WebMethod
public byte[] echoBinary(byte[] bytes) {
return bytes;
}
}
MTOM を使用して信頼性のある Web サービスを呼び出す JWS ファイルをプログラミングする際は、以下のガイドラインに従います。ガイドラインのサンプル コードは、上述のサンプル内では太字で示されています。
Mtom.xml ファイルを現在の Web サービスに適用するには、@weblogic.jws.Policy アノテーションを使用する。複数の WS-Policy ファイル (信頼性のあるメッセージング ポリシー ファイルや MTOM ポリシー ファイルを含む) をグループ化するには、@weblogic.jws.Policies アノテーションを使用します。 @Policies({@Policy(uri="ReliableHelloWorldPolicy.xml",
direction=Policy.Direction.both,
attachToWsdl=true),
@Policy(uri = "policy:Mtom.xml")})byte[] データ型を戻り値または入力パラメータとして使用する。 public byte[] echoBinary(byte[] bytes) {
return bytes;
}| 注意 : | このリリースの WebLogic Server では、MTOM/XOP 使用時にサポートされる Java データ型は byte[] のみです。その他のバイナリ データ型 (image など) はサポートされていません。 |
WebLogic Server では、プロダクションの再デプロイメントがサポートされています。つまり、信頼性のある WebLogic Web サービスの更新後の新しいバージョンを、同じ Web サービスの古いバージョンと並行してデプロイできます。
WebLogic Server では、新しいクライアントのリクエストのみが新しいバージョンに転送されるように、クライアント接続が自動的に管理されます。再デプロイメント時にすでに Web サービスに接続していたクライアントは、作業が完了するまで古いバージョンのサービスを使用し続けます。作業が完了した時点で、自動的に古い Web サービスが廃止されます。クライアントが信頼性のある Web サービスに接続されている場合は、既存の信頼性のあるメッセージ シーケンスがクライアントによって明示的に終了されるか、またはタイムアウトになったときに、そのクライアントの作業が完了したと見なされます。
プロダクションの再デプロイメントと Web サービス クライアントの詳細については、『JAX-RPC を使用した WebLogic Web サービスの開始』の「Web サービスを再デプロイする際にクライアント側で考慮すべき事項」を参照してください。
信頼性のある Web サービスを呼び出すクライアント アプリケーションでは、直接オペレーションを呼び出すのではなく、プロキシ サーバを使用することがあります。プロキシを使用する理由としては、ファイアウォールの存在や、呼び出された Web サービスのクラスタへのデプロイメントなどがあります。
この場合、呼び出された Web サービスをホストする WebLogic Server インスタンスは、プロキシ サーバのアドレスとポートでコンフィグレーションされる必要があります。Web サービスがクラスタにデプロイされている場合は、そのクラスタ内のすべてのサーバをコンフィグレーションすることが必要です。
この手順では、ネットワーク接続を管理するためのコンフィグレーション可能な WebLogic Server の主要リソースであるネットワーク チャネルの作成方法について説明します。ネットワーク チャネルにより、クラスタのフロントエンド アドレスへのアクセスするための一貫性のある方法を提供できます。ネットワーク チャネルの詳細については、『WebLogic Server 環境のコンフィグレーション』の「ネットワーク チャネルについて」を参照してください。
weblogic-wsee-proxy-channel-XXX とする必要があります。XXX は、プロトコルを表します。たとえば、HTTPS 用のネットワーク チャネルを作成する場合、weblogic-wsee-proxy-channel-https という名前にします。
ネットワーク チャネルの作成に関する全般的な情報については、Administration Console オンライン ヘルプの「カスタム ネットワーク チャネルのコンフィグレーション」を参照してください。
-Dweblogic.wsee.skip.async.response=true Java システム プロパティを使用して WebLogic Server インスタンスを起動することによって、WebLogic Server プロキシ サーバ上の非同期応答サービスを無効にします。
デフォルトでは、すべての WebLogic Server インスタンスに、非同期の要求と応答機能を処理する内部非同期 Web サービスがデプロイされます。このシステム プロパティを指定しない場合、プロキシ サーバ上の非同期サービスが非同期メッセージを消費するため、非同期メッセージは要求したとおりにクラスタに到着しません。
|