|
| |
|
| org.apache.axis2.saaj.NodeImplEx
 org.apache.axis2.saaj.SOAPElementImpl
org.apache.axis2.saaj.SOAPBodyElementImpl
org.apache.axis2.saaj.SOAPFaultImpl
| Field Summary | |
| protected org.apache.axiom.soap.SOAPFault | fault
|
| Constructor Summary | |
| public | SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)
|
| fault | | protected org.apache.axiom.soap.SOAPFault fault(Code) | | |
| SOAPFaultImpl | | public SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)(Code) | |
Parameters:
fault - |
| addFaultReasonText | | public void addFaultReasonText(String text, Locale locale) throws SOAPException(Code) | | 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 themessage
throws:
SOAPException - - if there was an error in adding the Reason text or the locale passedwas null. java.lang.UnsupportedOperationException - if this messagedoes not support the SOAP 1.2 concept of Fault Reason. |
| appendFaultSubcode | | public void appendFaultSubcode(QName subcode) throws SOAPException(Code) | | 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. |
| getFaultCodeAsName | | public Name getFaultCodeAsName()(Code) | | |
| getFaultCodeAsQName | | public QName getFaultCodeAsQName()(Code) | | Gets the fault code for this SOAPFault object as a QName object.
|
| getFaultNode | | public String getFaultNode()(Code) | | Returns the optional Node element value for this SOAPFault object. The Node element is
optional in SOAP 1.2.
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 SOAPException(Code) | | 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.
an Iterator over a sequence of Locale objects for which there are associated ReasonText items.
throws:
SOAPException - - if there was an error in retrieving the fault Reason locales.java.lang.UnsupportedOperationException - if this message does notsupport the SOAP 1.2 concept of Fault Reason.
since:
SAAJ 1.3 |
| getFaultReasonText | | public String getFaultReasonText(Locale locale) throws SOAPException(Code) | | 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 the Reason Text associated with locale
throws:
SOAPException - - if there was an error in retrieving the fault Reason text for thespecified locale. java.lang.UnsupportedOperationException - if thismessage does not support the SOAP 1.2 concept of Fault Reason.
since:
SAAJ 1.3 |
| getFaultReasonTexts | | public Iterator getFaultReasonTexts() throws SOAPException(Code) | | 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 objectsjava.lang.UnsupportedOperationException - if this message does notsupport the SOAP 1.2 concept of Fault Reason. |
| getFaultRole | | public String getFaultRole()(Code) | | Returns the optional Role element value for this SOAPFault object. The Role element is
optional in SOAP 1.2.
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 |
| getFaultStringLocale | | public Locale getFaultStringLocale()(Code) | | 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;
a Locale object indicating the native language of the fault string or null if nolocale was specified
See Also: setFaultString(String, Locale)
since:
SAAJ 1.2 |
| getFaultSubcodes | | public Iterator getFaultSubcodes()(Code) | | Gets the Subcodes for this SOAPFault as an iterator over QNames.
an Iterator that accesses a sequence of QNames. This Iterator should not support theoptional remove method. The order in which the Subcodes are returned reflects thehierarchy 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()(Code) | | Returns true if this SOAPFault has a Detail subelement and false otherwise.
|
| removeAllFaultSubcodes | | public void removeAllFaultSubcodes()(Code) | | 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:
UnsupportedOperationException - - if this message does not support the SOAP 1.2 concept of Subcode. |
| removeDefaults | | void removeDefaults()(Code) | | |
| setFaultActor | | public void setFaultActor(String faultActor) throws SOAPException(Code) | | 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 XMLtree. |
| setFaultCode | | public void setFaultCode(String faultCode) throws SOAPException(Code) | | 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 namespacedeclaration.
throws:
SOAPException - - if there was an error in adding the faultCode to the underlying XMLtree.
See Also: setFaultCode(Name), getFaultCode(),SOAPElement.addNamespaceDeclaration(String, String) |
| setFaultCode | | public void setFaultCode(Name faultCodeName) throws SOAPException(Code) | | 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).
Parameters:
faultCodeQName - - a Name object giving the fault code to be set. It must be namespacequalified.
throws:
SOAPException - - if there was an error in adding the faultcode element to theunderlying XML tree. |
| setFaultCode | | public void setFaultCode(QName qname) throws SOAPException(Code) | | 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 namespacequalified.
throws:
SOAPException - - if there was an error in adding the faultcode element to theunderlying XML tree.
See Also: getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()
since:
SAAJ 1.3 |
| setFaultNode | | public void setFaultNode(String s) throws SOAPException(Code) | | 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 notsupport the SOAP 1.2 concept of Fault Node.
since:
SAAJ 1.3 |
| setFaultRole | | public void setFaultRole(String uri) throws SOAPException(Code) | | 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 objectjava.lang.UnsupportedOperationException - if this message does notsupport the SOAP 1.2 concept of Fault Role. |
| setFaultString | | public void setFaultString(String faultString) throws SOAPException(Code) | | 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 theunderlying XML tree.
See Also: SOAPFaultImpl.getFaultString()
See Also: getFaultString() |
| setFaultString | | public void setFaultString(String faultString, Locale locale) throws SOAPException(Code) | | 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 XMLtree.
See Also: getFaultString() |
| Fields inherited from org.apache.axis2.saaj.SOAPElementImpl | protected ElementImpl element(Code)(Java Doc)
|
| Methods inherited from org.apache.axis2.saaj.SOAPElementImpl | public SOAPElement addAttribute(Name name, String value) throws SOAPException(Code)(Java Doc)
public SOAPElement addAttribute(QName qname, String value) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(Name name) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(SOAPElement soapElement) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(String localName, String prefix) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(String localName) throws SOAPException(Code)(Java Doc)
public SOAPElement addChildElement(QName qname) throws SOAPException(Code)(Java Doc)
public SOAPElement addNamespaceDeclaration(String prefix, String uri) throws SOAPException(Code)(Java Doc)
public SOAPElement addTextNode(String text) throws SOAPException(Code)(Java Doc)
public QName createQName(String localName, String prefix) throws SOAPException(Code)(Java Doc)
public OMNode detach()(Code)(Java Doc)
public void detachNode()(Code)(Java Doc)
public void discard() throws OMException(Code)(Java Doc)
public Iterator getAllAttributes()(Code)(Java Doc)
public Iterator getAllAttributesAsQNames()(Code)(Java Doc)
public String getAttribute(String name)(Code)(Java Doc)
public String getAttributeNS(String namespaceURI, String localName)(Code)(Java Doc)
public Attr getAttributeNode(String name)(Code)(Java Doc)
public Attr getAttributeNodeNS(String namespaceURI, String localName)(Code)(Java Doc)
public String getAttributeValue(Name name)(Code)(Java Doc)
public String getAttributeValue(QName qname)(Code)(Java Doc)
public NamedNodeMap getAttributes()(Code)(Java Doc)
public Iterator getChildElements()(Code)(Java Doc)
public Iterator getChildElements(Name name)(Code)(Java Doc)
public Iterator getChildElements(QName qname)(Code)(Java Doc)
public NodeList getChildNodes()(Code)(Java Doc)
public ElementImpl getElement()(Code)(Java Doc)
public Name getElementName()(Code)(Java Doc)
public QName getElementQName()(Code)(Java Doc)
public NodeList getElementsByTagName(String name)(Code)(Java Doc)
public NodeList getElementsByTagNameNS(String namespaceURI, String localName)(Code)(Java Doc)
public String getEncodingStyle()(Code)(Java Doc)
public org.w3c.dom.Node getFirstChild()(Code)(Java Doc)
public org.w3c.dom.Node getLastChild()(Code)(Java Doc)
public String getLocalName()(Code)(Java Doc)
public Iterator getNamespacePrefixes()(Code)(Java Doc)
public String getNamespaceURI()(Code)(Java Doc)
public String getNamespaceURI(String prefix)(Code)(Java Doc)
public org.w3c.dom.Node getNextSibling()(Code)(Java Doc)
public String getNodeName()(Code)(Java Doc)
public short getNodeType()(Code)(Java Doc)
public Document getOwnerDocument()(Code)(Java Doc)
public SOAPElement getParentElement()(Code)(Java Doc)
public Node getParentNode()(Code)(Java Doc)
public String getPrefix()(Code)(Java Doc)
public Node getPreviousSibling()(Code)(Java Doc)
public String getTagName()(Code)(Java Doc)
public String getValue()(Code)(Java Doc)
public Iterator getVisibleNamespacePrefixes()(Code)(Java Doc)
public boolean hasAttribute(String name)(Code)(Java Doc)
public boolean hasAttributeNS(String namespaceURI, String localName)(Code)(Java Doc)
public boolean hasChildNodes()(Code)(Java Doc)
public void internalSerialize(javax.xml.stream.XMLStreamWriter writer) throws XMLStreamException(Code)(Java Doc)
public void internalSerializeAndConsume(javax.xml.stream.XMLStreamWriter writer) throws XMLStreamException(Code)(Java Doc)
public boolean removeAttribute(QName qname)(Code)(Java Doc)
public boolean removeAttribute(Name name)(Code)(Java Doc)
public void removeAttribute(String name) throws DOMException(Code)(Java Doc)
public void removeAttributeNS(String namespaceURI, String localName) throws DOMException(Code)(Java Doc)
public Attr removeAttributeNode(Attr attr) throws DOMException(Code)(Java Doc)
public void removeContents()(Code)(Java Doc)
public boolean removeNamespaceDeclaration(String prefix)(Code)(Java Doc)
public void setAttribute(String name, String value) throws DOMException(Code)(Java Doc)
public void setAttributeNS(String namespaceURI, String qualifiedName, String value) throws DOMException(Code)(Java Doc)
public Attr setAttributeNode(Attr attr) throws DOMException(Code)(Java Doc)
public Attr setAttributeNodeNS(Attr attr) throws DOMException(Code)(Java Doc)
public SOAPElement setElementQName(QName newName) throws SOAPException(Code)(Java Doc)
public void setEncodingStyle(String encodingStyle) throws SOAPException(Code)(Java Doc)
public void setParent(OMContainer parentElement)(Code)(Java Doc)
public void setParentElement(SOAPElement parent) throws SOAPException(Code)(Java Doc)
public void setValue(String value)(Code)(Java Doc)
|
|
|
|