WebLogic Web サービス プログラマーズ ガイド

WebLogic Web サービスの反復的な開発

以下の節では、WebLogic Web サービスの反復的な開発プロセスについて説明します。

WebLogic Web サービス プログラミング モデルの概要

WebLogic Web サービスのプログラミング モデルは JWS ファイル (JWS アノテーションを使用して Web サービスの形式や動作を指定した Java ファイル) と、JWS ファイルを実行する Ant タスクを中心に展開されます。JWS アノテーションは JDK バージョン 5.0 の新しいメタデータ機能に基づいており (JSR-175 で規定)、Web Services Metadata for the Java Platform 仕様 (JSR-181) で定義された標準のアノテーションと WebLogic 固有の追加のアノテーションがあります。このプログラミング モデルの詳細については、「WebLogic Web サービスの構造」を参照してください。

以下の節では、Web サービスを繰り返し開発する主要な手順を、Java から開始する場合、または既存の WSDL ファイルから開始する場合について説明します。

反復的な開発とは、希望どおりに動作するまで、Web サービスを繰り返しコーディング、コンパイル、パッケージ化、デプロイ、およびテストできるように、開発環境を設定することです。WebLogic Web サービス プログラミング モデルでは、Ant タスクを使用して、反復的な開発のほとんどの手順を実行します。一般に、すべての手順に対応するターゲットを含んだ 1 つの build.xml ファイルを作成して、そのターゲットを繰り返し実行します。JWS ファイルを新しい Java コードで更新したら、その更新が期待どおりに動作することをテストします。

Web サービス機能用のドメイン コンフィグレーション

WebLogic Server ドメインを作成したら、コンフィグレーション ウィザードで Web サービス固有の拡張テンプレートを使用してドメインを更新し、特定の WebLogic Web サービス機能で必要になるリソースを自動的にコンフィグレーションできます。この拡張テンプレートの使用は必須ではありませんが、これを使用することで JMS および JDBC リソースのコンフィグレーションを大幅に簡略化できます。

Web サービス拡張テンプレートを使用すると、以下の機能で必要になるリソースを自動的にコンフィグレーションできます。

ドメインを更新してこれらの Web サービス機能用に自動的にコンフィグレーションするには、次の手順に従います。

コンフィグレーション ウィザードを使用して WebLogic Server ドメインを作成および更新する手順については、『コンフィグレーション ウィザードを使用した WebLogic ドメインの作成』を参照してください。

Java から開始する WebLogic Web サービスの反復的な開発 : 主な手順

この節では、Java から開始して WebLogic Web サービスを繰り返し開発する一般的な手順について説明します。つまり、JWS ファイルを最初からコーディングして、サービスについて記述する WSDL ファイルを後で生成するという手順です。このプロセスの例については、「一般的な Web サービスの使用例とサンプル」を参照してください。以下に示すのは推奨の手順に過ぎません。すでに独自の開発環境を設定してある場合は、WebLogic Web サービスを開発するために既存の環境を更新する際のガイドとして、この手順を利用できます。

この手順では、WebLogic Web サービスの分割開発ディレクトリ環境は使用しません。この開発環境を使用していて、Web サービスの開発をそこに統合する場合は、詳細について「Web サービスの WebLogic 分割開発ディレクトリ環境への統合」を参照してください。

Java から開始して WebLogic Web サービスを繰り返し開発するには、次の手順に従います。

Web サービスを呼び出すクライアント アプリケーションの記述については、「Web サービスの呼び出し」を参照してください。

WSDL ファイルから開始する WebLogic Web サービスの反復的な開発 : 主な手順

この節では、既存の WSDL ファイルに基づいて WebLogic Web サービスを繰り返し開発する一般的な手順について説明します。このプロセスの例については、「一般的な Web サービスの使用例とサンプル」を参照してください。以下に示すのは推奨の手順に過ぎません。すでに独自の開発環境を設定してある場合は、WebLogic Web サービスを開発するために既存の環境を更新する際のガイドとして、この手順を利用できます。

この手順では、WebLogic Web サービスの分割開発ディレクトリ環境は使用しません。この開発環境を使用していて、Web サービスの開発をそこに統合する場合は、詳細について「Web サービスの WebLogic 分割開発ディレクトリ環境への統合」を参照してください。

この手順では既存の WSDL ファイルがすでにあることを前提としています。

WSDL から開始して WebLogic Web サービスを繰り返し開発するには、次の手順に従います。

Web サービスを呼び出すクライアント アプリケーションの記述については、「Web サービスの呼び出し」を参照してください。

基本的な Ant build.xml ファイルの作成

Ant では、XML で記述されたビルド ファイル (デフォルト名は build.xml) を使用します。このファイルには、<project> ルート要素と、Web サービス開発プロセスのさまざまな段階を指定した 1 つまたは複数のターゲットが含まれています。各ターゲットには、1 つまたは複数のタスク、または実行可能なコードが含まれています。この節では、基本的な Ant ビルド ファイルの作成方法について説明し、その後の節では、Web サービス開発プロセスのさまざまな段階 (jwsc Ant タスクを実行して JWS ファイルを処理する、Web サービスを WebLogic Server にデプロイする、など) の実行方法を指定したターゲットをビルド ファイルに追加する方法について説明します。

以下のスケルトンの build.xml ファイルでは、以降の節で追加される他のすべてのターゲットを呼び出す、デフォルトの all ターゲットを指定しています。

<project default="all">

  <target name="all" 
          depends="clean,build-service,deploy" />

  <target name="clean">
    <delete dir="output" />
  </target>

  <target name="build-service">
     <!-- ここに jwsc タスク、関連するタスクを追加 -->
  </target>

  <target name="deploy">
      <!-- ここに wldeploy タスクを追加 -->
 </target>

</project>

jwsc WebLogic Web サービス Ant タスクの実行

jwsc Ant タスクは、標準 (JSR-181) の JWS アノテーションと WebLogic 固有の JWS アノテーションの両方を含む JWS ファイルを入力として取り、WebLogic Web サービスの作成に必要なアーティファクトをすべて生成します。JWS ファイルは、最初から自分でコーディングしたものでも、wsdlc Ant タスクによって生成されたものでもかまいません。jwsc によって生成されるアーティファクトには、以下のものがあります。

wsdlc Ant タスクによって生成された JWS ファイルに対して jwsc Ant タスクを実行する場合、wsdlc Ant タスクがすでにこれらのアーティファクトを生成して JAR ファイルにパッケージ化しているため、jwsc タスクではこれらのアーティファクトを生成しません。その場合は、jwsc Ant タスクの属性を使用して、wsdlc が生成した JAR ファイルを指定します。

必要なアーティファクトをすべて生成した後、jwsc Ant タスクは、Java ファイル (JWS ファイルも含む) をコンパイルし、コンパイルされたクラスと生成されたアーティファクトを、デプロイ可能な JAR アーカイブ ファイルにパッケージ化して、最後に、その JAR ファイルを格納する、展開されたエンタープライズ アプリケーション ディレクトリを作成します。

jwsc Ant タスクを実行するには、以下の taskdef および build-service ターゲットを build.xml ファイルに追加します。

<taskdef name="jwsc"
    classname="weblogic.wsee.tools.anttasks.JwscTask" />  

<target name="build-service">

    <jwsc
      srcdir="src_directory"
      destdir="ear_directory"
      >
      <jws file="JWS_file" 
           compiledWsdl="WSDLC_Generated_JAR" />
    </jwsc>

  </target>

ここで、

必須の taskdef 要素では、jwsc Ant タスクの完全修飾クラス名を指定します。

jwsc Ant タスクの srcdir および destdir 属性のみが必須です。つまり、デフォルトでは、JWS ファイルが参照する Java ファイル (JavaBean 入力パラメータやユーザ定義の例外など) は JWS ファイルと同じパッケージ内にあると想定されています。これに当てはまらない場合は、sourcepath 属性を使用して、これらの他の Java ファイルの最上位ディレクトリを指定します。詳細については、「jwsc」を参照してください。

jwsc の使用例

以下の build.xml の抜粋では、JWS ファイルに対して jwsc Ant タスクを実行する例を示します。

  <taskdef name="jwsc"
           classname="weblogic.wsee.tools.anttasks.JwscTask" />  

  <target name="build-service">

      <jwsc
        srcdir="src"
        destdir="output/helloWorldEar">
        <jws 
           file="examples/webservices/hello_world/HelloWorldImpl.java" />

      </jwsc>  

  </target>

この例では、現在のディレクトリに対して相対的な output/helloWorldEar に、エンタープライズ アプリケーションが展開形式で生成されます。JWS ファイルは HelloWorldImpl.java という名前で、現在のディレクトリに対して相対的な src/examples/webservices/hello_world ディレクトリにあります。つまり、JWS ファイルはパッケージ examples.webservices.helloWorld 内にあります。

以下の例は前の例と似ていますが、compiledWsdl 属性を使用して、wsdlc が生成したアーティファクト (「WSDL から開始する」使用例) を含む JAR ファイルを指定している点が異なります。

  <taskdef name="jwsc"
           classname="weblogic.wsee.tools.anttasks.JwscTask" />  

  <target name="build-service">

    <jwsc
      srcdir="src"
      destdir="output/wsdlcEar">

      <jws

          file="examples/webservices/wsdlc/TemperaturePortTypeImpl.java"

          compiledWsdl="output/compiledWsdl/TemperatureService_wsdl.jar" />

    </jwsc>

  </target>

上の例で、TemperaturePortTypeImpl.java ファイルは、途中まで作成済みの JWS ファイルを、サービスが希望どおりに動作するようにビジネス ロジックを含めて更新したものです。compiledWsdl 属性が指定されて JAR ファイルを指し示しているので、jwsc Ant タスクでは、JAR に含まれているアーティファクトを再生成することはありません。

このタスクを実際に実行するには、コマンドラインで次のように入力します。

  prompt> ant build-service

jwsc の高度な使用方法

この節では、jwsc Ant タスクの非常に簡単な使用例を紹介します。ただし、このタスクには、非常に有用なツールにするための追加の属性と子要素を含めます。以下のような使用方法が考えられます。

jwsc Ant タスクの詳細な説明と使用例については、「jwsc」を参照してください。

wsdlc WebLogic Web サービス Ant タスクの実行

wsdlc Ant タスクは WSDL ファイルを入力として取り、WebLogic Web サービスの実装を構成するアーティファクトを生成します。以下のようなアーティファクトがあります。

wsdlc Ant タスクは JWS インタフェース ファイルとデータ バインディング アーティファクトを一緒に JAR ファイルにパッケージ化します。この JAR ファイルを後で jwsc Ant タスクに指定します。この JAR ファイルを更新する必要はありません。更新するファイルは JWS 実装クラスのみです。

wsdlc Ant タスクを実行するには、以下の taskdef および generate-from-wsdl ターゲットを build.xml ファイルに追加します。

  <taskdef name="wsdlc"
           classname="weblogic.wsee.tools.anttasks.WsdlcTask"/>

  <target name="generate-from-wsdl">

    <wsdlc
        srcWsdl="WSDL_file"
        destJwsDir="JWS_interface_directory"
        destImplDir="JWS_implementation_directory"
        packageName="Package_name" />
  </target>

ここで、

必須の taskdef 要素では、wsdlc Ant タスクの完全修飾クラス名を指定します。

wsdlc Ant タスクでは、srcWsdl および destJwsDir 属性のみが必須です。ただし、通常は、プログラミングを容易にするために、途中まで作成済みの JWS ファイルも生成します。WSDL ファイルの targetNamespace が、読み取り可能なパッケージ名への変換に適していない場合に備えて、パッケージ名を明示的に指定することをお勧めします。

以下の build.xml の抜粋では、WSDL ファイルに対して wsdlc Ant タスクを実行する例を示します。

  <taskdef name="wsdlc"
           classname="weblogic.wsee.tools.anttasks.WsdlcTask"/>

  <target name="generate-from-wsdl">

      <wsdlc
          srcWsdl="wsdl_files/TemperatureService.wsdl"
          destJwsDir="output/compiledWsdl"
          destImplDir="impl_output"
          packageName="examples.webservices.wsdlc" />

  </target>

この例では、既存の WSDL ファイルは TemperatureService.wsdl という名前で、build.xml ファイルを格納するディレクトリの wsdl_files サブディレクトリにあります。JWS インタフェースとデータ バインディング アーティファクトを含む JAR ファイルは output/compiledWsdl ディレクトリに生成され、JAR ファイルの名前は TemperatureService_wsdl.jar です。生成される JWS ファイルのパッケージ名は examples.webservices.wsdlc です。途中まで作成済みの JWS ファイルは、現在のディレクトリに対して相対的な impl_output/examples/webservices/wsdlc ディレクトリに生成されます。WSDL ファイル内のポート タイプ名が TemperaturePortType の場合、JWS 実装ファイルの名前は TemperaturePortTypeImpl.java になります。

このタスクを実際に実行するには、コマンドラインで次のように入力します。

  prompt> ant generate-from-wsdl

wsdlc Ant タスクのその他の属性については、「wsdlc」を参照してください。

wsdlc で生成される途中まで作成済みの JWS 実装クラス ファイルの更新

wsdlc Ant タスクは、destImplDir 属性で指定されたディレクトリに、途中まで作成済みの JWS 実装ファイルを生成します。ファイルの名前は PortTypeImpl.java です (PortType は元の WSDL にある portType の名前)。このクラス ファイルには、オペレーションを実装するメソッド内のビジネス ロジックを除いて、Web サービスへコンパイルするために必要なすべてのものが含まれています。

JWS クラスは、WSDL ファイルに対応する JWS Web サービス エンドポイント インタフェースを実装しています。この JWS インタフェースも wsdlc によって生成され、他のアーティファクト (WSDL 内の XML スキーマ データ型の Java 表現など) が含まれている JAR ファイル内に置かれています。JWS クラスのパブリック メソッドは WSDL ファイル内のオペレーションに対応しています。

wsdlc Ant タスクは、JWS 実装クラスに @WebService および @WLHttpTransport アノテーションを自動的に含めます。属性の値は WSDL 内の関連する値に対応しています。たとえば、@WebService の serviceName 属性は、WSDL ファイル内の <service> 要素の name 属性と同じです。@WLHttpTransport の contextPath および serviceUri 属性は共に、WSDL 内の <address> 要素の location 属性で指定されたエンドポイント アドレスを構成します。

JWS ファイルを更新するときは、該当の Web サービス オペレーションが希望どおりに動作するように、メソッドに Java コードを追加します。通常、生成される JWS ファイルには、コードを追加すべき場所に次のようなコメントがあります。

  //ここを独自の実装で置き換える

他の JWS アノテーションをファイルに追加することもできますが、以下のような制限があります。

JWS ファイルを更新したら、wsdlc の出力場所にそのまま置いておかないで、正式なソースの場所に移動することをお勧めします。

以下の例は、「サンプル WSDL ファイル」の WSDL から wsdlc が生成した JWS 実装ファイルです。太字のテキストは、Web サービスの 1 つのオペレーション (getTemp) を実装する Java コードを追加する場所を示しています。

package examples.webservices.wsdlc;

import javax.jws.WebService;
import weblogic.jws.*;

/**
 * TemperaturePortTypeImpl クラスは、Web サービスのエンドポイント インタフェース 
 * TemperaturePortType を実装する */

@WebService(
  serviceName="TemperatureService",
  endpointInterface="examples.webservices.wsdlc.TemperaturePortType")

@WLHttpTransport(
  contextPath="temp",
  serviceUri="TemperatureService",
  portName="TemperaturePort")

public class TemperaturePortTypeImpl implements TemperaturePortType {

  public TemperaturePortTypeImpl() {

  }

  public float getTemp(java.lang.String zipcode)

  {

    //ここを独自の実装で置き換える

     return 0;

  }

}

WebLogic Web サービスのデプロイとアンデプロイ

Web サービスはエンタープライズ アプリケーションとしてパッケージ化されるので、Web サービスのデプロイとは、該当する EAR ファイルまたは展開されたディレクトリをデプロイすることになります。

Administration Console の使用から weblogic.Deployer Java ユーティリティの使用まで、WebLogic アプリケーションのデプロイには多様な方法があります。開発環境とは異なり、プロダクション環境にアプリケーションをデプロイする際には、他にもさまざまな問題を考慮する必要があります。デプロイメントの詳細な説明については、『WebLogic Server アプリケーションのデプロイメント』を参照してください。

このガイドでは、開発の性質上、Web サービスの 2 つのデプロイ方法についてのみ説明します。

wldeploy Ant タスクを使用した Web サービスのデプロイ

反復的な開発プロセスの一環として Web サービスを素早くデプロイする最も簡単な方法は、wldeploy WebLogic Ant タスクを実行するターゲットを、jwsc Ant タスクが含まれる build.xml ファイルに追加することです。Java コードを追加してサービスを再生成するたびに、サービスの再デプロイとテストを繰り返し行えるように、Web サービスをデプロイするターゲットとアンデプロイするターゲットの両方を追加することができます。

wldeploy Ant タスクを使用するには、以下のターゲットを build.xml ファイルに追加します。

  <target name="deploy">

      <wldeploy action="deploy"
        name="DeploymentName"
        source="Source" user="AdminUser"
        password="AdminPassword" 
        adminurl="AdminServerURL"
        targets="ServerName"/>

  </target>

各要素の説明は次のとおりです。

たとえば、以下の wldeploy タスクでは、エンタープライズ アプリケーションの展開されたディレクトリ (現在のディレクトリに対して相対的な output/ComplexServiceEar にある) が myServer WebLogic Server インスタンスにデプロイされることを指定します。デプロイメント名は ComplexServiceEar です。

  <target name="deploy">

    <wldeploy action="deploy"
      name="ComplexServiceEar"
      source="output/ComplexServiceEar" user="weblogic"
      password="weblogic" verbose="true"
      adminurl="t3://localhost:7001"
      targets="myserver"/>

  </target>

Web サービスを実際にデプロイするには、コマンドラインで deploy ターゲットを実行します。

  prompt> ant deploy

ソース コードに変更を加えてから Web サービスを再デプロイできるように、Web サービスを簡単にアンデプロイするターゲットを追加することもできます。

  <target name="undeploy">

    <wldeploy action="undeploy"
      name="ComplexServiceEar"
      user="weblogic"
      password="weblogic" verbose="true"
      adminurl="t3://localhost:7001"
      targets="myserver"/>

  </target>

Web サービスをアンデプロイするときは、source 属性を指定する必要はなく、名前によってアンデプロイします。

Administration Console を使用した Web サービスのデプロイ

Administration Console を使用して Web サービスをデプロイするには、最初に、ブラウザで次の URL を使用して Web サービスを呼び出します。

  http://[host]:[port]/console

各要素の説明は次のとおりです。

次にデプロイメント アシスタントを使用して、エンタープライズ アプリケーションをデプロイします。Administration Console の詳細については、Administration Console オンライン ヘルプを参照してください。

Web サービスの WSDL の参照

Web サービスの WSDL をブラウザで表示して、Web サービスが適切にデプロイされていることを確認できます。

次の URL は、Web サービスの WSDL をブラウザで表示する方法を示しています。

  http://[host]:[port]/[contextPath]/[serviceUri]?WSDL

各要素の説明は次のとおりです。

たとえば、Web サービスを実装する JWS ファイルで以下の @WLHttpTransport アノテーションを使用しているとします。

  ...

  @WLHttpTransport(contextPath="complex", 
                   serviceUri="ComplexService",
                   portName="ComplexServicePort")

  /**
   * WebLogic Web サービスの基本となる JWS ファイル。
   *
   */

  public class ComplexServiceImpl {

  ...

ここでは、jwsc Ant タスクの <WLHttpTransport> 要素と同等の属性は設定せず、したがって contextPath や serviceURI の値はオーバーライドされないこととします。そして、Web サービスが ariel というホストのデフォルトのポート番号 (7001) で実行されているとすると、その Web サービスの WSDL を表示する URL は次のようになります。

  http://ariel:7001/complex/ComplexService?WSDL

動的な WSDL で指定されたサーバ アドレスのコンフィグレーション

デプロイ済みの Web サービスの WSDL (「動的な WSDL」ともいう) には、特定の Web サービス ポートにアドレス (URI) を割り当てる <address> 要素が含まれています。たとえば、次に示す WSDL の抜粋には、ComplexService というデプロイ済みの WebLogic Web サービスの一部が記述されています。

<definitions name="ComplexServiceDefinitions"
             targetNamespace="http://example.org">

...

  <service name="ComplexService">
    <port binding="s0:ComplexServiceSoapBinding" name="ComplexServicePort">
      <s1:address location="http://myhost:7101/complex/ComplexService"/>
    </port>
  </service>

</definitions>

この例では、ComplexService Web サービスに ComplexServicePort というポートが含まれており、そのアドレスは http://myhost:7101/complex/ComplexService となっています。

WebLogic Server では、このアドレスの complex/ComplexService の部分が、WLXXXTransport アノテーションの contextPath および serviceURI 属性、または jwsc の各要素に基づいて決定されます (「Web サービスの WSDL の参照」を参照)。一方、アドレスのプロトコルとホストの部分 (この例では http://myhost:7101) を決定する方法は、以下に示すようにより複雑です。この節では、分かりやすいように、アドレスのプロトコルとホストの部分をまとめて「サーバ アドレス」と呼ぶことにします。

WebLogic Server がデプロイ済みの Web サービスの動的な WSDL 内にパブリッシュするサーバ アドレスは、その Web サービスを HTTP/S や JMS で呼び出せるかどうか、Web サービスがクラスタにデプロイされているかどうか、Web サービスが実際にはコールバック サービスであるかどうかによって異なります。以下では、これらのコンフィグレーションの違いに応じたサーバ アドレスの決定方法について説明します。また、ニーズに合わせてコンフィグレーションを変更するための手順説明へのリンクも示します。なお、ここでは、クラスタとスタンドアロン サーバを、WebLogic Server Administration Console を使用してコンフィグレーションすることを前提としています。

Web Service がコールバック サービスでなく、HTTP/S を使用して呼び出せる場合

Web Service がコールバック サービスでなく、JMS 転送を使用して呼び出せる場合

Web サービスがコールバック サービスである場合

Web サービスのテスト

WebLogic Web サービスのデプロイメントが完了したら、WebLogic Administration Console に含まれている Web サービス テスト クライアントを使用して、コードを記述することなくサービスをテストできます。複合型を持つ Web サービスや、WebLogic Server の高度な機能 (会話など) を使用する Web サービスも含めて、Web サービスを素早く簡単にテストできます。テスト クライアントはリクエストの完全なログを自動的に保持しているので、ユーザは以前の呼び出しに戻って結果を表示することができます。

デプロイした Web サービスを Administration Console を使用してテストするには、次の手順に従います。

Web サービスの WebLogic 分割開発ディレクトリ環境への統合

この節では、Web サービスの開発を WebLogic 分割開発ディレクトリ環境に統合する方法について説明します。この WebLogic 機能について理解していること、標準の J2EE アプリケーションおよびモジュール (EJB や Web アプリケーションなど) の開発用にこのタイプの環境をすでに設定済みであること、Web サービスの開発が含まれるように build.xml ファイルを更新しようとしていることを前提としています。

WebLogic 分割開発ディレクトリ環境の詳細については、「分割開発ディレクトリ環境の作成」および WebLogic Server と一緒にインストールされる splitdir/helloWorldEar サンプルを参照してください。サンプルは、BEA_HOME/weblogic90/samples/server/examples/src/examples ディレクトリにあります。BEA_HOME は BEA Products のメイン インストール ディレクトリ (c:/bea など) です。

これで、分割開発ディレクトリ環境は、Web サービスの開発を含むように更新されました。エンタープライズ アプリケーション全体を再ビルドしてデプロイするときに、Web サービスも EAR の一部としてデプロイされます。Web サービスは、「Web サービスの WSDL の参照」で説明されている標準的な方法で呼び出します。