Package org.springframework.ws.soap

Interface SoapFault

All Superinterfaces:

SoapElement

All Known Subinterfaces:

Soap11Fault, Soap12Fault

public interface SoapFault
extends SoapElement

Represent the Fault element in the body of a SOAP message.

A fault consists of a fault code, fault string/reason, and role.

A fault also can have a detail.

Since:

1.0.0

Method Summary

Modifier and Type	Method	Description
SoapFaultDetail	addFaultDetail()	Create a SoapFaultDetail and assign it to this fault.
String	getFaultActorOrRole()	Return the optional fault actor or role.
QName	getFaultCode()	Return the type of fault.
SoapFaultDetail	getFaultDetail()	Return the optional detail element of this fault.
String	getFaultStringOrReason()	Return a human-readable information about the nature of the fault.
void	setFaultActorOrRole(String faultActor)	Set the fault actor or role.

Methods inherited from interface org.springframework.ws.soap.SoapElement

addAttribute, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getName, getSource, removeAttribute

Method Details

getFaultCode

QName getFaultCode()

Return the type of fault.

getFaultStringOrReason

String getFaultStringOrReason()

Return a human-readable information about the nature of the fault. For SOAP 1.1, this returns the fault string. For SOAP 1.2, this returns the fault reason for the default locale.

getFaultActorOrRole

String getFaultActorOrRole()

Return the optional fault actor or role. For SOAP 1.1, this returns the URI of the SOAP node that generated the fault. For SOAP 1.2, this returns the URI that identifies the role in which the node was operating at the point the fault occurred.

setFaultActorOrRole

void setFaultActorOrRole(String faultActor)

Set the fault actor or role. For SOAP 1.1, this sets the actor. For SOAP 1.2, this sets the role.

getFaultDetail

SoapFaultDetail getFaultDetail()

Return the optional detail element of this fault.

Returns:

a fault detail

addFaultDetail

SoapFaultDetail addFaultDetail()

Create a SoapFaultDetail and assign it to this fault.

Returns:

the created detail