org.apache.axis.message.SOAPBody

All Implemented Interfaces:: Serializable, Cloneable, Node, SOAPBody, SOAPElement, Element, Node, NodeList

public class SOAPBody extends MessageElement implements SOAPBody

Holder for body elements.

Author:

Glyn Normington (glyn@apache.org)

See Also:

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement
MessageElement.QNameAttr
Field Summary

Fields inherited from class org.apache.axis.message.MessageElement
_isRoot, context, encodingStyle, endEventIndex, fixupDeserializer, href, id, message, namespaces, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName

Fields inherited from class org.apache.axis.message.NodeImpl
_isDirty, attributes, children, document, name, namespaceURI, parent, prefix, textRep

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

Constructors

Constructor

Description

SOAPBody(String namespace, String localPart, String prefix, Attributes attributes, DeserializationContext context, SOAPConstants soapConsts)
Method Summary

Modifier and Type

Method

Description

SOAPBodyElement

addBodyElement(Name name)

Creates a new SOAPBodyElement object with the specified name and adds it to this SOAPBody object.

void

addChild(MessageElement element)

Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.

SOAPElement

addChildElement(String localName)

add a child element in the message element's own namespace

SOAPElement

addChildElement(String localName, String prefix)

add a child element

SOAPElement

addChildElement(String localName, String prefix, String uri)

add a child element

SOAPElement

addChildElement(Name name)

add the child element

SOAPElement

addChildElement(SOAPElement element)

The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.

SOAPBodyElement

addDocument(Document document)

Adds the root node of the DOM Document to this SOAPBody object.

SOAPFault

addFault()

Creates a new SOAPFault object and adds it to this SOAPBody object.

SOAPFault

addFault(Name name, String s)

Creates a new SOAPFault object and adds it to this SOAPBody object.

SOAPFault

addFault(Name name, String s, Locale locale)

Creates a new SOAPFault object and adds it to this SOAPBody object.

void

disableFormatting()

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)

override point -output to a serialization context.

void

setEncodingStyle(String encodingStyle)

Sets the encoding style for this SOAPElement object to one specified.

void

setParentElement(SOAPElement parent)

Sets the parent of this Node object to the given SOAPElement object.

void

setSAAJEncodingCompliance(boolean comply)

Methods inherited from class org.apache.axis.message.MessageElement
addAttribute, addAttribute, addAttribute, addAttribute, addMapping, addNamespaceDeclaration, addTextNode, childDeepCloned, cloneNode, cloning, detachAllChildren, equals, findElement, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributesEx, getAttributeValue, getAttributeValue, getChildElement, getChildElements, getChildElements, getChildElements, getChildren, getCompleteAttributes, getDeserializationContext, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getLength, getName, getNamespacePrefixes, getNamespaceURI, getObjectValue, getObjectValue, getOwnerDocument, getPrefix, getQName, getRealElement, getRecorder, getTagName, getType, getValue, getValueAsType, getValueAsType, getValueDOM, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, isRoot, item, output, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAllAttributes, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setQName, setRecorder, setType, setValue, toString

Methods inherited from class org.apache.axis.message.NodeImpl
appendChild, compareDocumentPosition, convertAttrSAXtoDOM, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, getSchemaTypeInfo, getTextContent, getUserData, hasAttributes, hasChildNodes, initializeChildren, insertBefore, isDefaultNamespace, isDirty, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, makeAttributesEditable, normalize, recycleNode, removeChild, replaceChild, reset, setDirty, setDirty, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setOwnerDocument, setParent, setPrefix, setTextContent, setUserData

Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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 javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setValue

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

Methods inherited from interface javax.xml.soap.SOAPElement
addAttribute, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration

Constructor Details
- SOAPBody
  
  public SOAPBody(String namespace, String localPart, String prefix, Attributes attributes, DeserializationContext context, SOAPConstants soapConsts) throws AxisFault
  
  Throws:
  
  AxisFault
Method Details
- setParentElement
  
  public void setParentElement(SOAPElement parent) throws SOAPException
  
  Description copied from class: NodeImpl
  
  Sets the parent of this Node object to the given SOAPElement object.
  Specified by:
  
  setParentElement in interface Node
  
  Overrides:
  
  setParentElement in class NodeImpl
  
  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()
- disableFormatting
  
  public void disableFormatting()
- setEncodingStyle
  
  public void setEncodingStyle(String encodingStyle) throws SOAPException
  
  Description copied from class: MessageElement
  
  Sets the encoding style for this SOAPElement object to one specified. The semantics of a null value, as above in getEncodingStyle() are to just use the parent's value, but null here means set to "".
  Specified by:
  
  setEncodingStyle in interface SOAPElement
  
  Overrides:
  
  setEncodingStyle in class MessageElement
  
  Parameters:
  
  encodingStyle - a String giving the encoding style
  
  Throws:
  
  SOAPException
  
  See Also:
  
  getEncodingStyle()
- outputImpl
  
  protected void outputImpl(SerializationContext context) throws Exception
  
  Description copied from class: MessageElement
  
  override point -output to a serialization context.
  
  Overrides:
  
  outputImpl in class MessageElement
  
  Parameters:
  
  context - destination.
  
  Throws:
  
  Exception - if something went wrong.
- 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
  
  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(Name name, String s, Locale locale) throws SOAPException
  
  Description copied from interface: SOAPBody
  
  Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring and localized to locale.
  
  Specified by:
  
  addFault in interface SOAPBody
  
  Parameters:
  
  name - a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
  
  s - a String giving an explanation of the fault
  
  locale - a Locale object indicating the native language of the faultString
  
  Returns:
  
  the new SOAPFault object
  
  Throws:
  
  SOAPException - if there is a SOAP error
- addFault
  
  public SOAPFault addFault(Name name, String s) throws SOAPException
  
  Description copied from interface: SOAPBody
  
  Creates a new SOAPFault object and adds it to this SOAPBody object. The new SOAPFault will have a faultcode element that is set to the faultCode parameter and a faultstring set to faultstring.
  
  Specified by:
  
  addFault in interface SOAPBody
  
  Parameters:
  
  name - a Name object giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QName
  
  s - a String giving an explanation of the fault
  
  Returns:
  
  the new SOAPFault object
  
  Throws:
  
  SOAPException - if there is a SOAP error
- addDocument
  
  public SOAPBodyElement addDocument(Document document) throws SOAPException
  
  Description copied from interface: SOAPBody
  
  Adds the root node of the DOM Document to this SOAPBody object.
  Calling this method invalidates the document parameter. The client application should discard all references to this Document and its contents upon calling addDocument. The behavior of an application that continues to use such references is undefined.
  
  Specified by:
  
  addDocument in interface SOAPBody
  
  Parameters:
  
  document - the Document object whose root node will be added to this SOAPBody
  
  Returns:
  
  the SOAPBodyElement that represents the root node that was added
  
  Throws:
  
  SOAPException - if the Document cannot be added
- 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
  
  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
  
  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
  
  Returns:
  
  true if a SOAPFault object exists in this SOAPBody object; false otherwise
- addChild
  
  public void addChild(MessageElement element) 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
  
  Throws:
  
  SOAPException
- addChildElement
  
  public SOAPElement addChildElement(SOAPElement element) throws SOAPException
  
  Description copied from class: MessageElement
  
  The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.
  Specified by:
  
  addChildElement in interface SOAPElement
  
  Overrides:
  
  addChildElement in class MessageElement
  
  Parameters:
  
  element - the SOAPElement to be added as a new child
  
  Returns:
  
  an instance representing the new SOAP element that was actually added to the tree.
  
  Throws:
  
  SOAPException - if there was an error in adding this element as a child
  
  See Also:
  
  SOAPElement.addChildElement(javax.xml.soap.SOAPElement)
- addChildElement
  
  public SOAPElement addChildElement(Name name) throws SOAPException
  
  Description copied from class: MessageElement
  
  add the child element
  Specified by:
  
  addChildElement in interface SOAPElement
  
  Overrides:
  
  addChildElement in class MessageElement
  
  Parameters:
  
  name - uri, prefix and local name of the element to add
  
  Returns:
  
  the child element
  
  Throws:
  
  SOAPException
  
  See Also:
  
  SOAPElement.addChildElement(javax.xml.soap.Name)
- addChildElement
  
  public SOAPElement addChildElement(String localName) throws SOAPException
  
  Description copied from class: MessageElement
  
  add a child element in the message element's own namespace
  Specified by:
  
  addChildElement in interface SOAPElement
  
  Overrides:
  
  addChildElement in class MessageElement
  
  Parameters:
  
  localName -
  
  Returns:
  
  the child element
  
  Throws:
  
  SOAPException
  
  See Also:
  
  SOAPElement.addChildElement(String)
- addChildElement
  
  public SOAPElement addChildElement(String localName, String prefix) throws SOAPException
  
  Description copied from class: MessageElement
  
  add a child element
  Specified by:
  
  addChildElement in interface SOAPElement
  
  Overrides:
  
  addChildElement in class MessageElement
  
  Parameters:
  
  localName -
  
  prefix -
  
  Returns:
  
  the child element
  
  Throws:
  
  SOAPException
  
  See Also:
  
  SOAPElement.addChildElement(String, String)
- addChildElement
  
  public SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException
  
  Description copied from class: MessageElement
  
  add a child element
  Specified by:
  
  addChildElement in interface SOAPElement
  
  Overrides:
  
  addChildElement in class MessageElement
  
  Parameters:
  
  localName -
  
  prefix -
  
  uri -
  
  Returns:
  
  the child element
  
  Throws:
  
  SOAPException
  
  See Also:
  
  SOAPElement.addChildElement(String, String, String)
- setSAAJEncodingCompliance
  
  public void setSAAJEncodingCompliance(boolean comply)

Class SOAPBody

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement

Field Summary

Fields inherited from class org.apache.axis.message.MessageElement

Fields inherited from class org.apache.axis.message.NodeImpl

Fields inherited from interface org.w3c.dom.Node

Constructor Summary

Method Summary

Methods inherited from class org.apache.axis.message.MessageElement

Methods inherited from class org.apache.axis.message.NodeImpl

Methods inherited from class java.lang.Object

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Node

Methods inherited from interface javax.xml.soap.SOAPElement

Constructor Details

SOAPBody

Method Details

setParentElement

disableFormatting

setEncodingStyle

outputImpl

addBodyElement

addFault

addFault

addDocument

addFault

getFault

hasFault

addChild

addChildElement

addChildElement

addChildElement

addChildElement

addChildElement

setSAAJEncodingCompliance