WebLogic Web サービス入門

     前  次    新しいウィンドウで目次を開く     
ここから内容の開始

Web サービスの呼び出し

この章では、WebLogic Web サービスを呼び出す方法について説明します。

注意 : 以下の節では、メッセージ保護された Web サービスの呼び出しについては説明していません。メッセージ保護された Web サービスの呼び出しについては、Web サービス セキュリティ ガイドの節、「クライアント アプリケーションの更新によるメッセージ保護された Web サービスの呼び出し」を参照してください。
警告 : JAX-RPC 1.1 および JAX-WS 2.0 は双方ともこのリリースの WebLogic Server でサポートされていますが、このマニュアルでは、ほぼ JAX-RPC 形式の Web サービスの作成方法のみに絞って説明しています。なぜならこのリリースでは、すべての WS-* 仕様 (WS-Security、WS-ReliableMessaging など) および付加価値の高い WebLogic の機能 (非同期の要求と応答、コールバックなど) が、JAX-RPC 形式の Web サービスでのみ有効であるからです。したがって、別段の記述がなければ、すべての説明および例は、JAX-RPC Web サービスについてのものであると見なされます。
注意 : JAX-WS Web サービスの作成と呼び出しの詳細については、「JAX-WS 2.0 Web サービスの実装」を参照してください。

 


Web サービスの呼び出しの概要

Web サービスの呼び出しは、クライアント アプリケーションが Web サービスを使用するために実行するアクションです。Web サービスを呼び出すクライアント アプリケーションは、Java、Microsoft .NET などの任意のテクノロジを使用して記述できます。

注意 : ここで説明する「クライアント アプリケーション」としては、2 種類のクライアントが考えられます。1 つはスタンドアロン クライアントで、WebLogic クライアント クラスを使用して WebLogic Server 上または他のアプリケーション サーバ上でホストされる Web サービスを呼び出します。このマニュアルでいう「スタンドアロン クライアント」とは、WebLogic Server から独立した実行時環境を持つクライアントのことを指します。Web サービスを呼び出すもう 1 種類のクライアント アプリケーションは、EJB や他の Web サービスなど、WebLogic Server にデプロイされている Java Platform, Enterprise Edition (Java EE) バージョン 5 コンポーネント内で実行されるものです。

以降の節では、JAX-RPC 仕様 (バージョン 1.1) の BEA の実装を使用して Java クライアント アプリケーションから Web サービスを呼び出す方法について説明します。この実装を使用することで、WebLogic および非 WebLogic にかかわらず任意のアプリケーション サーバで実行されている Web サービスを呼び出すことができます。さらには、スタンドアロン クライアント アプリケーションまたは WebLogic Server の一部として実行されるクライアント アプリケーションのどちらも作成できます。

警告 : ユーザ定義のデータ型をパラメータまたは戻り値として実装する Web サービス オペレーションを、動的クライアントを使用して呼び出すことはできません。動的クライアントでは、JAX-RPC の Call インタフェースを使用するためです。標準の (静的) クライアントでは、JAX-RPC の Service インタフェースおよび Stub インタフェースを使用するため、ユーザ定義のデータ型を実装する Web サービスを正常に呼び出すことができます。

クライアント アプリケーションの種類

この節では、以下の 2 種類のクライアント アプリケーションについて説明します。

JAX-RPC

Java API for XML based RPC (JAX-RPC) は、Web サービスの呼び出しに使用する API を定義する Sun Microsystems の仕様です。WebLogic Server には、JAX-RPC 1.1 仕様の実装が組み込まれています。

次の表で、JAX-RPC の中心的なインタフェースとクラスを簡単に説明します。

表 8-1 JAX-RPC のインタフェースとクラス
javax.xml.rpc のインタフェースまたはクラス
説明
Service
主要なクライアント インタフェース。
ServiceFactory
Service インスタンスの生成に使用するファクトリ クラス。
Stub
Web サービスのオペレーションを呼び出すためのクライアント プロキシの基本クラス。
Call
Web サービスを動的に呼び出すのに使用する。
JAXRPCException
Web サービスの呼び出し中にエラーが発生した場合に送出される例外。

JAX-RPC の詳細については、http://java.sun.com/xml/jaxrpc/index.html を参照してください。

clientgen Ant タスク

clientgen WebLogic Web サービス Ant タスクは、クライアント アプリケーションが WebLogic Web サービスと非 WebLogic Web サービスの両方の呼び出しに使用できるクライアント アーティファクトを既存の WSDL ファイルから生成します。以下のようなアーティファクトがあります。

clientgen Ant タスクの詳細 (使用可能なすべての属性など) については、「Ant タスク リファレンス」を参照してください。

警告 : このリリースの WebLogic Server でサポートされている clientgen Ant タスクの完全修飾名は、weblogic.wsee.tools.anttasks.ClientGenTask です。これは、WebLogic Server バージョン 8.1 でサポートされている clientgen Ant タスクの完全修飾名 (weblogic.webservice.clientgen) とは異なります。
警告 : 8.1 の clientgen Ant タスクはこのリリースの WebLogic Server でもサポートされていますが、これは非推奨です。9.X WebLogic Web サービスを呼び出すクライアント アーティファクトを生成したい場合は、8.1 バージョンではなく 9.X バージョンの clientgen を使用するようにしてください。たとえば、8.1 Web サービスを 10.0 にアップグレードしたにもかかわらず、Ant スクリプトで完全修飾名を使用しているため、8.1 clientgen Ant タスクが明示的に呼び出されるようになっている場合は、それらの Ant スクリプトを変更して 9.X clientgen が呼び出されるようにする必要があります。

Web サービスを呼び出すクライアントの例

WebLogic Server の WL_HOME/samples/server/examples/src/examples/webservices ディレクトリには、WebLogic Web サービスの作成と呼び出しのサンプルがあります。WL_HOME は、WebLogic Server のメイン ディレクトリです。

サンプルのビルドおよび実行方法の詳細については、ブラウザで Web ページ WL_HOME/samples/server/docs/index.html を開いて [WebLogic Server Examples|Examples|API|Web Services] ノードを展開してください。

 


スタンドアロン クライアントからの Web サービスの呼び出し : 主な手順

以下の手順では、開発環境でのクライアント アプリケーションのビルドや Java ファイルのコンパイルなどに Ant を使用することを前提としています。また、Web サービスのクライアント タスクで更新する必要のある build.xml ファイルが、すでにあることを想定しています。

開発環境での Ant の使用については、「基本的な Ant build.xml ファイルの作成」を参照してください。この節で使用する build.xml ファイルのサンプルの全体については、「スタンドアロン Java クライアントのサンプル Ant ビルド ファイル」を参照してください。

Web サービスを呼び出す Java スタンドアロン クライアント アプリケーションを作成するには、次の手順に従います。

  1. コマンド シェルを開き、環境を設定します。
  2. Windows NT では、ドメイン ディレクトリにある setDomainEnv.cmd コマンドを実行します。WebLogic Server ドメインのデフォルトの場所は、BEA_HOME\user_projects\domains\domainName です。BEA_HOME は BEA Products の最上位のインストール ディレクトリで、domainName はドメインの名前です。

    UNIX では、ドメイン ディレクトリにある setDomainEnv.sh コマンドを実行します。WebLogic Server ドメインのデフォルトの場所は、BEA_HOME/user_projects/domains/domainName です。BEA_HOME は BEA Products の最上位のインストール ディレクトリ、domainName はドメインの名前です。

  3. build.xml ファイルを更新して、Web サービスの呼び出しに必要なクライアントサイド アーティファクトを生成する clientgen Ant タスクが実行されるようにします。
  4. クライアントのアーティファクトを生成するための clientgen Ant タスクの使用」を参照してください。

  5. Web サービスに関する情報 (そのオペレーションのシグネチャ、ポートの名前など) を取得します。
  6. Web サービスに関する情報の取得」を参照してください。

  7. Web サービス オペレーションを呼び出すためのコードを含むクライアント アプリケーションの Java コードを記述します。
  8. Web サービスを呼び出す Java クライアント アプリケーション コードの記述」を参照してください。

  9. Java クライアント アプリケーションをコンパイルし、実行します。
  10. クライアント アプリケーションのコンパイルと実行」を参照してください。

クライアントのアーティファクトを生成するための clientgen Ant タスクの使用

次のサンプルのように、build.xml ファイルを更新して clientgen Ant タスクに呼び出しを追加します。

  <taskdef name="clientgen"
classname="weblogic.wsee.tools.anttasks.ClientGenTask" />
  <target name="build-client">
    <clientgen
wsdl="http://${wls.hostname}:${wls.port}/complex/ComplexService?WSDL"
destDir="clientclasses"
packageName="examples.webservices.simple_client"/>
</target>

clientgen WebLogic Web サービス Ant タスクを実行するには、その前にこのタスクの完全な Java クラス名を標準の taskdef Ant タスクを使用して指定する必要があります。

クライアントサイド アーティファクトの作成に使用する WSDL ファイルと、そうしたアーティファクトの生成先ディレクトリを指定するには、clientgen Ant タスクの wsdl 属性と destDir 属性を含める必要があります。packageName 属性は省略できます。省略した場合は、WSDL の targetNamespace に基づくパッケージ名が使用されます。

注意 : clientgen Ant タスクの destFile 属性を使用すると、生成された Java ファイルを自動的にコンパイルして、すべてのアーティファクトを JAR ファイルにパッケージ化できます。詳細とサンプルについては、「clientgen」を参照してください。

WSDL ファイルで、Web サービス オペレーションの入力パラメータまたは戻り値としてユーザ定義のデータ型が指定されている場合、clientgen は WSDL に定義された XML スキーマ データ型の Java 表現である JavaBean クラスを自動的に生成します。JavaBean クラスは、destDir ディレクトリに生成されます。

注意 : ユーザ定義の Java データ型のパッケージは、WSDL のデータ型の XML スキーマに基づくもので、JAX-RPC スタブのパッケージ名とは異なります。

この手順で説明されている追加のターゲット (clean など) を含む、完全なサンプル build.xml ファイルについては、「スタンドアロン Java クライアントのサンプル Ant ビルド ファイル」を参照してください。

clientgen Ant タスクを他のサポート Ant タスクと一緒に実行するには、コマンドラインで build-client ターゲットを指定します。

prompt> ant build-client

clientclasses ディレクトリで、clientgen Ant タスクによって生成されたファイルやアーティファクトを確認します。

Web サービスに関する情報の取得

オペレーションを呼び出す Java クライアント アプリケーション コードの記述に先立って、Web サービスの名前とオペレーションのシグネチャを知る必要があります。Web サービスに関する情報を調べるにはさまざまな方法があります。

一番良いのは、clientgen Ant タスクを使用して Web サービス固有の JAX-RPC スタブを生成し、生成された *.java ファイルを調べる方法です。*.java ファイルは、destDir 属性で指定したディレクトリ内の packageName 属性の値に対応したサブディレクトリに生成されます。packageName 属性が指定されていない場合、WSDL の targetNamespace に基づくパッケージに対応したサブディレクトリに生成されます。

Web サービスの実際の WSDL を調べることもできます。デプロイされている WebLogic Web サービスの WSDL の詳細については、「Web サービスの WSDL の参照」を参照してください。Web サービス名は、次の TraderService WSDL の抜粋に示すように、<service> 要素内にあります。

  <service name="TraderService">
<port name="TraderServicePort"
binding="tns:TraderServiceSoapBinding">
...
</port>
</service>

この Web サービス用に定義されているオペレーションは、対応する <binding> 要素の下に記述されています。たとえば次の WSDL の抜粋は、TraderService Web サービスに buysell の 2 つのオペレーションがあることを示しています (わかりやすくするため、WSDL の関連部分のみを記載しています)。

  <binding name="TraderServiceSoapBinding" ...>
...
<operation name="sell">
...
</operation>
<operation name="buy">
</operation>
</binding>

Web サービスを呼び出す Java クライアント アプリケーション コードの記述

次のサンプル コードでは、スタンドアロン アプリケーションが Web サービス オペレーションを呼び出しています。

このクライアント アプリケーションは 1 つの引数 (Web サービスの WSDL) を取ります。アプリケーションは、標準 JAX-RPC API コードと、clientgen によって生成された Service インタフェースの Web サービス固有の実装を使用して、Web サービスのオペレーションを呼び出します。

このサンプルでは、ユーザ定義のデータ型 (examples.webservices.complex.BasicStruct) を入力パラメータおよび戻り値として使用するオペレーションを呼び出す方法も示します。clientgen Ant タスクによって、このユーザ定義のデータ型の Java コードが自動的に生成されます。

package examples.webservices.simple_client;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
// echoComplexType オペレーションのパラメータおよび戻り値として使用される
// BasicStruct クラスをインポートする。このクラスは clientgen Ant タスクによって
// 自動的に生成される
import examples.webservices.complex.BasicStruct;
/**
* ComplexService Web サービスの echoComplexType オペレーションを呼び出す
* 簡単なスタンドアロンのクライアント アプリケーション
*
* @author Copyright (c) 2005 by BEA Systems. All Rights Reserved.
*/
public class Main {
  public static void main(String[] args)
throws ServiceException, RemoteException{
    ComplexService service = new ComplexService_Impl (args[0] + "?WSDL" );
ComplexPortType port = service.getComplexServicePort();
    BasicStruct in = new BasicStruct();
    in.setIntValue(999);
in.setStringValue("Hello Struct");
    BasicStruct result = port.echoComplexType(in);
System.out.println("echoComplexType called.Result: " + result.getIntValue() + ", " + result.getStringValue());
}
}

上記の例で注目すべき点は以下のとおりです。

アプリケーションから Web サービス オペレーションを呼び出すメソッドは、java.rmi.RemoteException および javax.xml.rpc.ServiceException を送出または捕捉する必要があります。これらの例外は、生成された JAX-RPC スタブから送出されます。

クライアント アプリケーションのコンパイルと実行

すべての Java ファイル (クライアント アプリケーションおよび clientgen によって生成されたファイルの両方) をクラス ファイルにコンパイルするには、build.xml ファイルの build-client ターゲットに javac タスクを追加します。該当箇所を次のサンプルに太字で示します。

  <target name="build-client">
    <clientgen
wsdl="http://${wls.hostname}:${wls.port}/complex/ComplexService?WSDL"
destDir="clientclasses"
packageName="examples.webservices.simple_client"/>
    <javac
srcdir="clientclasses"
destdir="clientclasses"
includes="**/*.java"/>
    <javac
srcdir="src"
destdir="clientclasses"
includes="examples/webservices/simple_client/*.java"/>
</target>

この例では、1 番目の javac タスクで clientgen によって生成された clientclasses ディレクトリ内の Java ファイルをコンパイルし、2 番目の javac タスクでカレント ディレクトリの examples/webservices/simple_client サブディレクトリ (Java クライアント アプリケーションのソースの場所と想定されるディレクトリ) 内にある Java ファイルをコンパイルしています。

この例では、clientgen によって生成された Java ソース ファイルとコンパイル後のクラスが同じディレクトリ (clientclasses) に格納されます。プロトタイピングの段階ではこれで十分ですが、多くの場合はソース コード (生成されたコードも含む) とコンパイルされたクラスを別々のディレクトリに格納するのがベスト プラクティスです。そのためには、両方の javac タスクの destdir に、srcdir ディレクトリとは異なるディレクトリを設定します。また、clientgen によって生成された以下のファイルを、clientgen の出力先ディレクトリから javac の出力先ディレクトリにコピーする必要もあります。その際、出力先のサブディレクトリの階層構造は同じになるようにします。

packageName/ServiceName_internaldd.xml
packageName/ServiceName_java_wsdl_mapping.xml
packageName/ServiceName_saved_wsdl.wsdl

packageName は、生成された JAX-RPC スタブのパッケージに対応するサブディレクトリ階層構造です。ServiceName は、Web サービスの名前です。

クライアント アプリケーションを実行するには、java タスクの呼び出しを含む build.xmlrun ターゲットを追加します。次に例を示します。

<path id="client.class.path">
<pathelement path="clientclasses"/>
<pathelement path="${java.class.path}"/>
</path>
<target name="run" >
<java
fork="true"
classname="examples.webServices.simple_client.Main"
failonerror="true" >
<classpath refid="client.class.path"/>
<arg line="http://${wls.hostname}:${wls.port}/complex/ComplexService" />
</java>
</target>

path タスクは、CLASSPATH に clientclasses ディレクトリを追加します。run ターゲットは Main アプリケーションを呼び出し、デプロイされた Web サービスの URL を 1 つの引数として渡します。

この手順で説明されている追加のターゲット (clean など) を含む、完全なサンプル build.xml ファイルについては、「スタンドアロン Java クライアントのサンプル Ant ビルド ファイル」を参照してください。

アーティファクトを再生成してクラスに再コンパイルするために build-client ターゲットを再実行してから、run ターゲットを実行して echoStruct オペレーションを呼び出します。

    prompt> ant build-client run

build.xml ファイルの build-client および run ターゲットを使用して、開発プロセスの一環として Java クライアント アプリケーションを繰り返し更新、再ビルド、および実行できます。

スタンドアロン Java クライアントのサンプル Ant ビルド ファイル

次の例では、スタンドアロン Java クライアントを生成およびコンパイルするための完全な build.xml ファイルを示します。太字のセクションについては、「クライアントのアーティファクトを生成するための clientgen Ant タスクの使用」および「クライアント アプリケーションのコンパイルと実行」を参照してください。

<project name="webservices-simple_client" default="all">
  <!-- このビルドのグローバルなプロパティを設定 -->
  <property name="wls.hostname" value="localhost" />
<property name="wls.port" value="7001" />
  <property name="example-output" value="output" />
<property name="clientclass-dir" value="${example-output}/clientclass" />
  <path id="client.class.path">
<pathelement path="${clientclass-dir}"/>
<pathelement path="${java.class.path}"/>
</path>
  <taskdef name="clientgen"
classname="weblogic.wsee.tools.anttasks.ClientGenTask" />
  <target name="clean" >
<delete dir="${clientclass-dir}"/>
</target>
  <target name="all" depends="clean,build-client,run" />
  <target name="build-client">
    <clientgen
wsdl="http://${wls.hostname}:${wls.port}/complex/ComplexService?WSDL"
destDir="${clientclass-dir}"
packageName="examples.webservices.simple_client"/>
    <javac
srcdir="${clientclass-dir}" destdir="${clientclass-dir}"
includes="**/*.java"/>
    <javac
srcdir="src" destdir="${clientclass-dir}"
includes="examples/webservices/simple_client/*.java"/>
</target>
  <target name="run" >
<java fork="true"
classname="examples.webservices.simple_client.Main"
failonerror="true" >
<classpath refid="client.class.path"/>
<arg line="http://${wls.hostname}:${wls.port}/complex/ComplexService"
/>
</java>
</target>
</project>

 


別の Web サービスからの Web サービスの呼び出し

WebLogic Web サービス内からの Web サービスの呼び出しは、「スタンドアロン クライアントからの Web サービスの呼び出し : 主な手順」で説明したスタンドアロン Java アプリケーションからの Web サービスの呼び出しに似ています。ただし、呼び出す Web サービスの JAX-RPC スタブを clientgen Ant タスクを使用して生成する代わりに、呼び出す Web サービスをコンパイルする jwsc Ant タスクの内部で <jws> 要素の <clientgen> 子要素を使用します。一方、他の Web サービスを呼び出す JWS ファイルでは、Service および PortType インスタンスの取得に同じ標準 JAX-RPC API を使用して、Web サービス オペレーションを呼び出します。この節では、Web サービスを Java EE コンポーネント内のクライアントから呼び出す場合と、スタンドアロン クライアントから呼び出す場合の違いについて説明します。

ここでは、読者がすでに「スタンドアロン クライアントからの Web サービスの呼び出し : 主な手順」に目を通して理解していることを前提としています。また、開発環境でのクライアント アプリケーションのビルドや Java ファイルのコンパイルなどに Ant を使用していること、および別の Web サービスを呼び出すために更新が必要な Web サービスを構築する build.xml ファイルが、すでにあることを想定しています。

以下のリストでは、クライアント Web サービスのビルドに使用する build.xml ファイルに加える必要のある変更について説明します。このクライアント Web サービスが、別の Web サービスを呼び出すことになります。build.xml ファイルの完全なサンプルについては、「Web サービス クライアントのサンプル build.xml ファイル」を参照してください。

クライアント Web サービスを実装する JWS ファイルに加える必要のある変更は以下のとおりです。JWS ファイルの完全なサンプルについては、「Web サービスを呼び出すサンプル JWS ファイル」を参照してください。

Web サービス クライアントのサンプル build.xml ファイル

次に示すサンプル build.xml ファイルでは、別の Web サービスを呼び出す Web サービスを作成する方法を示します。別の Web サービスを呼び出さない単純な Web サービスをビルドするための build.xml と異なっている部分は、太字で示されています。

この場合の build-service ターゲットは、単純な Web サービスをビルドするターゲットとよく似ています。唯一の違いは、呼び出す Web サービスをビルドする jwsc Ant タスクに <jws> 要素の <clientgen> 子要素も含まれるという点で、これによって jwsc では必要な JAX-RPC クライアント スタブも生成されるようになります。

<project name="webservices-service_to_service" default="all">
  <!-- このビルドのグローバルなプロパティを設定 -->
  <property name="wls.username" value="weblogic" />
<property name="wls.password" value="weblogic" />
<property name="wls.hostname" value="localhost" />
<property name="wls.port" value="7001" />
<property name="wls.server.name" value="myserver" />
  <property name="ear.deployed.name" value="ClientServiceEar" />
<property name="example-output" value="output" />
<property name="ear-dir" value="${example-output}/ClientServiceEar" />
<property name="clientclass-dir" value="${example-output}/clientclasses" />
  <path id="client.class.path">
<pathelement path="${clientclass-dir}"/>
<pathelement path="${java.class.path}"/>
</path>
  <taskdef name="jwsc"
classname="weblogic.wsee.tools.anttasks.JwscTask" />
  <taskdef name="clientgen"
classname="weblogic.wsee.tools.anttasks.ClientGenTask" />
  <taskdef name="wldeploy"
classname="weblogic.ant.taskdefs.management.WLDeploy"/>
  <target name="all" depends="clean,build-service,deploy,client"/>
  <target name="clean" depends="undeploy">
<delete dir="${example-output}"/>
</target>
  <target name="build-service">
    <jwsc
srcdir="src"
destdir="${ear-dir}">
        <jws
file="examples/webservices/service_to_service/ClientServiceImpl.java">
<clientgen
wsdl="http://${wls.hostname}:${wls.port}/complex/ComplexService?WSDL"
packageName="examples.webservices.service_to_service" />
</jws>
    </jwsc>
  </target>
  <target name="deploy">
<wldeploy action="deploy" name="${ear.deployed.name}"
source="${ear-dir}" user="${wls.username}"
password="${wls.password}" verbose="true"
adminurl="t3://${wls.hostname}:${wls.port}"
targets="${wls.server.name}" />
</target>
  <target name="undeploy">
<wldeploy action="undeploy" name="${ear.deployed.name}"
failonerror="false"
user="${wls.username}"
password="${wls.password}" verbose="true"
adminurl="t3://${wls.hostname}:${wls.port}"
targets="${wls.server.name}" />
</target>
  <target name="client">
    <clientgen
wsdl="http://${wls.hostname}:${wls.port}/ClientService/ClientService?WSDL"
destDir="${clientclass-dir}"
packageName="examples.webservices.service_to_service.client"/>
    <javac
srcdir="${clientclass-dir}" destdir="${clientclass-dir}"
includes="**/*.java"/>
    <javac
srcdir="src" destdir="${clientclass-dir}"
includes="examples/webservices/service_to_service/client/**/*.java"/>
  </target>
  <target name="run">
<java classname="examples.webservices.service_to_service.client.Main"
fork="true"
failonerror="true" >
<classpath refid="client.class.path"/>
<arg
line="http://${wls.hostname}:${wls.port}/ClientService/ClientService"/>
    </java>
  </target>
</project>

Web サービスを呼び出すサンプル JWS ファイル

次に示すサンプル JWS ファイル (ClientServiceImpl.java) は、ClientService という Web サービスを実装しています。この Web サービスには、ComplexService という Web サービスの echoComplexType オペレーションを順番に呼び出すオペレーションが含まれています。このオペレーションでは、パラメータとしても戻り値としてもユーザ定義データ型 (BasicStruct) を使用します。コードの該当部分を太字で示し、サンプルの後で説明を加えます。

package examples.webservices.service_to_service;
import java.rmi.RemoteException;
import javax.xml.rpc.ServiceException;
import javax.jws.WebService;
import javax.jws.WebMethod;
import weblogic.jws.WLHttpTransport;
// clientgen によって生成され、ComplexService Web サービスによって使用される
// BasicStruct データ型をインポートする
import examples.webservices.complex.BasicStruct;
// ComplexService Web サービスを呼び出すための JAX-RPC スタブをインポートする
// clientgen によって生成されるスタブ
import examples.webservices.service_to_service.ComplexPortType;
import examples.webservices.service_to_service.ComplexService_Impl;
import examples.webservices.service_to_service.ComplexService;
@WebService(name="ClientPortType", serviceName="ClientService",
targetNamespace="http://examples.org")
@WLHttpTransport(contextPath="ClientService", serviceUri="ClientService",
portName="ClientServicePort")
public class ClientServiceImpl {
  @WebMethod()
public String callComplexService(BasicStruct input, String serviceUrl)
throws ServiceException, RemoteException
{
    // ComplexService を呼び出すサービスおよびポート スタブを作成する
ComplexService service = new ComplexService_Impl(serviceUrl + "?WSDL");
ComplexPortType port = service.getComplexServicePort();
    // ComplexService の echoComplexType オペレーションを呼び出す
BasicStruct result = port.echoComplexType(input);
System.out.println("Invoked ComplexPortType.echoComplexType." );
    return "Invoke went okay!";Here's the result: '" + result.getIntValue() + ",  " + result.getStringValue() + "'";
  }
}

別の Web サービスを呼び出す JWS ファイルをプログラミングする際は、以下のガイドラインに従います。ガイドラインのサンプル コードは、上述のサンプル内では太字で示されています。

 


Web サービス呼び出し時のスタンドアロン クライアント JAR ファイルの使用

このマニュアルでは、clientgen または wsdlc Ant タスクによって生成されたクライアントサイド アーティファクトを使用して Web サービスを呼び出す場合、CLASSPATH には WebLogic Server クラスのセット全体が入るということが前提となっています。ただし、お使いのコンピュータに WebLogic Server がインストールされていない場合でも、この節で説明するようにスタンドアロンの WebLogic Web サービス クライアント JAR ファイルを使用することで、Web サービスを呼び出すことができます。

スタンドアロン クライアント JAR ファイルは、次のような基本的なクライアントサイドの機能をサポートしています。

ただし、スタンドアロン クライアント JAR ファイルは、以下の高度な機能を使用する Web サービスの呼び出しはサポートしていません。

スタンドアロンの WebLogic Web サービス クライアント JAR ファイルを、クライアント アプリケーションで使用するには、次の手順に従います。

  1. ファイル WL_HOME/server/lib/wseeclient.zip を、WebLogic Server をホストしているコンピュータからクライアント コンピュータにコピーします。WL_HOME は、WebLogic Server のインストール ディレクトリ (/bea/wlserver_10.0 など) を表します。
  2. wseeclient.zip ファイルを、適切なディレクトリに解凍します。たとえば、クライアント アプリケーションで使用している他のクラスが格納されているディレクトリを解凍先にします。
  3. wseeclient.jar ファイル (wseeclient.zip ファイルから解凍) を、CLASSPATH に追加します。
  4. 注意 : また、Ant クラスが含まれる JAR ファイル (ant.jar) が、確実に CLASSPATH に格納されるようにしてください。この JAR ファイルは通常、Ant ディストリビューションの lib ディレクトリ内にあります。

 


Web サービス呼び出し時のプロキシ サーバの使用

プロキシ サーバを使用すると、クライアント アプリケーションから、呼び出される Web サービスをホストするアプリケーション サーバ (WebLogic、非 WebLogic いずれでも) へのリクエストをプロキシできます。通常、プロキシ サーバは、アプリケーション サーバがファイアウォールの内側にある場合に使用します。クライアント アプリケーションでプロキシ サーバを指定する方法は 2 つあります。WebLogic HttpTransportInfo API でプログラム的に行う方法と、システム プロパティを使用する方法です。

Web サービスを呼び出す際にプロキシ サーバを使用する場合の完全なサンプルについては、dev2dev のサンプル コードを参照してください。

HttpTransportInfo API を使用したプロキシ サーバの指定

標準の java.net.* クラスと、WebLogic 固有の HttpTransportInfo API を使用することにより、Web サービスの呼び出しをプロキシするプロキシ サーバの詳細を、Java クライアント アプリケーション自体の中でプログラム的に指定できます。java.net クラスを使用して、プロキシ サーバを示す Proxy オブジェクトを作成します。その後で、HttpProxySampleService Web サービスの echo オペレーションを呼び出す以下のサンプル クライアントに示すように、WebLogic API とプロパティを使用して JAX-RPC スタブ上でプロキシ サーバを設定します。太字で示したコードについては、サンプルの後で説明します。

package dev2dev.proxy.client;
import javax.xml.rpc.Stub;
import java.net.Proxy;
import java.net.InetSocketAddress;
import weblogic.wsee.connection.transport.http.HttpTransportInfo;
/**
* プログラムによる API によりプロキシ サーバ経由でサービスを呼び出す
* サンプル クライアント
*/
public class HttpProxySampleClient {
public static void main(String[] args) throws Throwable{
assert args.length == 5;
String endpoint = args[0];
String proxyHost = args[1];
String proxyPort = args[2];
String user = args[3];
String pass = args[4];
    // サービスとポートを作成する
    HttpProxySampleService service = new HttpProxySampleService_Impl();
HttpProxySamplePortType port = service.getHttpProxySamplePortTypeSoapPort();
    // エンドポイント アドレスを設定する
    ((Stub)port)._setProperty(Stub.ENDPOINT_ADDRESS_PROPERTY, endpoint);
    // プロキシ サーバ情報を設定する
Proxy p = new Proxy(Proxy.Type.HTTP, new InetSocketAddress(proxyHost, Integer.parseInt(proxyPort)));
HttpTransportInfo info = new HttpTransportInfo();
info.setProxy(p);
((Stub)port)._setProperty("weblogic.wsee.connection.transportinfo",info);
    // プロキシ認証情報を設定する
((Stub)port)._setProperty("weblogic.webservice.client.proxyusername",user);
((Stub)port)._setProperty("weblogic.webservice.client.proxypassword",pass);
    //呼び出し
String s = port.echo("Hello World!");
System.out.println("echo: " + s);
}
}

上記サンプルのうち、留意すべきセクションは、次のとおりです。

システム プロパティを使用したプロキシ サーバの指定

プロキシ サーバの指定にシステム プロパティを使用する場合は、クライアント アプリケーションの記述は標準的な方式で行い、クライアント アプリケーションの実行時に以下のシステム プロパティを指定します。

proxyHost はプロキシ サーバが実行されているホスト コンピュータの名前、proxyPort はプロキシ サーバがリスンしているポート、proxyUsername は認証されているプロキシ サーバ ユーザ、proxyPassword はユーザのパスワードです。

以下の Ant ビルド スクリプトの抜粋では、clients.InvokeMyService というクライアント アプリケーションを呼び出す場合のシステム プロパティの設定例を示します。

  <target name="run-client">
<java fork="true"
classname="clients.InvokeMyService"
failonerror="true">
<classpath refid="client.class.path"/>
<arg line="${http-endpoint}"/>
<jvmarg line=
"-DproxySet=true
-DproxyHost=${proxy-host}
-DproxyPort=${proxy-port}
-Dweblogic.webservice.client.proxyusername=${proxy-username}
-Dweblogic.webservice.client.proxypassword=${proxy-passwd}"
/>
</java>
</target>

 


Web サービスを再デプロイする際にクライアント側で考慮すべき事項

WebLogic Server ではプロダクションの再デプロイメントをサポートしています。つまり、更新後の新しいバージョンの WebLogic Web サービスを同じ Web サービスの古いバージョンと並行してデプロイできます。

WebLogic Server では、新しいクライアントのリクエストのみが新しいバージョンに転送されるように、クライアント接続が自動的に管理されます。再デプロイメント時にすでに Web サービスに接続していたクライアントは、作業が完了するまで古いバージョンのサービスを使用し続けます。作業が完了した時点で、自動的に古い Web サービスが廃止されます。クライアントが会話形式の Web サービスまたは信頼性のある Web サービスに接続している場合、既存の会話メッセージング シーケンスまたは信頼性のあるメッセージング シーケンスが、クライアントによって明示的に終了されるか、タイムアウトになったときに、クライアントの作業が完了したと見なされます。

Web サービスの新しいバージョンで以下の Web サービス アーティファクトが変更されていなければ、その新しいバージョンで古いクライアント アプリケーションを引き続き使用できます。

上記のアーティファクトのいずれかが変更されている場合、clientgen Ant タスクを再び実行して、クライアント アプリケーションで使用される JAX-RPC スタブを再生成する必要があります。

たとえば、Web サービスの新しいバージョンでオペレーションのシグネチャを変更すると、Web サービスの新しいバージョンを記述する WSDL ファイルも変更されます。この場合、JAX-RPC スタブを再生成する必要があります。ただし、単にオペレーションの実装だけを変更し、オペレーションのパブリック コントラクトは変更しない場合、既存のクライアント アプリケーションを引き続き使用できます。

 


WebLogic Web サービスのスタブ プロパティ

WebLogic Server には、WebLogic Web サービスの呼び出しに使用する JAX-RPC スタブに対して設定できる一連のスタブ プロパティが用意されています。プロパティの設定には、以下の例のように Stub._setProperty() メソッドを使用します。

((Stub)port)._setProperty(WLStub.MARSHAL_FORCE_INCLUDE_XSI_TYPE,"true");

ほとんどのスタブ プロパティは WLStub クラスに定義されています。詳細については、「weblogic.wsee.jaxrpc.WLStub」を参照してください。

WLStub クラスに定義されていない付加的なスタブ プロパティについては、以下の表で説明します。

表 8-2 付加的なスタブ プロパティ
スタブ プロパティ
説明
weblogic.wsee.transport.connection.timeout
Web サービスの呼び出しを試行しているクライアント アプリケーションが接続を待機する時間 (秒単位) を指定する。指定した時間が経過しても接続が確立していない場合、その試行はタイムアウトになる。
weblogic.wsee.transport.read.timeout
クライアント アプリケーションが呼び出している Web サービスからの応答を待機する時間 (秒単位) を指定する。指定した時間が経過しても応答が到着していない場合、そのクライアントはタイムアウトになる。
weblogic.wsee.security.bst.serverVerifyCert
クライアント アプリケーションが WebLogic Server からの署名された応答の検証に使用する証明書を指定する。デフォルトでは、検証に使用される証明書が SOAP 応答メッセージ自体に格納される。これが不可能な場合に、このスタブ プロパティを使用して、別の証明書を指定する。
このスタブ プロパティは、WebLogic Server コンテナの内部で実行されるクライアント アプリケーションだけに適用され、スタンドアロンのクライアント アプリケーションには適用されない。
このプロパティの値は、java.security.cert.X509Certificate データ型のオブジェクト。
weblogic.wsee.security.bst.serverEncryptCert
クライアント アプリケーションが、WebLogic Server に送信される SOAP リクエスト メッセージの暗号化に使用する証明書を指定する。デフォルトでは、クライアント アプリケーションは Web サービスの WSDL でパブリッシュされているパブリック証明書を使用する。これが不可能な場合に、このスタブ プロパティを使用して、別の証明書を指定する。
このスタブ プロパティは、WebLogic Server コンテナの内部で実行されるクライアント アプリケーションだけに適用され、スタンドアロンのクライアント アプリケーションには適用されない。
このプロパティの値は、java.security.cert.X509Certificate データ型のオブジェクト。
weblogic.wsee.marshal.forceIncludeXsiType
Web サービス オペレーション呼び出しの SOAP メッセージに、各パラメータの XML スキーマ データ型を含める必要があることを指定する。デフォルトでは、各パラメータのデータ型は SOAP メッセージには含まれない。
このプロパティを True に設定すると、オペレーション パラメータを記述する SOAP メッセージ内の要素に、パラメータのデータ型を指定するための xsi:type 属性が追加される。次に例を示す。
<soapenv:Envelope>
...
<maxResults xsi:type="xs:int">10</maxResults>
...
デフォルトでは (または、このプロパティを False に設定した場合は)、このパラメータ要素は次の例のようになる。
<soapenv:Envelope>
...
<maxResults>10</maxResults>
...
このプロパティの有効な値は、True および False。デフォルト値は False

 


応答 SOAP メッセージの文字エンコーディングの設定

応答 (発信) SOAP メッセージの文字エンコーディングを設定するには、weblogic.wsee.jaxrpc.WLStub.CHARACTER_SET_ENCODING WLStub プロパティを使用します。設定できる値は次の 2 つです。

クライアント アプリケーションからの以下の抜粋コードでは、文字エンコーディングを UTF-16 に設定する方法を示します。

  Simple port = service.getSimpleSoapPort();
((Stub) port)._setProperty(weblogic.wsee.jaxrpc.WLStub.CHARACTER_SET_ENCODING, "UTF-16");
port.invokeMethod();

その他の設定可能な WLStub スタブ プロパティについては、「weblogic.wsee.jaxrpc.WLStub」を参照してください。


ページの先頭       前  次