org.apache.axis2.saaj
Class DetailImpl

java.lang.Object
  org.apache.axiom.om.impl.dom.NodeImpl
      org.apache.axis2.saaj.NodeImplEx
          org.apache.axis2.saaj.SOAPElementImpl
              org.apache.axis2.saaj.SOAPFaultElementImpl
                  org.apache.axis2.saaj.DetailImpl

All Implemented Interfaces:

Cloneable, Detail, SOAPElement, SOAPFaultElement, Element, Node, NodeList

public class DetailImpl
extends SOAPFaultElementImpl
implements Detail

A container for DetailEntry objects. DetailEntry objects give detailed error information that is application-specific and related to the SOAPBody object that contains it.

A Detail object, which is part of a SOAPFault object, can be retrieved using the method SOAPFault.getDetail. The Detail interface provides two methods. One creates a new DetailEntry object and also automatically adds it to the Detail object. The second method gets a list of the DetailEntry objects contained in a Detail object.

The following code fragment, in which sf is a SOAPFault object, gets its Detail object (d), adds a new DetailEntry object to d, and then gets a list of all the DetailEntry objects in d. The code also creates a Name object to pass to the method addDetailEntry. The variable se, used to create the Name object, is a SOAPEnvelope object.

 Detail d = sf.getDetail(); Name name = se.createName("GetLastTradePrice", "WOMBAT",
 "http://www.wombat.org/trader"); d.addDetailEntry(name); Iterator it = d.getDetailEntries();
 

Field Summary

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, HAS_PARENT, 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

Constructor Summary

DetailImpl(org.apache.axiom.soap.SOAPFaultDetail element)

Method Summary

SOAPElement	addAttribute(QName qname, String value)
SOAPElement	addChildElement(QName qname)
DetailEntry	addDetailEntry(Name name) Creates a new DetailEntry object with the given name and adds it to this Detail object.
DetailEntry	addDetailEntry(QName qname) Creates a new DetailEntry object with the given name and adds it to this Detail object.
QName	createQName(String localName, String prefix) Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement.
Iterator	getAllAttributesAsQNames()
String	getAttributeValue(QName qname)
Iterator	getChildElements(QName qname)
Iterator	getDetailEntries() Gets a list of the detail entries in this Detail object.
QName	getElementQName()
boolean	removeAttribute(QName qname)
SOAPElement	setElementQName(QName newName)

Methods inherited from class org.apache.axis2.saaj.SOAPElementImpl

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, appendChild, appendElement, appendText, clone, copyContents, detach, detachNode, discard, getAllAttributes, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getChildElements, getChildElements, 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, setParentElement, 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

cloneNode, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getUserData, hasAttributes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface org.w3c.dom.Node

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

Constructor Detail

DetailImpl

public DetailImpl(org.apache.axiom.soap.SOAPFaultDetail element)

Parameters:

element -

Method Detail

addDetailEntry

public DetailEntry addDetailEntry(Name name)
                           throws SOAPException

Creates a new DetailEntry object with the given name and adds it to this Detail object.

Specified by:

addDetailEntry in interface Detail

Parameters:

name - a Name object identifying the new DetailEntry object

Returns:

DetailEntry.

Throws:

SOAPException - thrown when there is a problem in adding a DetailEntry object to this Detail object.

getDetailEntries

public Iterator getDetailEntries()

Gets a list of the detail entries in this Detail object.

Specified by:

getDetailEntries in interface Detail

Returns:

an Iterator object over the DetailEntry objects in this Detail object

addDetailEntry

public DetailEntry addDetailEntry(QName qname)
                           throws SOAPException

Creates a new DetailEntry object with the given name and adds it to this Detail object.

Specified by:

addDetailEntry in interface Detail

Parameters:

name - - a Name object identifying the new DetailEntry object

Throws:

SOAPException - - thrown when there is a problem in adding a DetailEntry object to this Detail object.

addAttribute

public SOAPElement addAttribute(QName qname,
                                String value)
                         throws SOAPException

Specified by:

addAttribute in interface SOAPElement

Overrides:

addAttribute in class SOAPElementImpl

Throws:

SOAPException

addChildElement

public SOAPElement addChildElement(QName qname)
                            throws SOAPException

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Throws:

SOAPException

createQName

public QName createQName(String localName,
                         String prefix)
                  throws SOAPException

Description copied from class: SOAPElementImpl

Creates a QName whose namespace URI is the one associated with the parameter, prefix, in the context of this SOAPElement. The remaining elements of the new QName are taken directly from the parameters, localName and prefix.

Specified by:

createQName in interface SOAPElement

Overrides:

createQName in class SOAPElementImpl

Parameters:

localName - - a String containing the local part of the name. prefix - a String containing the prefix for the name.

Returns:

a QName with the specified localName and prefix, and with a namespace that is associated with the prefix in the context of this SOAPElement. This namespace will be the same as the one that would be returned by getNamespaceURI(String) if it were given prefix as its parameter.

Throws:

SOAPException - - if the QName cannot be created.

getAllAttributesAsQNames

public Iterator getAllAttributesAsQNames()

Specified by:

getAllAttributesAsQNames in interface SOAPElement

Overrides:

getAllAttributesAsQNames in class SOAPElementImpl

getAttributeValue

public String getAttributeValue(QName qname)

Specified by:

getAttributeValue in interface SOAPElement

Overrides:

getAttributeValue in class SOAPElementImpl

getChildElements

public Iterator getChildElements(QName qname)

Specified by:

getChildElements in interface SOAPElement

Overrides:

getChildElements in class SOAPElementImpl

getElementQName

public QName getElementQName()

Specified by:

getElementQName in interface SOAPElement

Overrides:

getElementQName in class SOAPElementImpl

removeAttribute

public boolean removeAttribute(QName qname)

Specified by:

removeAttribute in interface SOAPElement

Overrides:

removeAttribute in class SOAPElementImpl

setElementQName

public SOAPElement setElementQName(QName newName)
                            throws SOAPException

Specified by:

setElementQName in interface SOAPElement

Overrides:

setElementQName in class SOAPElementImpl

Throws:

SOAPException