javax.xml.soap

Interface SOAPFault

All Superinterfaces:

Element, Node, SOAPBodyElement, SOAPElement

public interface SOAPFault
extends SOAPBodyElement

An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage object or to problems that are not related to the content in the message itself. Problems not related to the message itself are generally errors in processing, such as the inability to communicate with an upstream server.

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.

Field Summary

Fields inherited from interface org.w3c.dom.Node

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Method Summary

Methods

Modifier and Type	Method and Description
Detail	addDetail() Creates an optional Detail object and sets it as the Detail object for this SOAPFault object.
void	addFaultReasonText(String text, Locale locale) Appends or replaces a Reason Text item containing the specified text message and an xml:lang derived from locale.
void	appendFaultSubcode(QName subcode) Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault.
Detail	getDetail() Returns the optional detail element for this SOAPFault object.
String	getFaultActor() Gets the fault actor for this SOAPFault object.
String	getFaultCode() Gets the fault code for this SOAPFault object.
Name	getFaultCodeAsName() Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object.
QName	getFaultCodeAsQName() Gets the fault code for this SOAPFault object as a QName object.
String	getFaultNode() Returns the optional Node element value for this SOAPFault object.
Iterator	getFaultReasonLocales() Returns an Iterator over a distinct sequence of Locales for which there are associated Reason Text items.
String	getFaultReasonText(Locale locale) Returns the Reason Text associated with the given Locale.
Iterator	getFaultReasonTexts() Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.
String	getFaultRole() Returns the optional Role element value for this SOAPFault object.
String	getFaultString() Gets the fault string for this SOAPFault object.
Locale	getFaultStringLocale() Gets the locale of the fault string for this SOAPFault object.
Iterator	getFaultSubcodes() Gets the Subcodes for this SOAPFault as an iterator over QNames.
boolean	hasDetail() Returns true if this SOAPFault has a Detail subelement and false otherwise.
void	removeAllFaultSubcodes() Removes any Subcodes that may be contained by this SOAPFault.
void	setFaultActor(String faultActor) Sets this SOAPFault object with the given fault actor.
void	setFaultCode(Name faultCodeQName) Sets this SOAPFault object with the given fault code.
void	setFaultCode(QName faultCodeQName) Sets this SOAPFault object with the given fault code.
void	setFaultCode(String faultCode) Sets this SOAPFault object with the give fault code.
void	setFaultNode(String uri) Creates or replaces any existing Node element value for this SOAPFault object.
void	setFaultRole(String uri) Creates or replaces any existing Role element value for this SOAPFault object.
void	setFaultString(String faultString) Sets the fault string for this SOAPFault object to the given string.
void	setFaultString(String faultString, Locale locale) Sets the fault string for this SOAPFault object to the given string and localized to the given locale.

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode,