Java Doc for SOAPFault.java in  » 6.0-JDK-Modules » saaj » javax » xml » soap » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Depending on the protocol specified while creating the MessageFactory instance, a SOAPFault has sub-elements as defined in the SOAP 1.1/SOAP 1.2 specification.

It is illegal to add a detail when the fault already contains a detail.

A Detail object carries application-specific error information, the scope of the error information is restricted to faults in the SOAPBodyElement objects if this is a SOAP 1.1 Fault.

Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification.

Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification.

It is illegal to add a detail when the fault already contains a detail. Therefore, this method should be called only after the existing detail has been removed. the new Detail object
exception:
  SOAPException - if thisSOAPFault object already contains avalid Detail object

Code sample:

 SOAPFault fault = ...;
 fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
 

A Detail object carries application-specific error information, the scope of the error information is restricted to faults in the SOAPBodyElement objects if this is a SOAP 1.1 Fault. a Detail object with application-specificerror information if present, null otherwise

If this SOAPFault supports SOAP 1.2 then this call is equivalent to SOAPFault.getFaultRole() a String giving the actor in the message paththat caused this SOAPFault object
See Also:   SOAPFault.setFaultActor

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

 String reason = null;
 try {
 reason = (String) getFaultReasonTexts().next();
 } catch (SOAPException e) {}
 return reason;
 

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

 Locale locale = null;
 try {
 locale = (Locale) getFaultReasonLocales().next();
 } catch (SOAPException e) {}
 return locale;
 

The fault actor is the recipient in the message path who caused the fault to happen.

If this SOAPFault supports SOAP 1.2 then this call is equivalent to SOAPFault.setFaultRole(String)
Parameters:
  faultActor - a String identifying the actor thatcaused this SOAPFault object
See Also:   SOAPFault.getFaultActor
exception:
  SOAPException - if there was an error in adding thefaultActor to the underlying XML tree.

Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification. A fault code is mandatory and must be of type Name. This method provides a convenient way to set a fault code. For example,

 SOAPEnvelope se = ...;
 // Create a qualified name in the SOAP namespace with a localName
 // of "Client". Note that prefix parameter is optional and is null
 // here which causes the implementation to use an appropriate prefix.
 Name qname = se.createName("Client", null,
 SOAPConstants.URI_NS_SOAP_ENVELOPE);
 SOAPFault fault = ...;
 fault.setFaultCode(qname);
 

Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification. This element is mandatory in SOAP 1.1. Because the fault code is required to be a QName it is preferable to use the SOAPFault.setFaultCode(Name) form of this method.
Parameters:
  faultCode - a String giving the fault code to be set.It must be of the form "prefix:localName" where the prefix hasbeen defined in a namespace declaration.
See Also:   SOAPFault.setFaultCode(Name)
See Also:   SOAPFault.getFaultCode
See Also:   SOAPElement.addNamespaceDeclaration
exception:
  SOAPException - if there was an error in adding thefaultCode to the underlying XML tree.

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

 addFaultReasonText(faultString, Locale.getDefault());
 

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

 addFaultReasonText(faultString, locale);