public class SOAPFaultImpl extends SOAPBodyElementImpl implements javax.xml.soap.SOAPFault
Modifier and Type | Field and Description |
---|---|
protected org.apache.axiom.soap.SOAPFault |
fault |
element
parentElement
builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED
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 and Description |
---|
SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault) |
Modifier and Type | Method and Description |
---|---|
javax.xml.soap.Detail |
addDetail() |
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(javax.xml.namespace.QName subcode)
Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault.
|
Iterator |
getChildElements()
Returns an iterator over all the immediate content of this element.
|
Iterator |
getChildElements(javax.xml.soap.Name name) |
javax.xml.soap.Detail |
getDetail() |
String |
getFaultActor() |
String |
getFaultCode()
Gets the fault code for this
SOAPFault object. |
javax.xml.soap.Name |
getFaultCodeAsName() |
javax.xml.namespace.QName |
getFaultCodeAsQName()
Gets the fault code for this SOAPFault object as a
QName object. |
String |
getFaultNode()
Returns the optional Node element value for this SOAPFault object.
|
Iterator |
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 |
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() |
Locale |
getFaultStringLocale()
Gets the locale of the fault string for this SOAPFault object.
|
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(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.soap.Name faultCodeName)
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.
|
void |
setFaultCode(javax.xml.namespace.QName qname)
Sets this SOAPFault object with the given fault code.
|
void |
setFaultCode(String faultCode)
Sets this
SOAPFault object with the given fault code. |
void |
setFaultNode(String s)
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.
|
addAttribute, addChildElement, createQName, getAllAttributesAsQNames, getAttributeValue, getChildElements, getElementQName, removeAttribute, setElementQName, setParentElement
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, appendElement, appendText, clone, copyContents, detach, detachNode, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getChildNodes, getElement, getElementName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getTextContent, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setParent, setValue, toString
getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType
build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getPreviousOMSibling, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
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
public SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)
fault
- public void setFaultCode(String faultCode) throws javax.xml.soap.SOAPException
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.setFaultCode
in interface javax.xml.soap.SOAPFault
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.javax.xml.soap.SOAPException
- - if there was an error in adding the faultCode to the underlying XML
tree.setFaultCode(Name), getFaultCode(),SOAPElement.addNamespaceDeclaration(String, String)
public String getFaultCode()
SOAPFault
object.getFaultCode
in interface javax.xml.soap.SOAPFault
String
with the fault codesetFaultCode(java.lang.String)
public void setFaultActor(String faultActor) throws javax.xml.soap.SOAPException
setFaultActor
in interface javax.xml.soap.SOAPFault
faultActor
- - a String identifying the actor that caused this SOAPFault objectjavax.xml.soap.SOAPException
- - if there was an error in adding the faultActor to the underlying XML
tree.public String getFaultActor()
getFaultActor
in interface javax.xml.soap.SOAPFault
public void setFaultString(String faultString) throws javax.xml.soap.SOAPException
SOAPFault
object to the given string.setFaultString
in interface javax.xml.soap.SOAPFault
faultString
- a String
giving an explanation of the faultjavax.xml.soap.SOAPException
- if there was an error in adding the faultString
to the
underlying XML tree.getFaultString()
public String getFaultString()
getFaultString
in interface javax.xml.soap.SOAPFault
public javax.xml.soap.Detail getDetail()
getDetail
in interface javax.xml.soap.SOAPFault
public void setFaultCode(javax.xml.soap.Name faultCodeName) throws javax.xml.soap.SOAPException
setFaultCode
in interface javax.xml.soap.SOAPFault
faultCodeQName
- - a Name object giving the fault code to be set. It must be namespace
qualified.javax.xml.soap.SOAPException
- - if there was an error in adding the faultcode element to the
underlying XML tree.public javax.xml.soap.Detail addDetail() throws javax.xml.soap.SOAPException
addDetail
in interface javax.xml.soap.SOAPFault
javax.xml.soap.SOAPException
public javax.xml.soap.Name getFaultCodeAsName()
getFaultCodeAsName
in interface javax.xml.soap.SOAPFault
public void setFaultString(String faultString, Locale locale) throws javax.xml.soap.SOAPException
setFaultString
in interface javax.xml.soap.SOAPFault
faultString
- - a String giving an explanation of the faultjavax.xml.soap.SOAPException
- - if there was an error in adding the faultString to the underlying XML
tree.getFaultString()
public Locale getFaultStringLocale()
getFaultStringLocale
in interface javax.xml.soap.SOAPFault
setFaultString(String, Locale)
public void addFaultReasonText(String text, Locale locale) throws javax.xml.soap.SOAPException
addFaultReasonText
in interface javax.xml.soap.SOAPFault
text
- - reason message string locale - Locale object representing the locale of the
messagejavax.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.public void appendFaultSubcode(javax.xml.namespace.QName subcode) throws javax.xml.soap.SOAPException
appendFaultSubcode
in interface javax.xml.soap.SOAPFault
subcode
- - a QName containing the Value of the Subcode.javax.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.public javax.xml.namespace.QName getFaultCodeAsQName()
QName
object.
getFaultCodeAsQName
in interface javax.xml.soap.SOAPFault
public String getFaultNode()
getFaultNode
in interface javax.xml.soap.SOAPFault
UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Fault Node.public Iterator getFaultReasonLocales() throws javax.xml.soap.SOAPException
getFaultReasonLocales
in interface javax.xml.soap.SOAPFault
javax.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.public String getFaultReasonText(Locale locale) throws javax.xml.soap.SOAPException
getFaultReasonText
in interface javax.xml.soap.SOAPFault
locale
- - the Locale for which a localized Reason Text is desiredjavax.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.public Iterator getFaultReasonTexts() throws javax.xml.soap.SOAPException
getFaultReasonTexts
in interface javax.xml.soap.SOAPFault
javax.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.public String getFaultRole()
getFaultRole
in interface javax.xml.soap.SOAPFault
UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Fault Role.public Iterator getFaultSubcodes()
getFaultSubcodes
in interface javax.xml.soap.SOAPFault
UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Subcode.public boolean hasDetail()
hasDetail
in interface javax.xml.soap.SOAPFault
public void removeAllFaultSubcodes()
removeAllFaultSubcodes
in interface javax.xml.soap.SOAPFault
UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Subcode.public void setFaultCode(javax.xml.namespace.QName qname) throws javax.xml.soap.SOAPException
setFaultCode
in interface javax.xml.soap.SOAPFault
faultCodeQName
- - a QName object giving the fault code to be set. It must be namespace
qualified.javax.xml.soap.SOAPException
- - if there was an error in adding the faultcode element to the
underlying XML tree.getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()
public void setFaultNode(String s) throws javax.xml.soap.SOAPException
setFaultNode
in interface javax.xml.soap.SOAPFault
javax.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.public void setFaultRole(String uri) throws javax.xml.soap.SOAPException
setFaultRole
in interface javax.xml.soap.SOAPFault
uri
- - the URI of the Rolejavax.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.public Iterator getChildElements(javax.xml.soap.Name name)
getChildElements
in interface javax.xml.soap.SOAPElement
getChildElements
in class SOAPElementImpl
public Iterator getChildElements()
SOAPElementImpl
Text
objects as well as SOAPElement
objects.getChildElements
in interface javax.xml.soap.SOAPElement
getChildElements
in class SOAPElementImpl
Text
and SOAPElement
contained within this
SOAPElement
objectCopyright © 2004–2016 The Apache Software Foundation. All rights reserved.