com.sun.xml.messaging.saaj.soap.ver1_1

Class Fault1_1Impl

java.lang.Object

com.sun.xml.messaging.saaj.soap.impl.ElementImpl

com.sun.xml.messaging.saaj.soap.impl.FaultImpl

com.sun.xml.messaging.saaj.soap.ver1_1.Fault1_1Impl

All Implemented Interfaces:

SOAPBodyElement, SOAPElement, SOAPFault, Element, Node

public class Fault1_1Impl
extends FaultImpl

Field Summary

Fields

Modifier and Type	Field and Description
protected static Logger	log

Fields inherited from class com.sun.xml.messaging.saaj.soap.impl.FaultImpl

detail, faultActorElement, faultCodeElement, faultStringElement

Fields inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

DSIG_NS, elementQName, WSU_NS, XENC_NS, XML_URI, XMLNS_URI

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
Fault1_1Impl(SOAPDocumentImpl ownerDoc)
Fault1_1Impl(SOAPDocumentImpl ownerDoc, Element domElement)
Fault1_1Impl(SOAPDocumentImpl ownerDocument, String prefix)

Method Summary

Modifier and Type	Method and Description
SOAPElement	addChildElement(SOAPElement element) Add a SOAPElement as a child of this SOAPElement instance.
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.
protected void	checkIfStandardFaultCode(String faultCode, String uri)
protected DetailImpl	createDetail()
protected FaultElementImpl	createSOAPFaultElement(Name qname)
protected FaultElementImpl	createSOAPFaultElement(QName qname)
protected FaultElementImpl	createSOAPFaultElement(String localName)
protected void	finallySetFaultCode(String faultcode)
protected QName	getDefaultFaultCode()
protected NameImpl	getDetailName()
protected NameImpl	getFaultActorName()
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.
protected NameImpl	getFaultCodeName()
String	getFaultNode() Returns the optional Node element value for this SOAPFault object.
Iterator<Locale>	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<String>	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.
protected NameImpl	getFaultStringName()
Iterator<QName>	getFaultSubcodes() Gets the Subcodes for this SOAPFault as an iterator over QNames.
protected boolean	isStandardFaultElement(String localName)
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(String faultCode, String prefix, String uri)
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 class com.sun.xml.messaging.saaj.soap.impl.FaultImpl

addDetail, addElement, addElement, addFaultCodeElement, addSOAPFaultElement, convertCodeToQName, convertToSoapElement, findFaultActorElement, findFaultCodeElement, findFaultStringElement, getDetail, getFaultActor, hasDetail, initializeDetail, localeToXmlLang, setElementQName, setFaultCode, setFaultCode, setFaultCode, xmlLangToLocale

Methods inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

addAttribute, addAttribute, addCDATA, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addNode, addText, addTextNode, appendChild, cloneNode, compareDocumentPosition, convertToSoapText, createElement, createElement, createQName, detachNode, doGetNamespacePrefixes, ensureNamespaceIsDeclared, findAndConvertChildElement, findChild, findEncodingStyleAttributeName, getAllAttributes, getAllAttributesAsQNames, getAllAttributesFrom, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getAttributeValueFrom, getBaseURI, getChildElementNodes, getChildElements, getChildElements, getChildElements, getChildElementsFrom, getChildNodes, getDomElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFeature, getFirstChild, getLastChild, getLocalName, getLocalPart, getNamespaceAttr, getNamespaceAttrFrom, getNamespaceContextNodes, getNamespaceContextNodes, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQualifiedName, getSchemaTypeInfo, getSoapDocument, getSOAPNamespace, getTagName, getTextContent, getUserData, getValue, getValueNode, getValueNodeStrict, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importElement, insertBefore, isDefaultNamespace, isEqualNode, isNamespaceQualified, isNamespaceQualified, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, replaceElementWithSOAPElement, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setEncodingStyleNamespace, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setParentElement, setPrefix, setTextContent, setUserData, setValue, tryToFindEncodingStyleAttributeName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, 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, 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

log

protected static final Logger log

Constructor Detail

Fault1_1Impl

public Fault1_1Impl(SOAPDocumentImpl ownerDocument,
                    String prefix)

Fault1_1Impl

public Fault1_1Impl(SOAPDocumentImpl ownerDoc,
                    Element domElement)

Fault1_1Impl

public Fault1_1Impl(SOAPDocumentImpl ownerDoc)

Method Detail

getDetailName

protected NameImpl getDetailName()

Specified by:

getDetailName in class FaultImpl

getFaultCodeName

protected NameImpl getFaultCodeName()

Specified by:

getFaultCodeName in class FaultImpl

getFaultStringName

protected NameImpl getFaultStringName()

Specified by:

getFaultStringName in class FaultImpl

getFaultActorName

protected NameImpl getFaultActorName()

Specified by:

getFaultActorName in class FaultImpl

createDetail

protected DetailImpl createDetail()

Specified by:

createDetail in class FaultImpl

createSOAPFaultElement

protected FaultElementImpl createSOAPFaultElement(String localName)

Specified by:

createSOAPFaultElement in class FaultImpl

checkIfStandardFaultCode

protected void checkIfStandardFaultCode(String faultCode,
                                        String uri)
                                 throws SOAPException

Specified by:

checkIfStandardFaultCode in class FaultImpl

Throws:

SOAPException

finallySetFaultCode

protected void finallySetFaultCode(String faultcode)
                            throws SOAPException

Specified by:

finallySetFaultCode in class FaultImpl

Throws:

SOAPException

getFaultCode

public String getFaultCode()

Description copied from interface: SOAPFault

Gets the fault code for this SOAPFault object.

Returns:

a String with the fault code

See Also:

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

getFaultCodeAsName

public Name getFaultCodeAsName()

Description copied from interface: SOAPFault

Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object. The SOAP 1.1 specification requires the value of the "faultcode" element to be of type QName. This method returns the content of the element as a QName in the form of a SAAJ Name object. This method should be used instead of the getFaultCode method since it allows applications to easily access the namespace name without additional parsing.

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.

Returns:

a QName representing the faultcode

See Also:

SOAPFault.setFaultCode(QName)

setFaultString

public void setFaultString(String faultString)
                    throws SOAPException

Description copied from interface: SOAPFault

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

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

      addFaultReasonText(faultString, Locale.getDefault());
 

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()

getFaultString

public String getFaultString()

Description copied from interface: SOAPFault

Gets the fault string for this SOAPFault object.

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;
 

Returns:

a String giving an explanation of the fault

See Also:

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

getFaultStringLocale

public Locale getFaultStringLocale()

Description copied from interface: SOAPFault

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

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;
 

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,
                           Locale locale)
                    throws SOAPException

Description copied from interface: SOAPFault

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

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

      addFaultReasonText(faultString, locale);
 

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()

isStandardFaultElement

protected boolean isStandardFaultElement(String localName)

Specified by:

isStandardFaultElement in class FaultImpl

appendFaultSubcode

public void appendFaultSubcode(QName subcode)

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.

Parameters:

subcode - a QName containing the Value of 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.

getFaultSubcodes

public Iterator<QName> getFaultSubcodes()

Description copied from interface: SOAPFault

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

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.

getFaultReasonText

public String getFaultReasonText(Locale locale)

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

Parameters:

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

Returns:

the Reason Text associated with locale

See Also:

SOAPFault.getFaultString()

getFaultReasonTexts

public Iterator<String> getFaultReasonTexts()

Description copied from interface: SOAPFault

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

Returns:

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

getFaultReasonLocales

public Iterator<Locale> getFaultReasonLocales()

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.

Returns:

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

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);
 

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.

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.

Returns:

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

setFaultRole

public void setFaultRole(String uri)

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.

Parameters:

uri - - the URI of the Role

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.

Returns:

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

setFaultNode

public void setFaultNode(String uri)

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.

getDefaultFaultCode

protected QName getDefaultFaultCode()

Specified by:

getDefaultFaultCode in class FaultImpl

addChildElement

public SOAPElement addChildElement(SOAPElement element)
                            throws SOAPException

Description copied from interface: SOAPElement

Add a SOAPElement as a child of this SOAPElement instance. The SOAPElement is expected to be created by a SOAPFactory. 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 ElementImpl

Parameters:

element - 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

createSOAPFaultElement

protected FaultElementImpl createSOAPFaultElement(QName qname)

Specified by:

createSOAPFaultElement in class FaultImpl

createSOAPFaultElement

protected FaultElementImpl createSOAPFaultElement(Name qname)

Specified by:

createSOAPFaultElement in class FaultImpl

setFaultCode

public void setFaultCode(String faultCode,
                         String prefix,
                         String uri)
                  throws SOAPException

Overrides:

setFaultCode in class FaultImpl

Throws:

SOAPException

setFaultActor

public void setFaultActor(String faultActor)
                   throws SOAPException

Description copied from interface: SOAPFault

Sets this SOAPFault object with the given fault actor.

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)

Specified by:

setFaultActor in interface SOAPFault

Specified by:

setFaultActor in class FaultImpl

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()