org.apache.axis2.saaj
Class SOAPFaultImpl

java.lang.Object
  extended by org.apache.axiom.om.impl.dom.NodeImpl
      extended by org.apache.axis2.saaj.NodeImplEx
          extended by org.apache.axis2.saaj.SOAPElementImpl
              extended by org.apache.axis2.saaj.SOAPBodyElementImpl
                  extended by org.apache.axis2.saaj.SOAPFaultImpl
All Implemented Interfaces:
java.lang.Cloneable, org.apache.axiom.om.impl.OMNodeEx, org.apache.axiom.om.OMNode, org.w3c.dom.Node, org.w3c.dom.NodeList

public class SOAPFaultImpl
extends SOAPBodyElementImpl


Field Summary
protected  org.apache.axiom.soap.SOAPFault fault
           
 
Fields inherited from class org.apache.axis2.saaj.SOAPElementImpl
element
 
Fields inherited from class org.apache.axis2.saaj.NodeImplEx
parentElement
 
Fields inherited from class org.apache.axiom.om.impl.dom.NodeImpl
builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED
 
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
 
Fields inherited from interface org.apache.axiom.om.OMNode
DTD_NODE, PI_NODE, SPACE_NODE
 
Constructor Summary
SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)
           
 
Method Summary
 Detail addDetail()
           
 void addFaultReasonText(java.lang.String text, java.util.Locale locale)
          Appends or replaces a Reason Text item containing the specified text message and an xml:lang derived from locale.
 void appendFaultSubcode(javax.xml.namespace.QName subcode)
          Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault.
 java.util.Iterator getChildElements()
          Returns an iterator over all the immediate content of this element.
 java.util.Iterator getChildElements(Name name)
           
 Detail getDetail()
           
 java.lang.String getFaultActor()
           
 java.lang.String getFaultCode()
          Gets the fault code for this SOAPFault object.
 Name getFaultCodeAsName()
           
 javax.xml.namespace.QName getFaultCodeAsQName()
          Gets the fault code for this SOAPFault object as a QName object.
 java.lang.String getFaultNode()
          Returns the optional Node element value for this SOAPFault object.
 java.util.Iterator getFaultReasonLocales()
          Returns an Iterator over a distinct sequence of Locales for which there are associated Reason Text items.
 java.lang.String getFaultReasonText(java.util.Locale locale)
          Returns the Reason Text associated with the given Locale.
 java.util.Iterator getFaultReasonTexts()
          Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.
 java.lang.String getFaultRole()
          Returns the optional Role element value for this SOAPFault object.
 java.lang.String getFaultString()
           
 java.util.Locale getFaultStringLocale()
          Gets the locale of the fault string for this SOAPFault object.
 java.util.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(java.lang.String faultActor)
          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.
 void setFaultCode(javax.xml.namespace.QName qname)
          Sets this SOAPFault object with the given fault code.
 void setFaultCode(java.lang.String faultCode)
          Sets this SOAPFault object with the given fault code.
 void setFaultNode(java.lang.String s)
          Creates or replaces any existing Node element value for this SOAPFault object.
 void setFaultRole(java.lang.String uri)
          Creates or replaces any existing Role element value for this SOAPFault object.
 void setFaultString(java.lang.String faultString)
          Sets the fault string for this SOAPFault object to the given string.
 void setFaultString(java.lang.String faultString, java.util.Locale locale)
          Sets the fault string for this SOAPFault object to the given string.
 
Methods inherited from class org.apache.axis2.saaj.SOAPBodyElementImpl
addAttribute, addChildElement, createQName, getAllAttributesAsQNames, getAttributeValue, getElementQName, removeAttribute, setElementQName, setParentElement
 
Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl
addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, appendElement, appendText, copyContents, detach, detachNode, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getChildNodes, getElement, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setParent, setValue, toString
 
Methods inherited from class org.apache.axis2.saaj.NodeImplEx
getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType
 
Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl
build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNodeValue, getOMFactory, getPreviousOMSibling, getTextContent, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

fault

protected org.apache.axiom.soap.SOAPFault fault
Constructor Detail

SOAPFaultImpl

public SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)
Parameters:
fault -
Method Detail

setFaultCode

public void setFaultCode(java.lang.String faultCode)
                  throws SOAPException
Sets this SOAPFault object with the given fault code.

Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification. This element is mandatory in SOAP 1.1. Because the fault code is required to be a QName it is preferable to use the setFaultCode(Name)form of this method.

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:
setFaultCode(Name), getFaultCode(),SOAPElement.addNamespaceDeclaration(String, String)

getFaultCode

public java.lang.String getFaultCode()
Gets the fault code for this SOAPFault object.

Returns:
a String with the fault code
See Also:
setFaultCode(java.lang.String)

setFaultActor

public void setFaultActor(java.lang.String faultActor)
                   throws SOAPException
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 setFaultRole(String)

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.

getFaultActor

public java.lang.String getFaultActor()

setFaultString

public void setFaultString(java.lang.String faultString)
                    throws SOAPException
Sets the fault string for this SOAPFault object to the given string.

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

getFaultString

public java.lang.String getFaultString()

getDetail

public Detail getDetail()

addDetail

public Detail addDetail()
                 throws SOAPException
Throws:
SOAPException

getFaultCodeAsName

public Name getFaultCodeAsName()

setFaultString

public void setFaultString(java.lang.String faultString,
                           java.util.Locale locale)
                    throws SOAPException
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:
getFaultString()

getFaultStringLocale

public java.util.Locale getFaultStringLocale()
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
Since:
SAAJ 1.2
See Also:
setFaultString(String, Locale)

addFaultReasonText

public void addFaultReasonText(java.lang.String text,
                               java.util.Locale locale)
                        throws SOAPException
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. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Reason.

appendFaultSubcode

public void appendFaultSubcode(javax.xml.namespace.QName subcode)
                        throws SOAPException
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.
Throws:
SOAPException - - if there was an error in setting the Subcode java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Subcode.

getFaultCodeAsQName

public javax.xml.namespace.QName getFaultCodeAsQName()
Gets the fault code for this SOAPFault object as a QName object.


getFaultNode

public java.lang.String getFaultNode()
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
Throws:
java.lang.UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Fault Node.

getFaultReasonLocales

public java.util.Iterator getFaultReasonLocales()
                                         throws SOAPException
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.
Throws:
SOAPException - - if there was an error in retrieving the fault Reason locales. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Reason.
Since:
SAAJ 1.3

getFaultReasonText

public java.lang.String getFaultReasonText(java.util.Locale locale)
                                    throws SOAPException
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
Throws:
SOAPException - - if there was an error in retrieving the fault Reason text for the specified locale. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Reason.
Since:
SAAJ 1.3

getFaultReasonTexts

public java.util.Iterator getFaultReasonTexts()
                                       throws SOAPException
Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.

Throws:
SOAPException - if there is an error in retrieving texts for Reason objects java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Reason.

getFaultRole

public java.lang.String getFaultRole()
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
Throws:
java.lang.UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Fault Role.
Since:
SAAJ 1.3

getFaultSubcodes

public java.util.Iterator getFaultSubcodes()
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.
Throws:
java.lang.UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Subcode.

hasDetail

public boolean hasDetail()
Returns true if this SOAPFault has a Detail subelement and false otherwise.


removeAllFaultSubcodes

public void removeAllFaultSubcodes()
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.

Throws:
java.lang.UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Subcode.

setFaultCode

public void setFaultCode(javax.xml.namespace.QName qname)
                  throws SOAPException
Sets this SOAPFault object with the given fault code. It is preferable to use this method over setFaultCode(Name)

Parameters:
faultCodeQName - - 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.
Since:
SAAJ 1.3
See Also:
getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()

setFaultNode

public void setFaultNode(java.lang.String s)
                  throws SOAPException
Creates or replaces any existing Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.

Throws:
SOAPException - - if there was an error in setting the Node for this SOAPFault object. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Node.
Since:
SAAJ 1.3

setFaultRole

public void setFaultRole(java.lang.String uri)
                  throws SOAPException
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
Throws:
SOAPException - - if there was an error in setting the Role for this SOAPFault object java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.

getChildElements

public java.util.Iterator getChildElements(Name name)
Overrides:
getChildElements in class SOAPBodyElementImpl

getChildElements

public java.util.Iterator getChildElements()
Description copied from class: SOAPElementImpl
Returns an iterator over all the immediate content of this element. This includes Text objects as well as SOAPElement objects.

Overrides:
getChildElements in class SOAPElementImpl
Returns:
an iterator over Text and SOAPElement contained within this SOAPElement object


Copyright © 2007 Apache Web Services Project. All Rights Reserved.