Package org.apache.axis.message
Class SOAPBody
- java.lang.Object
-
- org.apache.axis.message.NodeImpl
-
- org.apache.axis.message.MessageElement
-
- org.apache.axis.message.SOAPBody
-
- All Implemented Interfaces:
java.io.Serializable,java.lang.Cloneable,Node,SOAPBody,SOAPElement,org.w3c.dom.Element,org.w3c.dom.Node,org.w3c.dom.NodeList
public class SOAPBody extends MessageElement implements SOAPBody
Holder for body elements.- Author:
- Glyn Normington (glyn@apache.org)
- See Also:
- Serialized Form
-
-
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(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context, SOAPConstants soapConsts)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SOAPBodyElementaddBodyElement(Name name)Creates a newSOAPBodyElementobject with the specified name and adds it to thisSOAPBodyobject.voidaddChild(MessageElement element)Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.SOAPElementaddChildElement(java.lang.String localName)add a child element in the message element's own namespaceSOAPElementaddChildElement(java.lang.String localName, java.lang.String prefix)add a child elementSOAPElementaddChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)add a child elementSOAPElementaddChildElement(Name name)add the child elementSOAPElementaddChildElement(SOAPElement element)The added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.SOAPBodyElementaddDocument(org.w3c.dom.Document document)Adds the root node of the DOMDocumentto thisSOAPBodyobject.SOAPFaultaddFault()Creates a newSOAPFaultobject and adds it to thisSOAPBodyobject.SOAPFaultaddFault(Name name, java.lang.String s)Creates a newSOAPFaultobject and adds it to thisSOAPBodyobject.SOAPFaultaddFault(Name name, java.lang.String s, java.util.Locale locale)Creates a newSOAPFaultobject and adds it to thisSOAPBodyobject.voiddisableFormatting()SOAPFaultgetFault()Returns theSOAPFaultobject in thisSOAPBodyobject.booleanhasFault()Indicates whether aSOAPFaultobject exists in thisSOAPBodyobject.protected voidoutputImpl(SerializationContext context)override point -output to a serialization context.voidsetEncodingStyle(java.lang.String encodingStyle)Sets the encoding style for thisSOAPElementobject to one specified.voidsetParentElement(SOAPElement parent)Sets the parent of thisNodeobject to the givenSOAPElementobject.voidsetSAAJEncodingCompliance(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 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) throws AxisFault- Throws:
AxisFault
-
-
Method Detail
-
setParentElement
public void setParentElement(SOAPElement parent) throws SOAPException
Description copied from class:NodeImplSets the parent of thisNodeobject to the givenSOAPElementobject.- Specified by:
setParentElementin interfaceNode- Overrides:
setParentElementin classNodeImpl- Parameters:
parent- theSOAPElementobject to be set as the parent of thisNodeobject- 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(java.lang.String encodingStyle) throws SOAPExceptionDescription copied from class:MessageElementSets the encoding style for thisSOAPElementobject 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:
setEncodingStylein interfaceSOAPElement- Overrides:
setEncodingStylein classMessageElement- Parameters:
encodingStyle- aStringgiving the encoding style- Throws:
SOAPException- See Also:
getEncodingStyle()
-
outputImpl
protected void outputImpl(SerializationContext context) throws java.lang.Exception
Description copied from class:MessageElementoverride point -output to a serialization context.- Overrides:
outputImplin classMessageElement- Parameters:
context- destination.- Throws:
java.lang.Exception- if something went wrong.
-
addBodyElement
public SOAPBodyElement addBodyElement(Name name) throws SOAPException
Description copied from interface:SOAPBodyCreates a newSOAPBodyElementobject with the specified name and adds it to thisSOAPBodyobject.- Specified by:
addBodyElementin interfaceSOAPBody- Parameters:
name- aNameobject with the name for the newSOAPBodyElementobject- Returns:
- the new
SOAPBodyElementobject - Throws:
SOAPException- if a SOAP error occurs
-
addFault
public SOAPFault addFault(Name name, java.lang.String s, java.util.Locale locale) throws SOAPException
Description copied from interface:SOAPBodyCreates a newSOAPFaultobject and adds it to thisSOAPBodyobject. The newSOAPFaultwill have afaultcodeelement that is set to thefaultCodeparameter and afaultstringset tofaultstringand localized tolocale.- Specified by:
addFaultin interfaceSOAPBody- Parameters:
name- aNameobject giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QNames- aStringgiving an explanation of the faultlocale- aLocaleobject indicating the native language of thefaultString - Returns:
- the new
SOAPFaultobject - Throws:
SOAPException- if there is a SOAP error
-
addFault
public SOAPFault addFault(Name name, java.lang.String s) throws SOAPException
Description copied from interface:SOAPBodyCreates a newSOAPFaultobject and adds it to thisSOAPBodyobject. The newSOAPFaultwill have afaultcodeelement that is set to thefaultCodeparameter and afaultstringset tofaultstring.- Specified by:
addFaultin interfaceSOAPBody- Parameters:
name- aNameobject giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification and of type QNames- aStringgiving an explanation of the fault- Returns:
- the new
SOAPFaultobject - Throws:
SOAPException- if there is a SOAP error
-
addDocument
public SOAPBodyElement addDocument(org.w3c.dom.Document document) throws SOAPException
Description copied from interface:SOAPBodyAdds the root node of the DOMDocumentto thisSOAPBodyobject.Calling this method invalidates the
documentparameter. The client application should discard all references to thisDocumentand its contents upon callingaddDocument. The behavior of an application that continues to use such references is undefined.- Specified by:
addDocumentin interfaceSOAPBody- Parameters:
document- theDocumentobject whose root node will be added to thisSOAPBody- Returns:
- the
SOAPBodyElementthat represents the root node that was added - Throws:
SOAPException- if theDocumentcannot be added
-
addFault
public SOAPFault addFault() throws SOAPException
Description copied from interface:SOAPBodyCreates a newSOAPFaultobject and adds it to thisSOAPBodyobject.- Specified by:
addFaultin interfaceSOAPBody- Returns:
- the new
SOAPFaultobject - Throws:
SOAPException- if there is a SOAP error
-
getFault
public SOAPFault getFault()
Description copied from interface:SOAPBodyReturns theSOAPFaultobject in thisSOAPBodyobject.
-
hasFault
public boolean hasFault()
Description copied from interface:SOAPBodyIndicates whether aSOAPFaultobject exists in thisSOAPBodyobject.
-
addChild
public void addChild(MessageElement element) throws SOAPException
Description copied from class:MessageElementNote that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement.- Overrides:
addChildin classMessageElement- Throws:
SOAPException
-
addChildElement
public SOAPElement addChildElement(SOAPElement element) throws SOAPException
Description copied from class:MessageElementThe added child must be an instance of MessageElement rather than an abitrary SOAPElement otherwise a (wrapped) ClassCastException will be thrown.- Specified by:
addChildElementin interfaceSOAPElement- Overrides:
addChildElementin classMessageElement- Parameters:
element- theSOAPElementto 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:MessageElementadd the child element- Specified by:
addChildElementin interfaceSOAPElement- Overrides:
addChildElementin classMessageElement- Parameters:
name- uri, prefix and local name of the element to add- Returns:
- the child element
- Throws:
SOAPException- if there is an error in creating theSOAPElementobject- See Also:
SOAPElement.addChildElement(javax.xml.soap.Name)
-
addChildElement
public SOAPElement addChildElement(java.lang.String localName) throws SOAPException
Description copied from class:MessageElementadd a child element in the message element's own namespace- Specified by:
addChildElementin interfaceSOAPElement- Overrides:
addChildElementin classMessageElement- Parameters:
localName- aStringgiving the local name for the element- Returns:
- the child element
- Throws:
SOAPException- if there is an error in creating theSOAPElementobject- See Also:
SOAPElement.addChildElement(String)
-
addChildElement
public SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix) throws SOAPException
Description copied from class:MessageElementadd a child element- Specified by:
addChildElementin interfaceSOAPElement- Overrides:
addChildElementin classMessageElement- Parameters:
localName- aStringgiving the local name for the new elementprefix- aStringgiving the namespace prefix for the new element- Returns:
- the child element
- Throws:
SOAPException- if there is an error in creating theSOAPElementobject- See Also:
SOAPElement.addChildElement(String, String)
-
addChildElement
public SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri) throws SOAPException
Description copied from class:MessageElementadd a child element- Specified by:
addChildElementin interfaceSOAPElement- Overrides:
addChildElementin classMessageElement- Parameters:
localName- aStringgiving the local name for the new elementprefix- aStringgiving the namespace prefix for the new elementuri- aStringgiving the URI of the namespace to which the new element belongs- Returns:
- the child element
- Throws:
SOAPException- if there is an error in creating theSOAPElementobject- See Also:
SOAPElement.addChildElement(String, String, String)
-
setSAAJEncodingCompliance
public void setSAAJEncodingCompliance(boolean comply)
-
-