Web サービスの開発
Web サービスとは、必要なものを完備した、オープン・スタンダードに基づくアプリケーションであり、Web を介して起動できます。Web サービスは、アプリケーションが容易かつ効果的に接続し対話する手段を提供します。これらのサービスは、社内で使用するアプリケーションのビルディング・ブロックとして、あるいは他社との対話の接点として使用できます。Web サービスのインターフェースは標準に従って定義されているので、非 Java ベース・アプリケーションとの対話が可能です。
HATS Web サービス・サポートを使用して、ホスト・アプリケーションに含まれるビジネス・ロジックおよびトランザクションに標準プログラミング・インターフェースを提供するサービス指向アーキテクチャー (SOA) 資産を作成できます。これらのコア・ビジネス・タスクは、お客様のビジネス・プロセスの統合計画に不可欠な要素である標準の Web サービスとして再利用できます。ご使用のコア・ビジネス・サービスをビルディング・ブロックとして使用して、新規の社内アプリケーションを開発するか、または社外のアプリケーションと統合します。次に、ご使用のホスト・ベースのビジネス・タスクは、IBM® WebSphere® Process Server、IBM WebSphere Enterprise Service Bus などの IBM SOA Foundation 製品を使用して、お客様の SOA ソリューションに含めることができます。
HATS Toolkit と Rational® SDP のツールを組み合わせて使用すれば、統合オブジェクトまたは EJB Access Beans から Web サービスを作成できます。
注:
Web 高速ログオンを使用するように構成された統合オブジェクトは、Web サービスには使用できません。
Web サービスでは、情報の標準的な編成方法として、Simple Object Access Protocol (SOAP)、Web Service Description Language (WSDL)、および Universal Description, Discovery, and Integration (UDDI) を使用します。本書では、これらのプロトコルを参照しますが、プロトコルの詳細は説明しません。これらのプロトコルについては、Rational SDP の資料をオープンし (任意の Rational SDP パースペクティブから「ヘルプ」>「ヘルプ目次」をクリック)、「Web サービス」を検索してください。
通常は、既に作成、テスト、および展開が完了した統合オブジェクトから、HATS Web サービスを作成します。この章では、Web サービスに組み込む 1 つ以上の統合オブジェクトがテスト済みであることを前提とします。ただし、まったく最初から始めることもできます。その場合は、ホスト端末をオープンし、1 つ以上のマクロを記録して、そのマクロから統合オブジェクトを作成し、その統合オブジェクトをテストしてください。マクロから統合オブジェクトを作成する方法については、「HATS ユーザーと管理者のガイド」を参照してください。
作成する Web サービスを Web Services Interoperability (WSI) 規格に準拠させるかどうかを決める必要があります。これによって、どの Web サービス・ランタイムを使用して Web サービスを作成するかが決まります。デフォルトの IBM WebSphere ランタイムを受け入れた場合、作成される Web サービスは WSI 準拠となります。
IBM WebSphere ランタイムを使用して Web サービスを作成する場合は、特定の命名規則に従う必要があります。この種のオブジェクトや設定には以下のものがあります。
- メソッド名の先頭の文字は、小文字とする。
- クラス名の先頭の文字は、大文字とする。
- メソッド名またはクラス名の中に、下線とそれに続く文字がある場合、その文字は大文字とする。
- メソッド名またはクラス名の中に、数字とそれに続く文字がある場合、その文字は大文字とする。
マクロ作成でマクロ名やプロンプト名、抽出名を作成する際は、これらの命名上の制約に注意してください。命名上の制約の詳細については、Rational SDP の資料を参照してください。
Web サービスの作成
統合オブジェクトからのボトムアップ Web サービスの作成
このセクションでの説明は、お客様が統合オブジェクト内のすべてのプロパティーとメソッドと同様の入力と出力のプロパティーとメソッドを備えた Web サービスを作成したいと考えていることを想定しています。言い換えれば、作成する Web サービスのシグニチャーを Web サービスに組み込まれた統合オブジェクトのシグニチャーと同様にしたいと考えていることが前提になります。このシナリオは、ボトムアップ Web サービスといいます。
注:
ナビゲーター・ビューに切り替えなくても、HATS プロジェクト表示から Web サービスを作成し、Web サービス・クライアントを生成することができるようになりました。
Web サービスを作成するには、「HATS プロジェクト」ビューにおいて以下の手順を実行します。
- 使用する統合オブジェクトが含まれるプロジェクトを展開し、続いてソース・フォルダー、IntegrationObject フォルダーを展開します。
- プロジェクト内にある任意の統合オブジェクトを右クリックして、「Web サービス・サポート・ファイルの作成」を選択します。
-
「Web サービス・サポート・ファイルの作成」ウィザードでは、Web サービスに組み込む統合オブジェクトのソースとして、任意のプロジェクトを選択できます。ここでクリックしたプロジェクトがデフォルトになります。HATS Web サービス・サポート・ファイルのクラス名を指定します。クラス名の先頭の文字は大文字にしてください。このクラスは、この Web サービスのラッパー・クラス と呼ばれます。
このラッパー・クラスを使用すれば、1 つの Web サービスに組み込む統合オブジェクトまたは EJB Access Bean の論理グループを選択できます。例えば、チェーンのすべての統合オブジェクトをラッパー・クラスに組み込むように選択できます。統合オブジェクトのリストを表示して、組み込む対象を選択するには、「次へ」を選択します。
- Web サービスに組み込むリソース (統合オブジェクトおよび EJB Access Bean) を選択します。特定のリソースについて Web サービスが公開する入出力のプロパティーを変更するには、リソースを選択し、「プロパティー」をクリックします。
- 「プロパティーの選択」ページで、Web サービスで公開する入出力のプロパティーを選択します。プロパティーの別名を「別名」フィールドに指定することもできます。「全選択」ボタン、「全選択解除」ボタン、および「デフォルトを選択」ボタンを使用して、プロパティーを選択してください。「OK」をクリックします。
注:
- 単一統合オブジェクトおよび EJB Access Bean のデフォルトは、入力プロパティーについては全マクロ・プロンプト、出力プロパティーについては全マクロ抽出です。
- チェーニングされた統合オブジェクトのデフォルトは、入力プロパティーについては、全マクロ・プロンプトと hPubLinkKey (必須)、出力プロパティーについては、全マクロ抽出と hPubLinkKey (必須) です。
- チェーニングされた EJB Access Bean のデフォルトは、入力プロパティーについては、全マクロ・プロンプトと hPubLinkKey および hPubAccessHandle (両者必須)、出力プロパティーについては、全マクロ抽出と hPubLinkKey および hPubAccessHandle (両者必須) です。
- 以下の入出力のプロパティーもデフォルトとして選択されます。これらは、双方向セッションを使用する、統合オブジェクトおよび EJB Access Bean の場合に必須です。
- hExtractRTLTextOrientation
- hExtractReordering
- hPreventBidiRoundTrip
- hPromptRTLTextOrientation
- hPromptReordering
- 統合オブジェクトの接続オーバーライドが Web サービスに公開されるよう指定するには、hPubConnectionOverrides プロパティーや hPubStartPoolName プロパティーなど、デフォルトでは選択されない適切なプロパティーを選択する必要があります。詳しくは、接続オーバーライドの指定を参照してください。
- 他の統合オブジェクト・メソッドの使用について詳しくは、統合オブジェクトを使用したプログラミングを参照してください。
- 「完了」をクリックします。HATS は Web サービスの作成に使用するクラスのセットを作成します。以下のクラスが、「HATS プロジェクト」ビューの Source\webserviceclasses フォルダーに表示されます。
- 指定したラッパー・クラス。このラッパー・クラスには、ラッパー・クラスに組み込むように選択された各統合オブジェクトの io_nameProcessWS() メソッドがあります。Rational
SDP ウィザードを使用して Web サービスを作成すると、ラッパー・クラス内のすべての io_nameProcessWS() メソッドを含む Web サービスが作成されます。
- ラッパー・クラスに組み込まれた各統合オブジェクトの入力プロパティー・クラス (io_name_Input_Properties)。入力プロパティー・クラスは、統合オブジェクトに必要なすべての入力の設定に使用されます。
- ラッパー・クラスに組み込まれた各統合オブジェクトの出力プロパティー・クラス (io_name_Output_Properties)。すべての統合オブジェクトの出力プロパティーは、出力プロパティー・クラスから検索できます。
- これで、IBM Rational SDP で提供されるツールを使用した Web サービスの作成の準備が整いました。このボトムアップ Web サービスの開発の章を参照しながら、使用可能な手順とオプションを理解してください。
Web サービスの作成を続ける前に、少なくとも Web サービスを展開する予定のサーバーは始動しておいてください。これらの説明では、Web サービスの作成、Web サービスのテスト、および Web サービス・クライアントの作成に別々の手順を使用することを想定しています。
-
webserviceclasses パッケージを展開します。作成したラッパー・クラスを右マウス・ボタンでクリックし、「Web サービス」>「Web サービスの作成」を選択します。「Web サービス・タイプ」は、デフォルトでは「ボトムアップ Java™ Bean Web サービス」になります。必ずこのデフォルトのままにしてください。ここで「完了」をクリックするか、または Rational SDP 資料で説明されている、お客様の要件に最適な他のオプションを選択することができます。オプション「WSDL ファイルをプロジェクトに生成する」を選択すると、Rational SDP によって、Web サービスのインターフェースを記述した Web Services Description Language (WSDL) ファイルが作成されます。この WSDL ファイルは、HATS プロジェクト表示の Web サービス・エクスプローラーを使用する Web サービスをテストするために使用することができます。このオプションを選択しない場合、動的に生成された WSDL ファイルを使用して、Java EE パースペクティブのサービス・ビューの Web サービスをテストすることができます。すべての選択を完了したら、「完了」をクリックしてください。
- クライアントを作成する前に Web サービスをテストするため、Web Services Explorer による Web サービスのテストに進んでください。
EJB Access Bean からの Web サービスの作成
HATS EJB アプリケーションの作成と使用の説明に従って HATS EJB プロジェクトを作成した場合は、その HATS EJB プロジェクト内の統合オブジェクトのサービスを使用する Web サービスを作成できます。Web サービスを作成するには、ご使用の HATS EJB プロジェクトと同じ Enterprise Archive (EAR ファイル) 内に別の HATS プロジェクトが必要です。このプロジェクトを、ターゲット・プロジェクト と呼びます。この中で選択した EJB Access Bean から Web サービスが作成されます。Web サービスを作成するには、以下の手順を実行します。
- 「HATS EJB プロジェクト表示」で、統合オブジェクトの 1 つを右マウス・ボタンでクリックして、「HATS プロジェクトへの EJB Access Bean のエクスポート」を選択します。「EJB Access Bean のエクスポート」ウィンドウで、EJB Access Bean をエクスポートする統合オブジェクトを選択します。選択可能なプロジェクトのドロップダウン・リストから、ターゲット・プロジェクトを選択します。「完了」をクリックします。
- 「HATS プロジェクト」ビューで、ターゲット・プロジェクトを展開し、続いてソース・ディレクトリー、IntegrationObject ディレクトリーを展開します。このディレクトリーでは、io_name_Access という名前の項目が表示されます。ここで io_name は、作成された Access Bean の基となった統合オブジェクトの名前を表します。
- これらの Access Bean のいずれかを右マウス・ボタンでクリックして、「HATS Web サービス・サポート・ファイルの作成 (Create HATS Web Services Support Files)」を選択します。
- 統合オブジェクトからのボトムアップ Web サービスの作成の手順リストのステップ 3 以降の手順を実行してください。
Web Services Explorer による Web サービスのテスト
クライアント・アプリケーションを作成する前に、Rational SDP で Web サービスをテストできます。
このプロセスを開始する前に、HATS ランタイムが開始されていることを確認してください。これを行うには、ご使用のサーバーを始動した後、「サーバー」ビューで該当の Web サービスが含まれている EAR ファイルを選択して右クリックし、「再始動」を選択します。
オプション「WSDL ファイルをプロジェクトに生成する」 を選択した場合は、統合オブジェクトからのボトムアップ Web サービスの作成 にあるリスト内のステップ8を参照してください。作成した WSDL ファイルは HATS プロジェクト内にあります。
- IBM WebSphere の JAX-RPC ランタイムまたは JAX-WS ランタイム用の Web サービスを作成している場合は、Web Content/WEB-INF/Web
Service Definitions フォルダーにあります。
- Apache Axis ランタイム用の Web サービスを作成した場合は、Web Content/Web Service Definitions フォルダーにあります。
このフォルダーには wrapper.wsdl という名前のファイルがあります。ここで wrapper は、ラッパー・クラスに付けた名前を表します。このファイルを右マウス・ボタンでクリックして、「Web サービス」>「Web サービス・エクスプローラーでのテスト」を選択してください。
Web Services Explorer の右ペインに、Web サービスに組み込まれた各統合オブジェクトまたは EJB Access Bean の io_nameProcessWS() メソッドが表示されます。テストする統合オブジェクトのメソッド名をクリックします。この統合オブジェクトについて指定可能な入力プロパティーのリストが表示されます。このリストは、その統合オブジェクトの io_name_Input_Properties クラスに基づきます。マクロを記録したときに定義したプロンプトのプロパティーだけは、必ず設定してください。その他のプロパティーは、ブランクのままにすることができます。Web Services Explorer の WSDL 表示を使用して Web サービス定義を検索し、テストする方法については、Rational SDP の資料を参照してください。
オプション「WSDL ファイルをプロジェクトに生成する」を選択しなかった場合は、統合オブジェクトからのボトムアップ Web サービスの作成にあるリスト内のステップ 8を参照してください。動的に生成された WSDL ファイルを使用して、Java EE パースペクティブのサービス・ビューの Web サービスをテストすることができます。
Web サービス・クライアントの作成
次に、Web サービスを使用するクライアント・アプリケーションを作成します。以下のようにします。
- プロジェクトを展開し、Web サービスを作成した際に選択した Web サービス・ランタイム用の適切なフォルダーを展開します。作成した WSDL ファイルは、以下の HATS プロジェクト内に配置されます。
- IBM WebSphere の JAX-RPC ランタイムまたは JAX-WS ランタイム用の Web サービスを作成した場合は、Web Content/WEB-INF/ Web Service Definitions フォルダーにあります。
- Apache Axis ランタイム用の Web サービスを作成した場合は、Web Content/Web Service Definitions フォルダーにあります。
このフォルダーには wrapper.wsdl という名前のファイルがあります。ここで wrapper は、ラッパー・クラスに付けた名前を表します。
- このファイルを右クリックして、「Web サービス」>「クライアントを生成」を選択します。これにより、「Web サービス・クライアント・プロキシー (Web Service Client Proxy)」ウィザードが開始します。このウィザードの先頭ページで、クライアント・プロジェクトを除くすべてのデフォルトを選択することができます。
Web サービスを含むプロジェクト以外のプロジェクトを選択してください。
注:
指定したクライアント・プロジェクトと Ear プロジェクトには、選択したサーバーと同じサーバー・ターゲットが必要です。
ここで「完了」をクリックすることもでき、ウィザードを続けることもできます。このウィザードのオプションの詳細については、Rational SDP の資料を参照してください。
- 「Web サービスのテスト」を選択すると、ウィザードによって JSP のサンプル・ページが作成され、そのサンプルがサーバー上で実行されます。
JSP ページのサンプルの出力結果は Web ブラウザーに表示されます。サンプルを「メソッド」フレームで実行するには、io_nameProcessWS リンクをクリックし、特定の統合オブジェクトまたは EJB Access Bean をテストします。「入力」 フレームでは、Web Services Explorer による Web サービスのテストの説明のとおり、必須入力データを設定します。「結果 (Result)」 フレームに出力が表示されます。
こうしてクライアント・プロジェクトにサンプル・ページが作成されます。ナビゲーター・ビューでクライアント・プロジェクトを展開し、続いて「Web コンテンツ」および samplewrapperProxy を展開します。JSP ページのサンプルは、 samplewrapperProxy フォルダーにあります。サーバーで TestClient.jsp ファイルを実行してサンプルを実行できます。Result.jsp をダブルクリックすると、JSP エディターでこのファイルがオープンします。コードを調べて、このサンプルのコードを、画面カスタマイズから実行できる HATS ビジネス・ロジック・クラスにコピーすることができます。これにより、Web サービスを起動し、この出力を変換またはその他の方法で使用することができます。
統合オブジェクトを含むトップダウン Web サービスの作成
開発タスクでは、トップダウン Web サービスの作成を必要とする場合があります。この場合、Web サービスの指定されたシグニチャーが格納された WSDL が提供されます。このようなタスクでは、Web サービス・インプリメンテーションを作成します。このインプリメンテーションの一部には、既存の端末のアプリケーションとの対話を伴います。
WSDL 内の入力パラメーターに統合オブジェクト用の必須の入力プロパティーが含まれているか、またはこの入力パラメーターに基づいて、統合オブジェクトの必須の入力プロパティーを設定するコードを作成できる場合は、ご使用の Web サービス・インプリメンテーション内で直接統合オブジェクトを使用できます。
Rational SDP には、既存の WSDL からスケルトンの Java Bean を作成するためのツールが含まれています。また、このスケルトンの Java Bean から直接統合オブジェクトと対話することができます。詳しくは、統合オブジェクトを使用したプログラミングを参照してください。
1 つの注意点は、Web サービス・ランタイム環境での統合オブジェクトの呼び出しには processRequest() メソッドを使用する必要があるということです。
概要を参照してください。
Web サービスの統合オブジェクトおよび EJB Access Bean を使用したプログラミング
統合オブジェクトと Web サービスのチェーニング
作成したアプリケーションにチェーニングが必要な場合は、クライアント・コードで、チェーンの最初の統合オブジェクトから hPubLinkKey プロパティーを検索し、それをチェーン内の後続するすべての統合オブジェクトに設定する必要があります。
EJB Access Bean と Web サービスのチェーニング
作成したアプリケーションにチェーニングが必要な場合は、クライアント・コードで、チェーンの最初の EJB Access Bean から hPubLinkKey プロパティーと hPubAccessHandle プロパティーを検索し、それらをチェーン内の後続するすべての EJB Access Bean に設定する必要があります。
Web サービスのチェーニングに関する特別な考慮事項
チェーニングされた統合オブジェクトを HATS Web サービス内で使用する場合は、ステートフルな Web サービスを作成していることになります。
HATS ランタイムは、同じ Web サービス内にあるチェーニングされた統合オブジェクトの呼び出しと呼び出しの間でデータを保管しません。しかし、HATS ランタイムでは、チェーン内の次の Web サービスの呼び出しを、その HATS ランタイムの同じインスタンスに戻るようにルーティングする必要があるため、チェーン内の次の IO は、同じ Telnet 接続を使用します。
JAX-RPC サポートを使用するステートフル HATS Web サービスをクラスターにデプロイする場合は、チェーン内のすべての統合オブジェクトが同じ Telnet 接続を使用できるよう、以下のいずれかを実行してください。
- EJB Access Bean から HATS Web サービスを作成します。
HATS EJB はステートフル・セッション EJB であるため、EJB クライアントは常に同じ HATS EJB インスタンスと対話します。
- Web サービスの有効範囲がセッションになるように構成し (これは開発環境内で行うことも、展開後に行うこともできます)、Web サービス・クライアント・ランタイムで SESSION_MAINTAIN_PROPERTY を使用して複数の呼び出し間でセッションを維持することによって、HTTP セッションの親和性を確保します。ステートフルな Web サービスについて詳しくは、http://www-128.ibm.com/developerworks/webservices/library/ws-tip-stateful.html を参照してください。
SESSION_MAINTAIN_PROPERTY に関する問題を修正する WebSphere APAR PK35259 が必要になる場合があることに注意してください。
JAX-WS サポートを使用するステートフル HATS Web サービスをクラスターに展開する場合は、チェーン内のすべての統合オブジェクトが同じ Telnet 接続を使用できるよう、以下のいずれかを実行してください。
Web サービスの更新
「更新」ウィザードは、HATS 7.0.0.2 以上で作成された Web サービス・クラスの場合にのみ使用できます。それより前のバージョンを使用している場合は、手動で更新を行う必要があります。
HATS Web サービスのサポート・クラスを更新するには、以下のようにします。
- 更新する既存の Web サービス・ラッパー・クラスを選択します。
- Web サービス・クラスが事前選択された状態で「Web サービスの更新 (Update Web service)」ウィザードが起動します。
- Web サービスに組み込む統合オブジェクトまたは EJB Access Bean の選択を変更する必要がない場合は、「完了」を選択して Web サービスのサポート・クラスを再生成します。それ以外の場合は、「次へ」を選択してウィザードの次のページに進みます。
- Web サービス・ラッパー・クラスに組み込むリソースのリスト (統合オブジェクトおよび EJB Access Bean) を変更します。特定のリソースについて Web サービスが公開する入出力のプロパティーを変更するには、リソースを選択し、「プロパティー」をクリックします。
- 「プロパティーの選択」ページで、Web サービスで公開する入出力のプロパティーを選択します。プロパティーの別名を「別名」フィールドに指定することもできます。「全選択」ボタン、「全選択解除」ボタン、および「デフォルトを選択」ボタンを使用して、プロパティーを選択してください。「OK」をクリックします。
注:
- 単一統合オブジェクトおよび EJB Access Bean のデフォルトは、入力プロパティーについては全マクロ・プロンプト、出力プロパティーについては全マクロ抽出です。
- チェーニングされた統合オブジェクトのデフォルトは、入力プロパティーについては、全マクロ・プロンプトと hPubLinkKey (必須)、出力プロパティーについては、全マクロ抽出と hPubLinkKey (必須) です。
- チェーニングされた EJB Access Bean のデフォルトは、入力プロパティーについては、全マクロ・プロンプトと hPubLinkKey および hPubAccessHandle (両者必須)、出力プロパティーについては、全マクロ抽出と hPubLinkKey および hPubAccessHandle (両者必須) です。
- 以下の入出力のプロパティーもデフォルトとして選択されます。これらは、双方向セッションを使用する、統合オブジェクトおよび EJB Access Bean の場合に必須です。
- hExtractRTLTextOrientation
- hExtractReordering
- hPreventBidiRoundTrip
- hPromptRTLTextOrientation
- hPromptReordering
- 統合オブジェクトの接続オーバーライドが Web サービスに公開されるよう指定するには、hPubConnectionOverrides プロパティーや hPubStartPoolName プロパティーなど、デフォルトでは選択されない適切なプロパティーを選択する必要があります。詳しくは、接続オーバーライドの指定を参照してください。
- 他の統合オブジェクト・メソッドの使用について詳しくは、統合オブジェクトを使用したプログラミングを参照してください。
- 「完了」をクリックします。
HATS Web サービスのサポート・ファイルが再生成およびコンパイルされます。
HATS Web サービスのサポート・ファイルを更新した後、Web サービスを更新するには、引き続き Rational SDP のウィザードを使用する必要があることに注意してください。
JAX-WS ランタイム用 Web サービスの考慮事項および制限事項
WebSphere Application Server Version 6.1 Feature Pack for Web Services がインストールされている場合は、IBM WebSphere Java API for XML-Based Web Services (JAX-WS) ランタイム用の HATS Web サービスを作成できます。
JAX-WS ランタイム用の HATS Web サービスを作成する場合は、以下の点に留意してください。
- テスト・クライアントを生成すると、WSDL ファイルの絶対ロケーションがハードコーディングされた web_service_nameService.java ファイルが作成されます。別のマシンにテスト・クライアントをデプロイするときは、このファイルを更新して、WSDL ファイルの正しいロケーションを含めてください。
- Web サービス用に生成することを選択した WSDL ファイルには、Web サービスの URL ロケーションが含まれます。この URL は、ローカル・ホストおよびポートを指します。別のサーバーに Web サービスをデプロイするときは、URL のこのローカル・ホストおよびポートを更新してください。