Definire un WebFault in un Web Service

Per usare il meccanismo dei WebFault nei Web Service bisogna procedere in questo modo:

1. Definire un bean con le proprietà che caratterizzino e definiscano al meglio i dettagli dell'eccezione;
2. Creare una eccezione annotata con @WebFault avente come proprietà la classe definita al punto 1 e una proprietà definita getFaultInfo() che torni direttamente la classe.

Vediamo il codice.

Bean di dettaglio

package it.exception;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlElement;
import javax.xml.bind.annotation.XmlType;
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "Errore", propOrder = {
    "message","data"
})
public class ErroreLogico  {

 @XmlElement(name="timestamp")
 private String data;
 
 public String getData() {
  return data;
 }

 public void setData(String data) {
  this.data = data;
 }

 private String message;

 public String getMessage() {
  return message;
 }

 public void setMessage(String message) {
  this.message = message;
 }
 

}

WebFault 

package it.exception;
import javax.xml.ws.WebFault;
@WebFault(name="FaultProva",targetNamespace="http://www.esempiws.it")
public class FaultWs extends Exception {
 private ErroreLogico error;
 private static final long serialVersionUID = 1L;
 public FaultWs(String message,ErroreLogico bean){
  super(message);
  this.error=bean;
 }
 public FaultWs(String message,ErroreLogico bean,Throwable cause){
  super(message);
  this.error=bean;
 }
 public ErroreLogico getFaultInfo(){
  return this.error;
 }

}

WebService 

package it.wstest;
import java.text.SimpleDateFormat;
import java.util.Date;
import it.exception.ErroreLogico;
import it.exception.FaultWs;
import javax.jws.WebService;
import javax.jws.soap.SOAPBinding;
import javax.jws.soap.SOAPBinding.ParameterStyle;
import javax.jws.soap.SOAPBinding.Style;
import javax.jws.soap.SOAPBinding.Use;
@WebService(name="MyTest")
@SOAPBinding( style=Style.DOCUMENT,parameterStyle=ParameterStyle.WRAPPED,use=Use.LITERAL)
public class WsProva {
public double dividi(String numeratore,String denominatore) throws FaultWs{
 try
 {
  double num=Double.parseDouble(numeratore);
  double den=Double.parseDouble(denominatore);
  double res=num/den;
  return res;
 }
 catch(Throwable t){
  ErroreLogico e=new ErroreLogico();
  e.setMessage(t.getMessage());
  SimpleDateFormat sdf=new SimpleDateFormat("dd/MM/yyyy hh:mm:ss");
  e.setData(sdf.format(new Date()));
  throw new FaultWs("Errore nella divisione.", e);
 }
}
}

A livello di WSDL troveremo la seguente deinizione:

<types>
<xsd:schema>
<xsd:import namespace="http://www.esempiws.it" schemaLocation="http://localhost:9999/Divisione?xsd=1"/>
</xsd:schema>
<xsd:schema>
<xsd:import namespace="http://wstest.it/" schemaLocation="http://localhost:9999/Divisione?xsd=2"/>
</xsd:schema>
</types>
<message name="dividi">
<part name="parameters" element="tns:dividi"/>
</message>
<message name="dividiResponse">
<part name="parameters" element="tns:dividiResponse"/>
</message>
<message name="FaultWs">
<part xmlns:ns1="http://www.esempiws.it" name="fault" element="ns1:FaultProva"/>
</message>
<portType name="MyTest">
<operation name="dividi">
<input wsam:Action="http://wstest.it/MyTest/dividiRequest" message="tns:dividi"/>
<output wsam:Action="http://wstest.it/MyTest/dividiResponse" message="tns:dividiResponse"/>
<fault message="tns:FaultWs" name="FaultWs" wsam:Action="http://wstest.it/MyTest/dividi/Fault/FaultWs"/>
</operation>
</portType>
<binding name="MyTestPortBinding" type="tns:MyTest">
<soap:binding transport="http://schemas.xmlsoap.org/soap/http" style="document"/>
<operation name="dividi">
<soap:operation soapAction=""/>
<input>
<soap:body use="literal"/>
</input>
<output>
<soap:body use="literal"/>
</output>
<fault name="FaultWs">
<soap:fault name="FaultWs" use="literal"/>
</fault>
</operation>
</binding>
<service name="WsProvaService">
<port name="MyTestPort" binding="tns:MyTestPortBinding">
<soap:address location="http://localhost:9999/Divisione"/>
</port>
</service>
</definitions>

Testando il Ws con soap UI abbiamo la seguente situazione.
 Chiamata:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wst="http://wstest.it/">
   <soapenv:Header/>
   <soapenv:Body>
      <wst:dividi>
         <!--Optional:-->
         <arg0>qwe</arg0>
         <!--Optional:-->
         <arg1>12</arg1>
      </wst:dividi>
   </soapenv:Body>
</soapenv:Envelope>

Risposta:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <S:Fault xmlns:ns4="http://www.w3.org/2003/05/soap-envelope">
         <faultcode>S:Server</faultcode>
         <faultstring>Errore nella divisione.</faultstring>
         <detail>
            <ns3:FaultProva xmlns:ns3="http://www.esempiws.it" xmlns:ns2="http://wstest.it/">
               <message>For input string: "qwe"</message>
               <timestamp>10/02/2013 11:36:13</timestamp>
            </ns3:FaultProva>
         </detail>
      </S:Fault>
   </S:Body>
</S:Envelope>