5.6.1 Fault情報の設定

Interstage Application Server SOAPサービスユーザーズガイド

目次索引

5.6.1 Fault情報の設定

　RPCサーバアプリケーションのメソッドが例外を投げる(throwする)と、RPCクライアントアプリケーションに対してFault情報が送信されます。Fault情報は、発生した問題に関する情報をRPCクライアントアプリケーションに通知するものです。
　RPCサーバアプリケーションで例外としてjavax.xml.rpc.soap.SOAPFaultExceptionをthrowすることで、送信されるFault情報の内容を設定できます。
　RPCサーバアプリケーションのメソッドがjavax.xml.rpc.soap.SOAPFaultException以外のThrowableオブジェクトをthrowした場合、以下の情報が含まれたFault情報を送信します。

Faultコード	"Server"
Fault説明	"Throwable is thrown in server application(1220)"

■Fault情報設定

　以下の情報がFault情報に設定できます。

情報種別	内容
Faultコード	エラーの分類です。以下の値が指定できます。 "Server" "Client"
Fault説明	エラーの内容を説明する文字列です(任意)。文字列の長さに制限はありません。
Faultアクタ	エラーの発生した場所(サーバアプリケーションなど)を表すURIです。
Fault詳細	Webサービス固有に定義されるエラー情報項目を指定します。

　Fault情報は、javax.xml.rpc.soap.SOAPFaultExceptionのコンストラクタのパラメタに指定します。

 SOAPFaultException(
   javax.xml.namespace.QName Faultコード,
     String Fault説明,
     String Faultアクタ,
     javax.xml.soap.Detail Fault詳細 )

Faultコード
- ローカル名："Server", 名前空間：""
  RPCクライアントアプリケーションからの要求(リクエスト)は正しいがRPCサーバアプリケーション側の問題で処理が行えない場合に指定します。
- ローカル名："Client", 名前空間：""
  RPCクライアントクライアントアプリケーションの要求(リクエスト)が誤っていて処理が行えない場合に指定します。
Fault説明
エラー内容を説明する文字列を指定します。説明の内容は任意に指定できます。
Faultアクタ
RPCサーバアプリケーションを表す文字列をURI形式で任意に指定します。Webサービス情報で登録するWebサービス識別名を使用することを推奨します。
Fault 詳細
Fault 詳細には、アプリケーション固有のエラーについての情報を任意に指定します。Fault詳細はjavax.xml.soap.Detailオブジェクトとして表され、javax.xml.soap.Detailに含まれるエラー情報はFault詳細項目と呼ばれ、任意の数だけ指定できます。
それぞれのFault 詳細項目は、javax.xml.soap.DetailEntryオブジェクトとして作成してください。
javax.xml.rpc.soap.SOAPFaultExceptionのコンストラクタに、それぞれのFault 詳細項目をjavax.xml.soap.DetailEntryオブジェクトとして設定したjavax.xml.soap.Detailオブジェクトを指定してください。

■Fault詳細項目の設定

　Fault 詳細項目は、javax.xml.soap.DetailEntryオブジェクトとして生成します。javax.xml.soap.DetailEntryオブジェクトはSAAJ-APIのjavax.xml.soap.SOAPElementを継承したインタフェースなのでjavax.xml.soap.SOAPElementオブジェクトに対する操作をそのまま行うことができます。SAAJ-APIについての詳細は“SAAJ-APIによるSOAPメッセージの処理”を参照してください。

　以下にjavax.xml.rpc.soap.SOAPFaultExceptionをthrowするRPCサーバアプリケーションのメソッドのプログラム例を示します。このメソッドでは、inパラメタのStringの配列に特定の値が含まれていたときに、javax.xml.rpc.soap.SOAPFaultExceptionをthrowし、RPCクライアントアプリケーションにFault情報が送信されます。

　javax.xml.rpc.soap.SOAPFaultExceptionをthrowするSOAPサーバアプリケーションのメソッドの例

・java.lang.Stringの配列(foods)に特定文字("carrot")が含まれていたときにjavax.xml.rpc.soap.SOAPFaultExceptionをthrowします。

 public void eat(String[] foods)
 throws java.rmi.RemoteException     // SOAPFaultExceptionはRemoteExceptionから派生
 {
   for( int i=0; i<foods.length; i++ ){
     if ( foods[i].equalsIgnoreCase("carrot") ){
       try{
         SOAPFactory sf= SOAPFactory.newInstance();
         Detail detail= sf.createDetail();
         Name name = se.createName("index","carrot","urn:sample-service-carrot");
         DetailEntry idx= detail.addDetailEntry(name);
         idx.addTextNode(Integer.toString(i));
         throw new SOAPFaultException ("Client", "I don't like carrots!", detail);
       }catch(SOAPException se) {
         se.printStackTrace();
       }
     }
   }
 }

　RPCクライアントアプリケーションでのFault情報の処理方法は、“Fault情報の解析”を参照してください。

目次索引