org.jboss.ws.core.soap

Class SOAPFaultImpl

java.lang.Object

org.jboss.ws.core.soap.NodeImpl

org.jboss.ws.core.soap.SOAPElementImpl

org.jboss.ws.core.soap.SOAPContentElement

org.jboss.ws.core.soap.SOAPBodyElementDoc

org.jboss.ws.core.soap.SOAPFaultImpl

All Implemented Interfaces:

SOAPBodyElement, SOAPElement, SOAPFault, SOAPContentAccess, Element, Node

public class SOAPFaultImpl
extends SOAPBodyElementDoc
implements SOAPFault

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. The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault object and for setting the fault code, the fault actor, and a string describing the fault. A fault code is one of the codes defined in the SOAP 1.1 specification that describe the fault. An actor is an intermediate recipient to whom a message was routed. The message path may include one or more actors, or, if no actors are specified, the message goes only to the default actor, which is the final intended recipient.

Author:

Thomas.Diesler@jboss.org, Jason T. Greene

Field Summary

Fields

Modifier and Type	Field and Description
static Set<QName>	soap11FaultCodes
static Set<QName>	soap12FaultCodes

Fields inherited from class org.jboss.ws.core.soap.SOAPContentElement

GENERIC_PARAM_NAME, GENERIC_RETURN_NAME, soapContent

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

domNode, soapParent

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

Constructor Summary

Constructors

Constructor and Description
SOAPFaultImpl()
SOAPFaultImpl(SOAPElementImpl element)
SOAPFaultImpl(String prefix, String namespace)

Method Summary

Methods

Modifier and Type	Method and Description
SOAPElement	addChildElement(SOAPElement child) Add a SOAPElement as a child of this SOAPElement instance.
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 faultCode) Sets this SOAPFault object with the given fault code.
void	setFaultCode(QName faultCode) 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.
void	writeElement(Writer writer) The default implementation uses a DOMWriter.

Methods inherited from class org.jboss.ws.core.soap.SOAPBodyElementDoc

transitionTo

Methods inherited from class org.jboss.ws.core.soap.SOAPContentElement

accept, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, cloneNode, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getChildElements, getChildElements, getChildNodes, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getJavaType, getLastChild, getNamespacePrefixes, getNamespaceURI, getNextSibling, getObjectValue, getParamMetaData, getPreviousSibling, getSchemaTypeInfo, getTagName, getValue, getVisibleNamespacePrefixes, getXMLFragment, getXmlType, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setObjectValue, setParamMetaData, setValue, setXMLFragment

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl

addAttribute, addChildElement, createQName, getAllAttributesAsQNames, getAttributeValue, getChildElements, getElementQName, getFirstChildElementByLocalName, getSOAPEnvelope, removeAttribute, setElementQName, setElementQNameInternal, setEncodingStyle, setPrefix, writeElementContent

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

compareDocumentPosition, detachNode, getBaseURI, getFeature, getLocalName, getNamespaceURI, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getTextContent, getUserData, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, setNodeValue, setParentElement, setTextContent, setUserData, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addAttribute, 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, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Field Detail

soap11FaultCodes

public static final Set<QName> soap11FaultCodes

soap12FaultCodes

public static final Set<QName> soap12FaultCodes

Constructor Detail

SOAPFaultImpl

public SOAPFaultImpl()
              throws SOAPException

Throws:

SOAPException

SOAPFaultImpl

public SOAPFaultImpl(String prefix,
             String namespace)
              throws SOAPException

Throws:

SOAPException

SOAPFaultImpl

public SOAPFaultImpl(SOAPElementImpl element)

Method Detail

getFaultCode

public String getFaultCode()

Gets the fault code for this SOAPFault object.

Specified by:

getFaultCode in interface SOAPFault

Returns:

a String with the fault code

See Also:

SOAPFault.getFaultCodeAsName(), SOAPFault.setFaultCode(javax.xml.soap.Name)

getFaultCodeAsName

public Name getFaultCodeAsName()

Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object.

Specified by:

getFaultCodeAsName in interface SOAPFault

Returns:

a Name representing the faultcode

See Also:

SOAPFault.setFaultCode(Name)

getFaultCodeAsQName

public QName getFaultCodeAsQName()

Description copied from interface: SOAPFault

Gets the fault code for this SOAPFault object as a QName object.

Specified by:

getFaultCodeAsQName in interface SOAPFault

Returns:

a QName representing the faultcode

See Also:

SOAPFault.setFaultCode(QName)

setFaultCode

public void setFaultCode(String faultCode)
                  throws SOAPException

Sets this SOAPFault object with the give fault code.

Specified by:

setFaultCode in interface SOAPFault

Parameters:

faultCode - a String giving the fault code to be set. It must be of the form "prefix:localName" where the prefix has been defined in a namespace declaration.

Throws:

SOAPException - if there was an error in adding the faultCode to the underlying XML tree.

See Also:

SOAPFault.setFaultCode(Name), SOAPFault.getFaultCode(), SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)

setFaultCode

public void setFaultCode(Name faultCode)
                  throws SOAPException

Sets this SOAPFault object with the given fault code.

Specified by:

setFaultCode in interface SOAPFault

Parameters:

faultCode - a Name object giving the fault code to be set. It must be namespace qualified.

Throws:

SOAPException - if there was an error in adding the faultcode element to the underlying XML tree.

See Also:

SOAPFault.getFaultCodeAsName()

setFaultCode

public void setFaultCode(QName faultCode)
                  throws SOAPException

Description copied from interface: SOAPFault

Sets this SOAPFault object with the given fault code. It is preferable to use this method over SOAPFault.setFaultCode(Name).

Specified by:

setFaultCode in interface SOAPFault

Parameters:

faultCode - a QName object giving the fault code to be set. It must be namespace qualified.

Throws:

SOAPException - if there was an error in adding the faultcode element to the underlying XML tree.

See Also:

SOAPFault.getFaultCodeAsQName(), SOAPFault.setFaultCode(Name), SOAPFault.getFaultCodeAsQName()

getFaultSubcodes

public Iterator getFaultSubcodes()

Description copied from interface: SOAPFault

Gets the Subcodes for this SOAPFault as an iterator over QNames.

Specified by:

getFaultSubcodes in interface SOAPFault

Returns:

an Iterator that accesses a sequence of QNames. This Iterator should not support the optional remove method. The order in which the Subcodes are returned reflects the hierarchy of Subcodes present in the fault from top to bottom.

appendFaultSubcode

public void appendFaultSubcode(QName subcode)
                        throws SOAPException

Description copied from interface: SOAPFault

Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault. Subcodes, which were introduced in SOAP 1.2, are represented by a recursive sequence of subelements rooted in the mandatory Code subelement of a SOAP Fault.

Specified by:

appendFaultSubcode in interface SOAPFault

Parameters:

subcode - a QName containing the Value of the Subcode.

Throws:

SOAPException - if there was an error in setting the Subcode

removeAllFaultSubcodes

public void removeAllFaultSubcodes()

Description copied from interface: SOAPFault

Removes any Subcodes that may be contained by this SOAPFault. Subsequent calls to getFaultSubcodes will return an empty iterator until a call to appendFaultSubcode is made.

Specified by:

removeAllFaultSubcodes in interface SOAPFault

getFaultString

public String getFaultString()

Gets the fault string for this SOAPFault object.

Specified by:

getFaultString in interface SOAPFault

Returns:

a String giving an explanation of the fault

See Also:

SOAPFault.setFaultString(String), SOAPFault.setFaultString(String, Locale)

getFaultStringLocale

public Locale getFaultStringLocale()

Gets the locale of the fault string for this SOAPFault object.

Specified by:

getFaultStringLocale in interface SOAPFault

Returns:

a Locale object indicating the native language of the fault string or null if no locale was specified

See Also:

SOAPFault.setFaultString(String, Locale)

setFaultString

public void setFaultString(String faultString)
                    throws SOAPException

Sets the fault string for this SOAPFault object to the given string.

Specified by:

setFaultString in interface SOAPFault

Parameters:

faultString - a String giving an explanation of the fault

Throws:

SOAPException - if there was an error in adding the faultString to the underlying XML tree.

See Also:

SOAPFault.getFaultString()

setFaultString

public void setFaultString(String faultString,
                  Locale locale)
                    throws SOAPException

Sets the fault string for this SOAPFault object to the given string and localized to the given locale.

Specified by:

setFaultString in interface SOAPFault

Parameters:

faultString - a String giving an explanation of the fault

locale - a Locale object indicating the native language of the faultString

Throws:

SOAPException - if there was an error in adding the faultString to the underlying XML tree.

See Also:

SOAPFault.getFaultString()

getFaultReasonTexts

public Iterator getFaultReasonTexts()
                             throws SOAPException

Description copied from interface: SOAPFault

Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.

Specified by:

getFaultReasonTexts in interface SOAPFault

Returns:

an Iterator over env:Fault/env:Reason/env:Text items.

Throws:

SOAPException - if there was an error in retrieving the fault Reason texts.

getFaultReasonLocales

public Iterator getFaultReasonLocales()
                               throws SOAPException

Description copied from interface: SOAPFault

Returns an Iterator over a distinct sequence of Locales for which there are associated Reason Text items. Any of these Locales can be used in a call to getFaultReasonText in order to obtain a localized version of the Reason Text string.

Specified by:

getFaultReasonLocales in interface SOAPFault

Returns:

an Iterator over a sequence of Locale objects for which there are associated Reason Text items.

Throws:

SOAPException - if there was an error in retrieving the fault Reason locales.

getFaultReasonText

public String getFaultReasonText(Locale locale)
                          throws SOAPException

Description copied from interface: SOAPFault

Returns the Reason Text associated with the given Locale. If more than one such Reason Text exists the first matching Text is returned

Specified by:

getFaultReasonText in interface SOAPFault

Parameters:

locale - -- the Locale for which a localized Reason Text is desired

Returns:

the Reason Text associated with locale

Throws:

SOAPException - if there was an error in retrieving the fault Reason text for the specified locale .

See Also:

SOAPFault.getFaultString()

addFaultReasonText

public void addFaultReasonText(String text,
                      Locale locale)
                        throws SOAPException

Description copied from interface: SOAPFault

Appends or replaces a Reason Text item containing the specified text message and an xml:lang derived from locale. If a Reason Text item with this xml:lang already exists its text value will be replaced with text. The locale parameter should not be null

Code sample:

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

Specified by:

addFaultReasonText in interface SOAPFault

Parameters:

text - -- reason message string

locale - -- Locale object representing the locale of the message

Throws:

SOAPException - if there was an error in adding the Reason text or the locale passed was null.

getFaultActor

public String getFaultActor()

Gets the fault actor for this SOAPFault object.

Specified by:

getFaultActor in interface SOAPFault

Returns:

a String giving the actor in the message path that caused this SOAPFault object

See Also:

SOAPFault.setFaultActor(java.lang.String)

setFaultActor

public void setFaultActor(String faultActor)
                   throws SOAPException

Sets this SOAPFault object with the given fault actor.

Specified by:

setFaultActor in interface SOAPFault

Parameters:

faultActor - a String identifying the actor that caused this SOAPFault object

Throws:

SOAPException - if there was an error in adding the faultActor to the underlying XML tree.

See Also:

SOAPFault.getFaultActor()

getFaultRole

public String getFaultRole()

Description copied from interface: SOAPFault

Returns the optional Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2.

Specified by:

getFaultRole in interface SOAPFault

Returns:

Content of the env:Fault/env:Role element as a String or null if none

setFaultRole

public void setFaultRole(String uri)
                  throws SOAPException

Description copied from interface: SOAPFault

Creates or replaces any existing Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2.

Specified by:

setFaultRole in interface SOAPFault

Parameters:

uri - - the URI of the Role

Throws:

SOAPException - if there was an error in setting the Role for this SOAPFault object.

getFaultNode

public String getFaultNode()

Description copied from interface: SOAPFault

Returns the optional Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.

Specified by:

getFaultNode in interface SOAPFault

Returns:

Content of the env:Fault/env:Node element as a String or null if none

setFaultNode

public void setFaultNode(String uri)
                  throws SOAPException

Description copied from interface: SOAPFault

Creates or replaces any existing Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.

Specified by:

setFaultNode in interface SOAPFault

Throws:

SOAPException - if there was an error in setting the Node for this SOAPFault object.

hasDetail

public boolean hasDetail()

Description copied from interface: SOAPFault

Returns true if this SOAPFault has a Detail subelement and false otherwise. Equivalent to (getDetail()!=null).

Specified by:

hasDetail in interface SOAPFault

Returns:

true if this SOAPFault has a Detail subelement and false otherwise.

getDetail

public Detail getDetail()

Returns the optional detail element for this SOAPFault object.

Specified by:

getDetail in interface SOAPFault

Returns:

a Detail object with application-specific error information if present, null otherwise

addDetail

public Detail addDetail()
                 throws SOAPException

Creates an optional Detail object and sets it as the Detail object for this SOAPFault object.

Specified by:

addDetail in interface SOAPFault

Returns:

the new Detail object

Throws:

SOAPException - if this SOAPFault object already contains a valid Detail object

addChildElement

public SOAPElement addChildElement(SOAPElement child)
                            throws SOAPException

Description copied from class: SOAPElementImpl

Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPElementFactory.

Callers should not rely on the element instance being added as is into the XML tree. Implementations could end up copying the content of the SOAPElement passed into an instance of a different SOAPElement implementation. For instance if addChildElement() is called on a SOAPHeader, element will be copied into an instance of a SOAPHeaderElement.

The fragment rooted in element is either added as a whole or not at all, if there was an error.

The fragment rooted in element cannot contain elements named "Envelope", "Header" or "Body" and in the SOAP namespace. Any namespace prefixes present in the fragment should be fully resolved using appropriate namespace declarations within the fragment itself.

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPContentElement

Parameters:

child - the SOAPElement to be added as a new child

Returns:

an instance representing the new SOAP element that was actually added to the tree.

Throws:

SOAPException - if there was an error in adding this element as a child

writeElement

public void writeElement(Writer writer)

Description copied from class: SOAPElementImpl

The default implementation uses a DOMWriter. SOAPContentElements overwrite this to optimize DOM callbacks.

Overrides:

writeElement in class SOAPContentElement