Package org.apache.axis2.saaj

Class SOAPFaultImpl

java.lang.Object
org.apache.axis2.saaj.ProxyNode<T,S>
org.apache.axis2.saaj.NodeImpl<Element,T>
org.apache.axis2.saaj.SOAPElementImpl<T>
org.apache.axis2.saaj.SOAPBodyElementImpl<org.apache.axiom.soap.SOAPFault>
org.apache.axis2.saaj.SOAPFaultImpl
All Implemented Interfaces:
jakarta.xml.soap.Node, jakarta.xml.soap.SOAPBodyElement, jakarta.xml.soap.SOAPElement, jakarta.xml.soap.SOAPFault, Element, Node
public class SOAPFaultImpl extends SOAPBodyElementImpl<org.apache.axiom.soap.SOAPFault> implements jakarta.xml.soap.SOAPFault

  • Constructor Details

    • SOAPFaultImpl

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

  • Method Details

    • setFaultCode

      public void setFaultCode(String faultCode) throws jakarta.xml.soap.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.

      Specified by:
      setFaultCode in interface jakarta.xml.soap.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:
      jakarta.xml.soap.SOAPException - - if there was an error in adding the faultCode to the underlying XML tree.

    • getFaultCode

      public String getFaultCode()
      Gets the fault code for this SOAPFault object.
      Specified by:
      getFaultCode in interface jakarta.xml.soap.SOAPFault
      Returns:
      a String with the fault code
      See Also:

    • setFaultActor

      public void setFaultActor(String faultActor) throws jakarta.xml.soap.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)
      Specified by:
      setFaultActor in interface jakarta.xml.soap.SOAPFault
      Parameters:
      faultActor - - a String identifying the actor that caused this SOAPFault object
      Throws:
      jakarta.xml.soap.SOAPException - - if there was an error in adding the faultActor to the underlying XML tree.

    • getFaultActor

      public String getFaultActor()
      Specified by:
      getFaultActor in interface jakarta.xml.soap.SOAPFault

    • setFaultString

      public void setFaultString(String faultString) throws jakarta.xml.soap.SOAPException
      Sets the fault string for this SOAPFault object to the given string.
      Specified by:
      setFaultString in interface jakarta.xml.soap.SOAPFault
      Parameters:
      faultString - a String giving an explanation of the fault
      Throws:
      jakarta.xml.soap.SOAPException - if there was an error in adding the faultString to the underlying XML tree.
      See Also:

    • getFaultString

      public String getFaultString()
      Specified by:
      getFaultString in interface jakarta.xml.soap.SOAPFault

    • getDetail

      public jakarta.xml.soap.Detail getDetail()
      Specified by:
      getDetail in interface jakarta.xml.soap.SOAPFault

    • setFaultCode

      public void setFaultCode(jakarta.xml.soap.Name faultCodeName) throws jakarta.xml.soap.SOAPException
      Sets this SOAPFault object with the given fault code.Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification. A fault code is mandatory and must be of type QName. This method provides a convenient way to set a fault code. For example,

      SOAPEnvelope se = ...; // Create a qualified name in the SOAP namespace with a localName // of Client. Note that prefix parameter is optional and is null // here which causes the implementation to use an appropriate prefix. Name qname = se.createName(Client, null,SOAPConstants.URI_NS_SOAP_ENVELOPE); SOAPFault fault = ...; fault.setFaultCode(qname);

      It is preferable to use this method over setFaultCode(String).

      Specified by:
      setFaultCode in interface jakarta.xml.soap.SOAPFault
      Parameters:
      faultCodeQName - - a Name object giving the fault code to be set. It must be namespace qualified.
      Throws:
      jakarta.xml.soap.SOAPException - - if there was an error in adding the faultcode element to the underlying XML tree.

    • addDetail

      public jakarta.xml.soap.Detail addDetail() throws jakarta.xml.soap.SOAPException
      Specified by:
      addDetail in interface jakarta.xml.soap.SOAPFault
      Throws:
      jakarta.xml.soap.SOAPException

    • getFaultCodeAsName

      public jakarta.xml.soap.Name getFaultCodeAsName()
      Specified by:
      getFaultCodeAsName in interface jakarta.xml.soap.SOAPFault

    • setFaultString

      public void setFaultString(String faultString, Locale locale) throws jakarta.xml.soap.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());
      Specified by:
      setFaultString in interface jakarta.xml.soap.SOAPFault
      Parameters:
      faultString - - a String giving an explanation of the fault
      Throws:
      jakarta.xml.soap.SOAPException - - if there was an error in adding the faultString to the underlying XML tree.
      See Also:

    • getFaultStringLocale

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

      Specified by:
      getFaultStringLocale in interface jakarta.xml.soap.SOAPFault
      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:

    • addFaultReasonText

      public void addFaultReasonText(String text, Locale locale) throws jakarta.xml.soap.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);
      Specified by:
      addFaultReasonText in interface jakarta.xml.soap.SOAPFault
      Parameters:
      text - - reason message string locale - Locale object representing the locale of the message
      Throws:
      jakarta.xml.soap.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(QName subcode) throws jakarta.xml.soap.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.
      Specified by:
      appendFaultSubcode in interface jakarta.xml.soap.SOAPFault
      Parameters:
      subcode - - a QName containing the Value of the Subcode.
      Throws:
      jakarta.xml.soap.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 QName getFaultCodeAsQName()
      Gets the fault code for this SOAPFault object as a QName object.

      Specified by:
      getFaultCodeAsQName in interface jakarta.xml.soap.SOAPFault

    • getFaultNode

      public String getFaultNode()
      Returns the optional Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.
      Specified by:
      getFaultNode in interface jakarta.xml.soap.SOAPFault
      Returns:
      Content of the env:Fault/env:Node element as a String or null if none
      Throws:
      UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Fault Node.

    • getFaultReasonLocales

      public Iterator getFaultReasonLocales() throws jakarta.xml.soap.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.
      Specified by:
      getFaultReasonLocales in interface jakarta.xml.soap.SOAPFault
      Returns:
      an Iterator over a sequence of Locale objects for which there are associated Reason Text items.
      Throws:
      jakarta.xml.soap.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 String getFaultReasonText(Locale locale) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.SOAPFault
      Parameters:
      locale - - the Locale for which a localized Reason Text is desired
      Returns:
      the Reason Text associated with locale
      Throws:
      jakarta.xml.soap.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 Iterator getFaultReasonTexts() throws jakarta.xml.soap.SOAPException
      Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.
      Specified by:
      getFaultReasonTexts in interface jakarta.xml.soap.SOAPFault
      Throws:
      jakarta.xml.soap.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 String getFaultRole()
      Returns the optional Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2.
      Specified by:
      getFaultRole in interface jakarta.xml.soap.SOAPFault
      Returns:
      Content of the env:Fault/env:Role element as a String or null if none
      Throws:
      UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Fault Role.
      Since:
      SAAJ 1.3

    • getFaultSubcodes

      public Iterator getFaultSubcodes()
      Gets the Subcodes for this SOAPFault as an iterator over QNames.
      Specified by:
      getFaultSubcodes in interface jakarta.xml.soap.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.
      Throws:
      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.
      Specified by:
      hasDetail in interface jakarta.xml.soap.SOAPFault

    • 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.
      Specified by:
      removeAllFaultSubcodes in interface jakarta.xml.soap.SOAPFault
      Throws:
      UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Subcode.

    • setFaultCode

      public void setFaultCode(QName qname) throws jakarta.xml.soap.SOAPException
      Sets this SOAPFault object with the given fault code. It is preferable to use this method over setFaultCode(Name)
      Specified by:
      setFaultCode in interface jakarta.xml.soap.SOAPFault
      Parameters:
      faultCodeQName - - a QName object giving the fault code to be set. It must be namespace qualified.
      Throws:
      jakarta.xml.soap.SOAPException - - if there was an error in adding the faultcode element to the underlying XML tree.
      Since:
      SAAJ 1.3

    • setFaultNode

      public void setFaultNode(String s) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.SOAPFault
      Throws:
      jakarta.xml.soap.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(String uri) throws jakarta.xml.soap.SOAPException
      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 jakarta.xml.soap.SOAPFault
      Parameters:
      uri - - the URI of the Role
      Throws:
      jakarta.xml.soap.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 Iterator getChildElements(jakarta.xml.soap.Name name)
      Specified by:
      getChildElements in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getChildElements in class SOAPElementImpl<org.apache.axiom.soap.SOAPFault>

    • getChildElements

      public 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.
      Specified by:
      getChildElements in interface jakarta.xml.soap.SOAPElement
      Overrides:
      getChildElements in class SOAPElementImpl<org.apache.axiom.soap.SOAPFault>
      Returns:
      an iterator over Text and SOAPElement contained within this SOAPElement object