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)
void	appendFaultSubcode(QName subcode)
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()
String	getFaultNode()
Iterator	getFaultReasonLocales()
String	getFaultReasonText(Locale locale)
Iterator	getFaultReasonTexts()
String	getFaultRole()
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()
boolean	hasDetail()
void	removeAllFaultSubcodes()
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)
void	setFaultCode(String faultCode) Sets this SOAPFault object with the give fault code.
void	setFaultNode(String uri)
void	setFaultRole(String uri)
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

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

getFaultCodeAsQName

public QName getFaultCodeAsQName()

Specified by:

getFaultCodeAsQName in interface SOAPFault

setFaultCode

public void setFaultCode(String faultCode)
                  throws SOAPException

Sets this SOAPFault object with the give fault code.

Specified by:

setFaultCode in interface SOAPFault

Throws:

SOAPException

setFaultCode

public void setFaultCode(Name faultCode)
                  throws SOAPException

Sets this SOAPFault object with the given fault code.

Specified by:

setFaultCode in interface SOAPFault

Throws:

SOAPException

setFaultCode

public void setFaultCode(QName faultCode)
                  throws SOAPException

Specified by:

setFaultCode in interface SOAPFault

Throws:

SOAPException

getFaultSubcodes

public Iterator getFaultSubcodes()

Specified by:

getFaultSubcodes in interface SOAPFault

appendFaultSubcode

public void appendFaultSubcode(QName subcode)
                        throws SOAPException

Specified by:

appendFaultSubcode in interface SOAPFault

Throws:

SOAPException

removeAllFaultSubcodes

public void removeAllFaultSubcodes()

Specified by:

removeAllFaultSubcodes in interface SOAPFault

getFaultString

public String getFaultString()

Gets the fault string for this SOAPFault object.

Specified by:

getFaultString in interface SOAPFault

getFaultStringLocale

public Locale getFaultStringLocale()

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

Specified by:

getFaultStringLocale in interface SOAPFault

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

Throws:

SOAPException

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

Throws:

SOAPException

getFaultReasonTexts

public Iterator getFaultReasonTexts()
                             throws SOAPException

Specified by:

getFaultReasonTexts in interface SOAPFault

Throws:

SOAPException

getFaultReasonLocales

public Iterator getFaultReasonLocales()
                               throws SOAPException

Specified by:

getFaultReasonLocales in interface SOAPFault

Throws:

SOAPException

getFaultReasonText

public String getFaultReasonText(Locale locale)
                          throws SOAPException

Specified by:

getFaultReasonText in interface SOAPFault

Throws:

SOAPException

addFaultReasonText

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

Specified by:

addFaultReasonText in interface SOAPFault

Throws:

SOAPException

getFaultActor

public String getFaultActor()

Gets the fault actor for this SOAPFault object.

Specified by:

getFaultActor in interface SOAPFault

setFaultActor

public void setFaultActor(String faultActor)
                   throws SOAPException

Sets this SOAPFault object with the given fault actor.

Specified by:

setFaultActor in interface SOAPFault

Throws:

SOAPException

getFaultRole

public String getFaultRole()

Specified by:

getFaultRole in interface SOAPFault

setFaultRole

public void setFaultRole(String uri)
                  throws SOAPException

Specified by:

setFaultRole in interface SOAPFault

Throws:

SOAPException

getFaultNode

public String getFaultNode()

Specified by:

getFaultNode in interface SOAPFault

setFaultNode

public void setFaultNode(String uri)
                  throws SOAPException

Specified by:

setFaultNode in interface SOAPFault

Throws:

SOAPException

hasDetail

public boolean hasDetail()

Specified by:

hasDetail in interface SOAPFault

getDetail

public Detail getDetail()

Returns the optional detail element for this SOAPFault object.

Specified by:

getDetail in interface SOAPFault

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

Throws:

SOAPException

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