Apdesigner プログラマーズガイド

4.3.1 サービスエンドポイントインタフェースに関する規則について

サービスエンドポイントインタフェースを作成する場合の留意事項を示します。

• インタフェース
• メソッド
• 使用可能なデータ型
• out/inoutパラメタ
• 例外

+インタフェース

サービスエンドポイントインタフェースは、java.rmi.Remoteを継承する必要があります。

+メソッド

サービスエンドポイントインタフェースに宣言するメソッドは、必ずjava.rmi.RemoteExceptionをthrowするように宣言する必要があります。

+使用可能なデータ型

Webサービスでは、Javaで以下のデータ型について受け渡しをすることができます。

• プリミティブ型
  boolean, byte, short, int, long, float, double
  
• プリミティブ型のラッパークラス型
  java.lang.Boolean, java.lang.Byte, java.lang.Short, java.lang.Integer, java.lang.Long, java.lang.Float, java.lang.Double
  
• 標準クラス型
  java.lang.String, java.util.Calendar, java.math.BigInteger, java.math.BigDecimal, javax.xml.namespace.QName, java.net.URI
  
• 構造体型・Bean型(ユーザ定義クラス型)
  構造体型・Bean型クラスは以下の要件を満たす必要があります。クラス内のメンバ(構造体の場合publicインスタンスフィールド、Bean型の場合JavaBeansのget/setメソッドで表現されるプロパティ)のみ、情報の受渡しが行われます。
  • publicデフォルトコンストラクタをもつpublicクラス
  • java.rmi.Remoteインタフェースを実装していない
  • クラス内のメンバ(publicインスタンスフィールド、もしくはJavaBeansのget/setメソッドで表現されるプロパティ)型は使用可能なデータ型でなければならない
  • 継承する場合は、継承される側も構造体型・Bean型条件を満たさなければならない
    
• 配列型
  使用可能な型の配列

ユーザ定義クラス型のメンバとして配列を使うこともできます。また、ユーザ定義クラス型の配列をデータ型として使用することもできます。

style属性/use属性にRPC/LITERALを指定する場合には、プリミティブ型のラッパークラス型は使用できません。

+out/inoutパラメタ

Webサービスでは、メソッドの復帰値以外でもサーバからクライアントに値を返信することができます。値をサーバから返信するのみのパラメタをoutパラメタといい、値をクライアントから送信し、サーバから返信するパラメタをinoutパラメタといいます。
サービスエンドポイントインタフェース上では、out/inoutパラメタの区別はなく、どちらもHolderクラスを使用します。

プリミティブ型やそのラッパークラス型、標準クラス型には、javax.xml.rpc.holders パッケージに以下のクラス名で標準のHolderクラスが提供されていますので、これらのHolderクラスを使用します。

StringHolder, BooleanHolder, BooleanWrapperHolder, ByteHolder, ByteWrapperHolder, DoubleHolder, DoubleWrapperHolder, FloatHolder, FloatWrapperHolder, IntHolder, IntegerWrapperHolder, LongHolder, LongWrapperHolder, CalendarHolder, QNameHolder, ShortHolder, ShortWrapperHolder, BigDecimalHolder, BigIntegerHolder, ByteArrayHolder

style属性/use属性にRPC/LITERALを指定する場合には、プリミティブ型のラッパークラス型は使用できません。
そのため、XxxxxWrapperHolderクラスも使用できません。

ユーザ定義クラス型や配列型など、標準でHolderクラスが提供されていない場合、固有のHolderクラスを用意して使用します。

• Holderクラス
  Holderクラスは以下の要件を満たす必要があります。
  • 受け渡すデータ型でpublicインスタンスフィールドを定義するpublicクラス
  • 上記のpublicインスタンスフィールドの名前はvalueとする
  • 受け渡すデータ型を引数に持つpublicコンストラクタを定義する
  • 上記のコンストラクタ内では、引数の値でpublicインスタンスフィールドを初期化する
  • javax.xml.rpc.holders.Holder インタフェースを実装している
  • 利用するデータ型クラスのパッケージに"holders"を付加したパッケージに属している（例：com.example.Dataの場合、com.example.holders.DataHolderになります）

    【Holderクラスの定義例(内容型がcom.example.Personクラスの場合)】

    package com.example.holders;
    
    final public class PersonHolder implements javax.xml.rpc.holders.Holder {
        public com.example.Person value;
        public PersonHolder() {}
        public PersonHolder(com.example.Person initial) { value = initial; }
    }

+例外

Webサービスでは、メソッドから例外を返すことができます。
ただし、構造体型・Bean型と同様に、使用可能な型でかつクラス内のメンバ(構造体の場合publicインスタンスフィールド、Bean型の場合JavaBeansのget/setメソッドで表現されるプロパティ)のみ、情報の受渡しが行われます(Throwable.getCause()で取得できる原因を表す例外などは受け渡しが行われません)。