org.apache.axis.message
Class SOAPBody

java.lang.Object
  |
  +--org.apache.axis.message.MessageElement
        |
        +--org.apache.axis.message.SOAPBody
All Implemented Interfaces:
Node, java.io.Serializable, SOAPBody, SOAPElement

public class SOAPBody
extends MessageElement
implements SOAPBody

Holder for body elements.

Author:
Glyn Normington (glyn@apache.org)
See Also:
Serialized Form

Inner classes inherited from class org.apache.axis.message.MessageElement
MessageElement.QNameAttr
 
Fields inherited from class org.apache.axis.message.MessageElement
_isDirty, _isRoot, attributes, context, elementRep, encodingStyle, endEventIndex, href, id, log, message, name, namespaces, namespaceURI, parent, prefix, qNameAttrs, recorder, startContentsIndex, startEventIndex, textRep, typeQName
 
Constructor Summary
SOAPBody(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context, SOAPConstants soapConsts)
           
 
Method Summary
 SOAPBodyElement addBodyElement(Name name)
          Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
 void addChild(MessageElement el)
          Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.
 SOAPFault addFault()
          Creates a new SOAPFault object and adds it to this SOAPBody object.
 void detachNode()
          Removes this Node object from the tree.
protected  MessageElement findElement(java.util.Vector vec, java.lang.String namespace, java.lang.String localPart)
           
 java.util.Iterator getChildElements()
          Returns an iterator over all the immediate content of this element.
 java.util.Iterator getChildElements(Name name)
          Returns an iterator over all the child elements with the specified name.
 SOAPFault getFault()
          Returns the SOAPFault object in this SOAPBody object.
 boolean hasFault()
          Indicates whether a SOAPFault object exists in this SOAPBody object.
protected  void outputImpl(SerializationContext context)
          Subclasses can override
 void removeChild(MessageElement child)
          Remove a child element.
 void setParentElement(SOAPElement parent)
          Sets the parent of this Node object to the given SOAPElement object.
 
Methods inherited from class org.apache.axis.message.MessageElement
addAttribute, addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, getAllAttributes, getAsDocument, getAsDOM, getAttributes, getAttributeValue, getAttributeValue, getChildren, getCompleteAttributes, getElementName, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getObjectValue, getParentElement, getPrefix, getPrefix, getQName, getRealElement, getRecorder, getType, getValue, getValueAsType, isDirty, isRoot, makeAttributesEditable, output, publishContents, publishToHandler, recycleNode, removeAttribute, removeNamespaceDeclaration, setAttribute, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setPrefix, setQName, setRecorder, setType, toString
 
Methods inherited from class java.lang.Object
clone, 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, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, removeAttribute, removeNamespaceDeclaration, setEncodingStyle
 
Methods inherited from interface javax.xml.soap.Node
getParentElement, getValue, recycleNode
 

Constructor Detail

SOAPBody

public SOAPBody(java.lang.String namespace,
                java.lang.String localPart,
                java.lang.String prefix,
                org.xml.sax.Attributes attributes,
                DeserializationContext context,
                SOAPConstants soapConsts)
Method Detail

setParentElement

public void setParentElement(SOAPElement parent)
                      throws SOAPException
Description copied from interface: Node
Sets the parent of this Node object to the given SOAPElement object.
Specified by:
setParentElement in interface Node
Overrides:
setParentElement in class MessageElement
Following copied from interface: javax.xml.soap.Node
Parameters:
parent - the SOAPElement object to be set as the parent of this Node object
Throws:
SOAPException - if there is a problem in setting the parent to the given element
See Also:
getParentElement()

detachNode

public void detachNode()
Description copied from interface: Node
Removes this Node object from the tree. Once removed, this node can be garbage collected if there are no application references to it.
Specified by:
detachNode in interface Node
Overrides:
detachNode in class MessageElement

outputImpl

protected void outputImpl(SerializationContext context)
                   throws java.lang.Exception
Description copied from class: MessageElement
Subclasses can override
Overrides:
outputImpl in class MessageElement

findElement

protected MessageElement findElement(java.util.Vector vec,
                                     java.lang.String namespace,
                                     java.lang.String localPart)

addBodyElement

public SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException
Description copied from interface: SOAPBody
Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.
Specified by:
addBodyElement in interface SOAPBody
Following copied from interface: javax.xml.soap.SOAPBody
Parameters:
name - a Name object with the name for the new SOAPBodyElement object
Returns:
the new SOAPBodyElement object
Throws:
SOAPException - if a SOAP error occurs

addFault

public SOAPFault addFault()
                   throws SOAPException
Description copied from interface: SOAPBody
Creates a new SOAPFault object and adds it to this SOAPBody object.
Specified by:
addFault in interface SOAPBody
Following copied from interface: javax.xml.soap.SOAPBody
Returns:
the new SOAPFault object
Throws:
SOAPException - if there is a SOAP error

getFault

public SOAPFault getFault()
Description copied from interface: SOAPBody
Returns the SOAPFault object in this SOAPBody object.
Specified by:
getFault in interface SOAPBody
Following copied from interface: javax.xml.soap.SOAPBody
Returns:
the SOAPFault object in this SOAPBody object

hasFault

public boolean hasFault()
Description copied from interface: SOAPBody
Indicates whether a SOAPFault object exists in this SOAPBody object.
Specified by:
hasFault in interface SOAPBody
Following copied from interface: javax.xml.soap.SOAPBody
Returns:
true if a SOAPFault object exists in this SOAPBody object; false otherwise

addChild

public void addChild(MessageElement el)
              throws SOAPException
Description copied from class: MessageElement
Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.
Overrides:
addChild in class MessageElement

getChildElements

public java.util.Iterator getChildElements()
Description copied from interface: SOAPElement
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 SOAPElement
Overrides:
getChildElements in class MessageElement
Following copied from interface: javax.xml.soap.SOAPElement
Returns:
an iterator with the content of this SOAPElement object

getChildElements

public java.util.Iterator getChildElements(Name name)
Description copied from interface: SOAPElement
Returns an iterator over all the child elements with the specified name.
Specified by:
getChildElements in interface SOAPElement
Overrides:
getChildElements in class MessageElement
Following copied from interface: javax.xml.soap.SOAPElement
Parameters:
name - a Name object with the name of the child elements to be returned
Returns:
an Iterator object over all the elements in this SOAPElement object with the specified name

removeChild

public void removeChild(MessageElement child)
Description copied from class: MessageElement
Remove a child element.
Overrides:
removeChild in class MessageElement


Copyright © 2002 Apache XML Project. All Rights Reserved.