|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.impl.dom.NodeImpl
org.apache.axis2.saaj.NodeImplEx
org.apache.axis2.saaj.SOAPElementImpl
org.apache.axis2.saaj.SOAPBodyElementImpl
org.apache.axis2.saaj.SOAPFaultImpl
public class SOAPFaultImpl
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.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 |
---|
protected org.apache.axiom.soap.SOAPFault fault
Constructor Detail |
---|
public SOAPFaultImpl(org.apache.axiom.soap.SOAPFault fault)
fault
- Method Detail |
---|
public void setFaultCode(java.lang.String faultCode) throws 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.
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.
SOAPException
- - if there was an error in adding the faultCode to the underlying XML
tree.setFaultCode(Name), getFaultCode(),SOAPElement.addNamespaceDeclaration(String, String)
public java.lang.String getFaultCode()
SOAPFault
object.
String
with the fault codesetFaultCode(java.lang.String)
public void setFaultActor(java.lang.String faultActor) throws SOAPException
faultActor
- - a String identifying the actor that caused this SOAPFault object
SOAPException
- - if there was an error in adding the faultActor to the underlying XML
tree.public java.lang.String getFaultActor()
public void setFaultString(java.lang.String faultString) throws SOAPException
SOAPFault
object to the given string.
faultString
- a String
giving an explanation of the fault
SOAPException
- if there was an error in adding the faultString
to the
underlying XML tree.getFaultString()
public java.lang.String getFaultString()
public Detail getDetail()
public Detail addDetail() throws SOAPException
SOAPException
public Name getFaultCodeAsName()
public void setFaultString(java.lang.String faultString, java.util.Locale locale) throws SOAPException
faultString
- - a String giving an explanation of the fault
SOAPException
- - if there was an error in adding the faultString to the underlying XML
tree.getFaultString()
public java.util.Locale getFaultStringLocale()
setFaultString(String, Locale)
public void addFaultReasonText(java.lang.String text, java.util.Locale locale) throws SOAPException
text
- - reason message string locale - Locale object representing the locale of the
message
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 SOAPException
subcode
- - a QName containing the Value of the Subcode.
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.
public java.lang.String getFaultNode()
java.lang.UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Fault Node.public java.util.Iterator getFaultReasonLocales() throws SOAPException
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 java.lang.String getFaultReasonText(java.util.Locale locale) throws SOAPException
locale
- - the Locale for which a localized Reason Text is desired
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 java.util.Iterator getFaultReasonTexts() throws SOAPException
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 java.lang.String getFaultRole()
java.lang.UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Fault Role.public java.util.Iterator getFaultSubcodes()
java.lang.UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Subcode.public boolean hasDetail()
public void removeAllFaultSubcodes()
java.lang.UnsupportedOperationException
- - if this message does not support the SOAP 1.2 concept of Subcode.public void setFaultCode(javax.xml.namespace.QName qname) throws SOAPException
faultCodeQName
- - a QName object giving the fault code to be set. It must be namespace
qualified.
SOAPException
- - if there was an error in adding the faultcode element to the
underlying XML tree.getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()
public void setFaultNode(java.lang.String s) throws SOAPException
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(java.lang.String uri) throws SOAPException
uri
- - the URI of the Role
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 java.util.Iterator getChildElements(Name name)
getChildElements
in class SOAPBodyElementImpl
public java.util.Iterator getChildElements()
SOAPElementImpl
Text
objects as well as SOAPElement
objects.
getChildElements
in class SOAPElementImpl
Text
and SOAPElement
contained within this
SOAPElement
object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |