WebOTX Manual V10.4 (第4版) 目次を表示

---

2.2. Webサービスの作成

2.2.1. Webサービス作成ウィザードについて

2.2.1.1. Webサービス作成ウィザードを使用する前に

JREの設定

WebOTXアプリケーションサーバのインストール

自動的にビルドの設定

Webサービス作成ウィザードの起動

新規ダイアログ

ポップアップメニュー

Memo
選択したプロジェクトのプロジェクト名とロケーションがWebサービスダイアログに表示されます。

2.2.2. JAX-WS(Webサービス作成ウィザード)

Webサービス

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

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

Caution
JAX-WS準拠のWebサービスを生成するには、Java コンパイラが 1.8または11 である必要があります。プロジェクトの右クリックメニュー プロパティをクリックして、プロパティダイアログで、以下3か所の設定が1.8または11であることを確認してください。
1.JAVAのビルド・パス > ライブラリ　ページのJREバージョン
2.JAVAコンパイラーページのコンパイラー準拠レベル
3.プロジェクト・ファセットページのJavaのバージョン

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

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

Webサービスの基本設定

Caution
Webサービスの属する名前空間URIの値に基づいてパッケージを生成するため、長すぎる名前空間名を指定すると、全体のファイルパス長がWindowsOSの制限となる256文字を超えることがあります。

Memo
Webサービス名は、Webサービス作成時にクラス名として使用するため、Javaの識別子の規則に従っていないとエラーメッセージが表示されます。

Memo
名前空間は、Webサービスが存在する空間の名前のことです。Javaのパッケージ名に相当します。

Memo
URIは、ウェブ上でリソースを識別する手段で、スキームに続けて名前を指定する形式です。http:、mailto:、urn:などのスキームはよく知られたところでしょう。詳細は、「URI」でウェブ検索してください。

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

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

ここでWebサービスの作成を開始できます

詳細設定

Webサービスロジックの実装

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

2.2.2.1. 動的Webプロジェクト - Webサービス(JAX-WS)

■settingsフォルダ

■srcフォルダ

■WebContent\WEB-INFフォルダ

■WebContent\WEB-INF\wsdl フォルダ

2.2.2.2. EJBプロジェクト - Webサービス(JAX-WS)

■settingsフォルダ

■build\classesフォルダ

■ejbModuleフォルダ

■ejbModule\META-INFフォルダ

2.2.2.3. WSDLファイルの生成

WSDLファイルを生成する前に

ポップアップメニュー

動的Webプロジェクト

EJB プロジェクト

Memo
以下の状況でwsgenツールを実行すると、「Class not found」エラーが発生する可能性があります。
1. 選択したプロジェクトのパッケージ名はwizard.xmlから取得したパッケージ名と一致しない。（例：プロジェクトのパッケージ名を変更したことがあります。）
2. 選択したプロジェクトのwizard.xmlからパッケージ名を取得できず、且つプロジェクトのパッケージ名はデフォルトパッケージ名と一致しない。（例：V10.xで生成したプロジェクトをデフォルトパッケージの違いワークスペースにインポートした。）
        ※ デフォルトパッケージは[パッケージ名変更の設定]を参照してください。
wizard.xmlを以下のように修正することで解決できます。

wizard.xmlファイルの修正方法
<?xml version="1.0" encoding="UTF-8"?>
<webservice version="2.0" xmlns="http://www.nec.co.jp/WebOTX/webservice/director" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.nec.co.jp/WebOTX/webservice/director/wizard.xsd">
  <server>
  ......
    <setting name="WebservicePackage" value="パッケージ名"/>
  ......
</server>
</webservice>
※パッケージ名はプロジェクトのパッケージです。(例：sample.hello.helloservice)

Caution
WSDLを生成するためには、Webサービスクラスの *.class ファイルが必要です。自動ビルドを OFF にしている場合など、*.class が無い場合は実行できませんので 予めビルドして下さい。

2.2.2.4. 添付ファイル

• MTOM
• WS-I Attachments Profile

2.2.3. JAX-RPC(Webサービス作成ウィザード)

Memo
本機能は旧互換のための機能です。 新規にWebサービスを作成する場合は、JAX-WSに準拠するサービスを作成してください。

Webサービス

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

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

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

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

Webサービスの基本設定

Memo
Webサービス名は、Webサービス作成時にクラス名として使用するため、Javaの識別子の規則に従っていないとエラーメッセージが表示されます。

Memo
名前空間は、Webサービスが存在する空間の名前のことです。Javaのパッケージ名に相当します。

Memo
URIは、ウェブ上でリソースを識別する手段で、スキームに続けて名前を指定する形式です。http:、mailto:、urn:などのスキームはよく知られたところでしょう。詳細は、「URI」でウェブ検索してください。

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

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

Webサービスのビジネスロジックの選択

Caution
ビジネスロジックとして指定するプロジェクトは、Eclipseのビルド機能によりビルドが成功しているものでなければなりません。

Caution
ビジネスロジックとして指定するプロジェクトが参照するプロジェクトも、すべてEclipseのビルド機能によりビルドが成功しているものでなければなりません。

Memo
Antでビルドを行っており、Eclipseのビルド機能ではビルドに失敗するプロジェクトを指定したい場合は、一旦Antによるビルドでアーカイブを作成すれば、そのアーカイブを指定してWebサービスを作成することができます。

Memo
ビジネスロジックとして指定した外部ファイル(アーカイブファイル)の読み込みに失敗する場合、対象のアーカイブファイルを解凍しMETA-INF\MANIFEST.MFをフォルダごと手動で削除後、同じMETA-INF\MANIFEST.MFを再度追加してアーカイブし直すことで解消される場合があります。

クラスの選択

Caution
インタフェース、抽象化クラスは選択しないでください。

Caution
パッケージ名のついていないクラス（デフォルトパッケージに存在するクラス）は表示されません。

Memo
異なるパッケージに存在する複数のクラスを同時に選択することもできます。

EJBの選択

Caution
ステートレスセッションBean以外のEJBは表示されません。

メソッドの選択

Caution
インタフェース、抽象化クラスはプルダウンメニューには表示されません。

Caution
1つのクラス内に同名のメソッドが複数ある場合、それらを同時に複数選択することはできません。

Caution
コンストラクタ、小文字で始まっていない名前のメソッドは選択できません。

Caution
ビジネスロジックがEJBの場合で、メソッド名に数字がある場合、その直後の文字は大文字でなければなりません。

Memo
異なるクラスに存在する複数のメソッドを同時に選択することもできます。

2.2.3.1. Web サービスと型

• ★のついたもの以外は、その型の配列型にも対応します。
• xsd の名前空間URI は「http://www.w3.org/2001/XMLSchema」です。
• soapenc の名前空間URI は「http://schemas.xmlsoap.org/soap/encoding/」です。

2.2.3.2. 型に関する注意

2.2.3.3. 添付ファイル

• javax.activation.DataHandler
• java.awt.Image
• javax.mail.internet.MimeMultipart
• javax.xml.transform.Source

2.2.3.4. ユーザ定義の例外

public class UserException extends Exception { 
  public UserException(String arg0) { 
    super(arg0); 
  } 
} 
    

<detail> 
  <ns1:UserException xsi:type="ns0:UserException"> 
    <message xsi:type="xsd:string">例外のメッセージ</message> 
  </ns1:UserException> 
</detail>
    

public class UserException extends Exception { 
  private int code; 
  private String message; 
  public int getCode() { 
    return code; 
  } 
  public void setCode(int code) { 
    this.code = code; 
  } 
  public String getMessage() { 
    return message; 
  } 
  public void setMessage(String message) { 
    this.message = message; 
  } 
}
    

public void construct() { 
  _instance = new com.nec.webotx.webservice.sample.UserException(code,message); 
}
    

public void construct() { 
  _instance = new com.nec.webotx.webservice.sample.UserException(); 
  _instance.setCode(code); 
  _instance.setMessage(message); 
}
    

if (isComplete) { 
  instance = new com.nec.webotx.webservice.sample.UserException(((Integer)codeTemp).intValue(),(java.lang.String)messageTemp); 
} else {
    

if (isComplete) { 
  instance = new com.nec.webotx.webservice.sample.UserException(); 
  instance.setCode(((Integer)codeTemp).intValue()); 
  instance.setMessage((java.lang.String)messageTemp); 
} else {
    

instance = new com.nec.webotx.webservice.sample.UserException(((Integer)codeTemp).intValue(),(java.lang.String)messageTemp);
    

instance = new com.nec.webotx.webservice.sample.UserException(); 
instance.setCode(((Integer)codeTemp).intValue()); 
instance.setMessage((java.lang.String)messageTemp);
    

<detail> 
  <ns1:UserException xsi:type="ns0:UserException"> 
    <code xsi:type="xsd:int">012345</code> 
    <message xsi:type="xsd:string">例外のメッセージ</message> 
  </ns1:UserException> 
</detail>
    

2.2.3.5. パラメータの入出力

• WebServiceClient.java
  自動生成されたメソッド(getData_LogicBean)で自動生成されたクラス(webotx.ws.ds.WebService.holders.TestDataHolder)にユーザ定義されたHolderクラス(test.TestDataHolder)を格納する必要があります。
  修正前
  

  public int getData_LogicBean(java.lang.String in0, test.TestDataHolder in1) throws java.rmi.RemoteException {
      return binding.getData_LogicBean(in0, in1);
  }

  修正後
  

  import webotx.ws.ds.WebService.holders.TestDataHolder;
      public int getData_LogicBean(java.lang.String in0, test.TestDataHolder in1) throws java.rmi.RemoteException {
          TestDataHolder td = new TestDataHolder(in1.getValue());
          return binding.getData_LogicBean(in0,td);
      }
  

• WebServiceSoapBindingImpl.java
  WebServiceClient.javaとは逆のことを行ってください。
  修正前
  

  public int getData_LogicBean(javax.xml.rpc.holders.ByteArrayHolder in0, test.TestDataHolder in1) throws java.rmi.RemoteException {
      try {
          return new test.TestDelegate().getData(in0, in1);
      } catch (Throwable e) {
          throw new java.rmi.RemoteException("", e);
      }
  }

  修正後
  

  public int getData_LogicBean(java.lang.String in0, webotx.ws.ds.WebService.holders.TestDataHolder in1) throws java.rmi.RemoteException {
      try {
          test.TestDataHolder td = new test.TestDataHolder(in1.value);
          return new test.TestDelegate().getData(in0, td);
      } catch (Throwable e) {
          throw new java.rmi.RemoteException("", e);
      }
  }

2.2.3.6. パッケージ名変更の設定

配備の設定

Caution
指定する文字列の最初と最後に「/」をつける必要はありません。

Memo
「foo/var/service」のような深い階層を設定することもできます。

ここでWebサービスの作成を開始できます

詳細設定

Caution
Document/literal/wrappedを選択したとき、Webサービス化するメソッドにvoid（返却値なし）のものが含まれる場合、必ず「一方向通信を行う」をONにしてください。配備に失敗します。

Caution
パッケージ名と名前空間URIのマッピングを設定する場合は、必要な設定をすべて行ってください。自動でマッピングする機能は、ここで設定を1つでも行うと働きません。

Memo
WS-IモードをONにしている場合には、RPC/literalかDocument/literal/wrappedしか選択できません。

Memo
パッケージ名と名前空間URIのマッピングは、ここで指定しなければ自動で行われます。その際の規則は、「http://パッケージ名のドット区切りで逆順の文字列」になります。

Memo
WSDLも自動的に作られるので、WSDLにXMLスキーマを定義することについて気にする必要はありません。

wscompileコマンドオプションの編集

Caution
WebOTX Developer's Studioでは既定で指定しているオプションがあり、この画面で既定のオプション設定と異なるオプションを入力した場合、画面で指定されたオプションが有効となります。

この画面では下記のオプションを指定できます。

2.2.3.7. 動的Webプロジェクト

■settingsフォルダ

■build\classesフォルダ

■srcフォルダ

■configフォルダ

■keystoreフォルダ

■WebContent\WEB-INFフォルダ

Caution
ビジネスロジックを置換するとき、Webサービス化したメソッドのインタフェースを変えることはできません。

■WebContent\WEB-INF\classesフォルダ

■WebContent\WEB-INF\libフォルダ

■WebContent\WEB-INF\wsdl フォルダ

2.2.3.8. EJB Project- Webサービス(JAX-RPC)

■settingsフォルダ

■build\classesフォルダ

■ejbModuleフォルダ

Caution
ビジネスロジックを置換するとき、Webサービス化したメソッドのインタフェースを変えることはできません。

■ejbModule\META-INFフォルダ

■ejbModule\META-INF\wsdl フォルダ

■configフォルダ

■libフォルダ

■keystoreフォルダ

2.2.4. SOAPメッセージを直接処理するサーブレット

Caution
SOAPメッセージの処理に必ずSAAJを使用しなければならないということではありません

2.2.4.1. サーブレットのインタフェースを決める

2.2.4.2. WSDLの作成

Caution
WSDLは必ず作成しなければならないものではありません。

2.2.4.3. プロジェクトを作成する

新規プロジェクトダイアログ

新規動的Webプロジェクト

2.2.4.4. Webプロジェクトの設定をする

2.2.4.5. サーブレットを作成する

サーブレットの作成ウィザード

2.2.4.6. 生成されたサーブレットクラスの編集

2.2.4.7. SOAPメッセージ処理クラスの追加

2.2.4.8. WARファイルを作成する

Webプロジェクトへのファイル追加

エクスポート

2.2.4.9. WARファイルを配備する