アプリケーションの開発: WebOTX Developer Manual

WebOTX Manual V12.1 (第3版)

目次を表示

2.4. WSDLやXML書式からのWebサービスの作成

ここでは、WSDLや XML から Web サービスを作成する方法について説明します。

2.4.1. WSDL、XMLスキーマの作成

ここでは、Webサービスの作成に必要なWSDLファイルやXMLファイルの作成について説明します。

WSDLファイルの作成

WebOTX Developer's Studioのメニュー ファイル > 新規 > その他を選択すると、新規ダイアログが起動します。
WSDLファイルを作成するには、Web サービス > WSDL Fileを選択し、次へをクリック。

新規 Webサービス WSDL File

WSDLファイルの生成先を選択し、ファイル名 に生成するWSDLのファイル名を入力します。
入力が完了したら次へをクリック。

新規 WSDL ファイルファイル名入力

生成するWSDLファイルの基本の内容を設定します。
設定が完了したら完了をクリックしてWSDLファイルを生成します。

新規 WSDL ファイルファイルの属性

XMLファイルの生成

WebOTX Developer's Studioのメニューファイル > 新規 > その他を選択すると、新規ダイアログが起動します。
XMLファイルを作成するには、XML > XML ファイルを選択し、次へをクリック。

新規 XML ファイル

XMLファイルの生成先を選択し、ファイル名 に生成するXMLのファイル名を入力します。
入力が完了したら完了をクリック。

新規 XML ファイルファイル名入力

2.4.2. JAX-WS（ウィザード）

ここでは、Webサービス作成ウィザードを使用してWSDLファイルから JAX-WS準拠のWebサービスを作成する方法について説明します。
初期設定や起動方法については、[Webサービスの作成]を参照してください。

Webサービス

プロジェクト名にWebサービスを生成するプロジェクトの名前を指定します。カレントワークスペースにある既存のプロジェクト又は新規に作成するプロジェクト名を指定できます。プロジェクトは、デフォルトでは
<WebOTX_DIR>\Studio\workspace\指定したプロジェクト名
というフォルダに作成されます。もし、別の場所に作成したい場合は、 デフォルトロケーションの使用をOFFにして、任意の場所を絶対パスで指定します。
WSDLから作成 を選択し、Webサービスの元となるWSDLファイルを指定します。
以上の設定を終了したら、次へをクリック。

新規 Webサービス仕様 JAX-WS WSDLから作成選択

Caution
指定したプロジェクトにウィザードで作成したWebサービスが既に存在している場合、Webサービスを生成することができません。

Caution
プロジェクトには動的WebプロジェクトとEJBプロジェクトのみを指定できます。

Memo
プロジェクト名に含めてはいけない文字を含めると、エラーメッセージが表示されます。

Memo
<WebOTX_DIR>はWebOTXのインストールルートディレクトリのことです。

Webサービスの実装形式選択

Webサービスを実装する形式を選択します。選択したら、次へをクリック。

新規 Webサービス実装形式選択

Memo
Webアプリケーションを選択した場合、動的Webプロジェクトを生成します。EJBを選択した場合、EJB プロジェクトを生成します。

ここでWebサービスの作成を開始できます
完了をクリックすると、Webサービスの作成を開始します。

新規 Webサービス作成開始

Caution
WSDLファイル中で別のファイルをインポートした場合、インポートされるファイルを<ワークスペース>\<プロジェクト>/src/main/webapp/WEB-INF/wsdl/フォルダに手動でコピーする必要があります。コピー先は、wsdl フォルダをルートにしての相対パス上にコピーします。
例えば、
--------wsdl ファイル--------
…
  <types>
    <xsd:schema>
    <xsd:import namespace=http://packagename/
      schemaLocation="ext/TestServiceService_schema1.xsd"/>
    </xsd:schema>
  </types>
…
--------wsdl ファイル--------
「TestServiceService_schema1.xsd」ファイルをwsdl/ext フォルダ配下にコピーします。

Memo
ファイルをインポートできるタグは以下の通りです： wsdl:import
xsd:import
xsd:include

Memo
コピー後、WSDLファイルの解析エラーが解消されない場合は、WSDLファイルの右クリックメニュー検証を選択してください。

ビジネスロジックの実装

作成されたプロジェクトに生成された javaソースのうち、「*Impl.java」のjavaソースが生成されます。
ロジックを実装する部分になりますので、このクラスにロジックを実装します。

Memo
ロジックを作成する際に、アノテーションエディタを使用するとアノテーションの入力が簡単に行えます。アノテーションエディタについては、 [ 開発環境の構築(WebOTX Developer) > アノテーション定義支援ツール ] を参照して下さい。

2.4.3. JAX-WS(コマンド)

サーバアプリケーションを作成するには次の2通りの方法があります。

Webサービスエンドポイント実装クラスから開発する方法

WSDLから開発する方法
前者はWebサービスエンドポイント実装クラスを作成し、その実装クラスから、Request/Response Beanなどの配備に必要なクラスを自動生成する方法です。WSDLを自動生成することから、Webサービス固有のWSDLを記述する手間を省くことができます。
それに対して、後者はWSDLを作成し、そのWSDLからサービスエンドポイントインタフェースを自動生成し、そのサービスエンドポイントインタフェースを実装する方法です。既存のWSDLが存在する場合やWSDLを直接記述できる場合に使用できます。
ここでは、文字列を送受信する簡単なJAX-WSのサンプルプログラムを例にして説明します。

環境設定

環境変数JAVA_HOMEに、JDKインストールディレクトリを指定してください。また、javacコマンドがコマンド検索パスに加わるよう、環境変数PATHに<JAVA_HOME>/binを追加してください。
また、JAX-WSアプリケーションを作成する場合は次のライブラリをクラスパスに含めてください。環境変数CLASSPATHに設定すると仮定して説明します。

<WebOTX_DIR>/modules/jakarta.activation-api.jar
<WebOTX_DIR>/modules/wows-api.jar
<WebOTX_DIR>/modules/wows-rt.jar
<WebOTX_DIR>/modules/wows-tools.jar
<WebOTX_DIR>/lib/jakartaee.jar

Memo
<WebOTX_DIR>はWebOTXのインストールディレクトリに読み替えてください。

Webサービスエンドポイント実装クラスから開発する方法

Webサービスエンドポイント実装クラスからJAX-WSプログラムを作成するためのファイル構成例は、次の通りです。任意のディレクトリに次のファイルを作成してください。それぞれのファイルの内容については、後ほど説明します。

ディレクトリ	ファイル
src/main/java/sample/	Hello.java
src/main/webapp/WEB-INF/	nec-jaxws.xml web.xml

1. Webサービスエンドポイント実装クラスの作成
Webサービスエンドポイント実装クラスを作成します。このとき、Webサービスとして公開するクラスには、jakarta.jws.WebServiceアノテーションを記述します。jakarta.jws.WebServiceをインポートしている場合は、アノテーションでのパッケージ名の指定を省略することができます。
Hello.java

package sample; 

import jakarta.jws.WebService; 

@WebService(targetNamespace ="http://sample", serviceName = "Hello")
public class Hello {
  public String sayHello(String name) {
    return "Hello " + name + "!";
  }
}

2. 配備するクラスの作成
javacコマンドを使用して、配備するクラスを生成します。srcディレクトリで実行したjavacコマンドの例は次の通りです。なお、次のコマンドを実行する際に、出力ディレクトリWEB-INF/classesが自動で作成されます。

src> javac -processor com.nec.webotx.webservice.tools.ws.processor.modeler.annotation.WebServiceAp -d ../src/main/webapp/WEB-INF/classes -cp %CLASSPATH% -s main/java main/java/sample/Hello.java

Memo
<WebOTX_DIR>はWebOTXのインストールディレクトリに読み替えてください。

これにより、次のファイルが生成されます

ディレクトリ	ファイル
src/main/java/sample/jaxws	SayHello.java SayHelloResponse.java
src/main/webapp/WEB-INF/classes/sample/	Hello.class
src/main/webapp/WEB-INF/classes/sample/jaxws	SayHello.class SayHelloResponse.class

Webサーバに配備するためのwarを作成します。エンドポイントの定義ファイルnec-jaxws.xmlは次のようになります。
nec-jaxws.xml

<?xml version="1.0" encoding="UTF-8"?> 
<endpoints xmlns="http://www.nec.com/WebOTX/xml/ns/jax-ws/ri/runtime" version="2.0"> 
  <endpoint 
    name="Hello" 
    implementation="sample.Hello" 
    url-pattern="/hello"/> 
</endpoints>

<endpoint>の属性	説明
name	Webサービスエンドポイントの識別子を指定します。
implementation	Webサービスエンドポイントの実装クラス名を指定します。
url-pattern	WebサービスエンドポイントへアクセスするためのURLを指定します。

配備記述子web.xmlは次のようになります。WSDLから開発する方法も同じ内容になります。
web.xml

<?xml version="1.0" encoding="UTF-8"?> 
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="https://jakarta.ee/xml/ns/jakartaee" 
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd" 
id="WebApp_ID" version="6.0">
  <display-name>Hello Service Endpoint</display-name> 
  <listener> 
    <listener-class>com.nec.webotx.webservice.xml.ws.transport.http.servlet.WSServletContextListener</listener-class> 
  </listener> 
  <servlet> 
    <display-name>HelloServlet</display-name> 
    <servlet-name>HelloServlet</servlet-name> 
    <servlet-class>com.nec.webotx.webservice.xml.ws.transport.http.servlet.WSServlet</servlet-class> 
    <load-on-startup>1</load-on-startup> 
  </servlet> 
  <servlet-mapping> 
    <servlet-name>HelloServlet</servlet-name> 
    <url-pattern>/hello</url-pattern> 
  </servlet-mapping> 
  <session-config> 
    <session-timeout>60</session-timeout> 
  </session-config> 
</web-app>

最後に、サーバアプリケーションと各種設定ファイルをWARファイルにアーカイブします。WARファイルに含めるファイルは次のように配置します。

ディレクトリ	ファイル
src/main/webapp/WEB-INF/	nec-jaxws.xml, web.xml
src/main/webapp/WEB-INF/classes/	サーバアプリケーションのクラスファイル

上記構成のWEB-INFディレクトリが用意できたら、src/main/webappディレクトリで次のコマンドを実行してWARファイルを作成します。WARファイルが生成されたらWebサーバに配備してください。

src/main/webapp/> jar cvf ../hellows.war WEB-INF

WSDLから開発する方法

WSDLからJAX-WSプログラムを作成するためのファイル構成例は、次の通りです。任意のディレクトリに次のファイルを作成してください。それぞれのファイルの内容については、後ほど説明します。

ディレクトリ	ファイル
src/main/java/sample/	HelloImpl.java
src/main/webapp/WEB-INF/	nec-jaxws.xml web.xml
src/main/webapp/WEB-INF/wsdl/	hello.wsdl

1. エンドポイントのWSDLの作成
Webサービスのエンドポイントインタフェースを記述したWSDLを準備します。サンプルに含まれているhello.wsdlをコピーするか、次の内容をテキストエディタ等で作成します。
hello.wsdl

<?xml version="1.0" encoding="UTF-8"?> 
<definitions xmlns="http://schemas.xmlsoap.org/wsdl/" 
 xmlns:tns="http://sample" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" 
 targetNamespace="http://sample" name="Hello"> 
  <types> 
    <xs:schema version="1.0" 
     targetNamespace="http://sample" xmlns:tns="http://sample" xmlns:xs="http://www.w3.org/2001/XMLSchema"> 
      <xs:element name="sayHello" type="tns:sayHello"/> 
      <xs:element name="sayHelloResponse" type="tns:sayHelloResponse"/> 
      <xs:complexType name="sayHello"> 
        <xs:sequence> 
          <xs:element name="arg0" type="xs:string" minOccurs="0"/> 
        </xs:sequence> 
      </xs:complexType> 
      <xs:complexType name="sayHelloResponse"> 
        <xs:sequence> 
          <xs:element name="return" type="xs:string" minOccurs="0"/> 
        </xs:sequence> 
      </xs:complexType> 
    </xs:schema> 
  </types> 
  <message name="sayHello"> 
    <part name="parameters" element="tns:sayHello"/> 
  </message> 
  <message name="sayHelloResponse"> 
    <part name="parameters" element="tns:sayHelloResponse"/> 
  </message> 
  <portType name="Hello"> 
    <operation name="sayHello"> 
      <input message="tns:sayHello"/> 
      <output message="tns:sayHelloResponse"/> 
    </operation> 
  </portType> 
  <binding name="HelloPortBinding" type="tns:Hello"> 
    <soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/> 
    <operation name="sayHello"> 
      <soap:operation soapAction=""/> 
      <input> 
        <soap:body use="literal"/> 
      </input> 
      <output> 
        <soap:body use="literal"/> 
      </output> 
    </operation> 
  </binding> 
  <service name="Hello"> 
    <port name="HelloPort" binding="tns:HelloPortBinding"> 
      <soap:address xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" location="http://localhost:80/hellows/hello"/> 
    </port> 
  </service> 
</definitions>

Caution
WSDLファイルの次のホスト名およびポート番号を環境に合わせて変更してください。
location="http://localhost:80/hellows/hello"
また、クライアントアプリケーションを作成する場合は、「WSDLファイルから作成したクライアントについて」を参照してください。

2. サービスエンドポイントインタフェースの生成
wsimportコマンドを使用してサービスエンドポイントインタフェースや、インポートしたXMLスキーマからマッピングされるバリュークラスを生成します。なお、次のコマンドを実行する前に、あらかじめ出力ディレクトリsrc/main/webapp/WEB-INF/classesを作成しておいてください。

src> wsimport -d ../src/main/webapp/WEB-INF/classes -s main/java -keep ../src/main/webapp/WEB-INF/wsdl/hello.wsdl

wsimportコマンドの詳細に関しては、本ガイドの [ コマンドリファレンス > wsimport ] を参照してください。これにより、次のファイルが生成されます

ディレクトリ	ファイル
src/main/java/sample/	Hello.java Hello_Service.java ObjectFactory.java package-info.java SayHello.java SayHelloResponse.java
src/main/webapp/WEB-INF/classes/sample/	Hello.class Hello_Service.class ObjectFactory.class package-info.class SayHello.class SayHelloResponse.class

wsimportコマンドで自動生成されたサービスエンドポイントインタフェースは次のようになります。
Hello.java

package sample; 

import jakarta.jws.WebMethod; 
import jakarta.jws.WebParam; 
import jakarta.jws.WebResult; 
import jakarta.jws.WebService; 
import jakarta.xml.bind.annotation.XmlSeeAlso; 
import jakarta.xml.ws.RequestWrapper; 
import jakarta.xml.ws.ResponseWrapper; 

@WebService(name = "Hello",targetNamespace ="http://sample") 
@XmlSeeAlso({ 
  ObjectFactory.class 
}) 
public interface Hello { 
  @WebMethod 
  @WebResult(targetNamespace = "") 
  @RequestWrapper(localName = 
    "sayHello", targetNamespace ="http://sample", className = "sample.SayHello") 
  @ResponseWrapper(localName = 
    "sayHelloResponse", targetNamespace= "http://sample", 
    className ="sample.SayHelloResponse") 

  public String sayHello( 
    @WebParam(name = "arg0", targetNamespace = "") 
    String arg0); 
}

3. サービスエンドポイントインタフェースの実装
wsimportコマンドで生成された、サービスエンドポイントインタフェースを実装します。
HelloImpl.java

package sample; 

import jakarta.jws.WebService; 

@WebService(endpointInterface = "sample.Hello") 
public class HelloImpl { 
  public String sayHello(String name) { 
    return "Hello " + name + " !"; 
  } 
}

実装クラスではWebServiceアノテーションを記述し、endpointInterfaceにはwsimportコマンドで自動生成されたサービスエンドポイントインタフェースのクラス名をフルパッケージで指定してください。
そして実装クラスをコンパイルします。

src> javac -d ../src/main/webapp/WEB-INF/classes main/java/sample/HelloImpl.java

Webサーバに配備するためのwarを作成します。エンドポイントの定義ファイルnec-jaxws.xmlは次のようになります。
nec-jaxws.xml

<?xml version="1.0" encoding="UTF-8"?> 
<endpoints xmlns="http://www.nec.com/WebOTX/xml/ns/jax-ws/ri/runtime" version="2.0"> 
  <endpoint 
    name="Hello" 
    interface="sample.Hello" 
    implementation="sample.HelloImpl" 
    wsdl="WEB-INF/wsdl/hello.wsdl" 
    service="{http://sample}Hello" 
    port="{http://sample}HelloPort" 
    url-pattern="/hello"/> 
</endpoints>

<endpoint>の属性	説明
name	Webサービスエンドポイントの識別子を指定します。
interface	自動生成されたサービスエンドポイントインタフェースを指定します。
implementation	Webサービスエンドポイントの実装クラス名を指定します。
wsdl	wsimportで指定したWSDLファイルを指定します。
service	WSDLファイルのservice要素のname属性に記述した、エンドポイントのサービス名を指定します。
port	WSDLファイルのport要素のname属性に記述した、エンドポイントのポート名を指定します。
url-pattern	WebサービスエンドポイントへアクセスするためのURLを指定します。

配備記述子web.xmlは次のようになります。Webサービスエンドポイント実装クラスから開発する方法と同じ内容になります。
web.xml

<?xml version="1.0" encoding="UTF-8"?> 
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="https://jakarta.ee/xml/ns/jakartaee" 
xmlns:web="https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd" 
xsi:schemaLocation="https://jakarta.ee/xml/ns/jakartaee https://jakarta.ee/xml/ns/jakartaee/web-app_6_0.xsd" 
version="6.0">
  <display-name>Hello Service Endpoint</display-name> 
  <listener> 
    <listener-class>com.nec.webotx.webservice.xml.ws.transport.http.servlet.WSServletContextListener</listener-class> 
  </listener> 
  <servlet> 
    <display-name>HelloServlet</display-name> 
    <servlet-name>HelloServlet</servlet-name> 
    <servlet-class>com.nec.webotx.webservice.xml.ws.transport.http.servlet.WSServlet</servlet-class> 
    <load-on-startup>1</load-on-startup> 
  </servlet> 
  <servlet-mapping> 
    <servlet-name>HelloServlet</servlet-name> 
    <url-pattern>/hello</url-pattern> 
  </servlet-mapping> 
  <session-config> 
    <session-timeout>60</session-timeout> 
  </session-config> 
</web-app>

最後に、サーバアプリケーションと各種設定ファイルをWARファイルにアーカイブします。WARファイルに含めるファイルは次のように配置します。

ディレクトリ	ファイル
src/main/webapp/WEB-INF/	nec-jaxws.xml, web.xml
src/main/webapp/WEB-INF/wsdl/	hello.wsdl
src/main/webapp/WEB-INF/classes/	サーバアプリケーションのクラスファイル

上記構成のWEB-INFディレクトリが用意できたら、src/main/webappディレクトリで以下のコマンドを実行してWARファイルを作成します。WARファイルが生成されたらWebサーバに配備してください。

src/main/webapp> jar cvf ../hellows.war WEB-INF