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 SOAPBodyElement
addBodyElement(Name name)
Creates a newSOAPBodyElement
object with the specified name and adds it to thisSOAPBody
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(java.lang.String localName)
add a child element in the message element's own namespaceSOAPElement
addChildElement(java.lang.String localName, java.lang.String prefix)
add a child elementSOAPElement
addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri)
add a child elementSOAPElement
addChildElement(Name name)
add the child elementSOAPElement
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(org.w3c.dom.Document document)
Adds the root node of the DOMDocument
to thisSOAPBody
object.SOAPFault
addFault()
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(Name name, java.lang.String s)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.SOAPFault
addFault(Name name, java.lang.String s, java.util.Locale locale)
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.void
disableFormatting()
SOAPFault
getFault()
Returns theSOAPFault
object in thisSOAPBody
object.boolean
hasFault()
Indicates whether aSOAPFault
object exists in thisSOAPBody
object.protected void
outputImpl(SerializationContext context)
override point -output to a serialization context.void
setEncodingStyle(java.lang.String encodingStyle)
Sets the encoding style for thisSOAPElement
object to one specified.void
setParentElement(SOAPElement parent)
Sets the parent of thisNode
object to the givenSOAPElement
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 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:NodeImpl
Sets the parent of thisNode
object to the givenSOAPElement
object.- Specified by:
setParentElement
in interfaceNode
- Overrides:
setParentElement
in classNodeImpl
- Parameters:
parent
- theSOAPElement
object to be set as the parent of thisNode
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(java.lang.String encodingStyle) throws SOAPException
Description copied from class:MessageElement
Sets the encoding style for thisSOAPElement
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 interfaceSOAPElement
- Overrides:
setEncodingStyle
in classMessageElement
- Parameters:
encodingStyle
- aString
giving the encoding style- Throws:
SOAPException
- See Also:
getEncodingStyle()
-
outputImpl
protected void outputImpl(SerializationContext context) throws java.lang.Exception
Description copied from class:MessageElement
override point -output to a serialization context.- Overrides:
outputImpl
in classMessageElement
- Parameters:
context
- destination.- Throws:
java.lang.Exception
- if something went wrong.
-
addBodyElement
public SOAPBodyElement addBodyElement(Name name) throws SOAPException
Description copied from interface:SOAPBody
Creates a newSOAPBodyElement
object with the specified name and adds it to thisSOAPBody
object.- Specified by:
addBodyElement
in interfaceSOAPBody
- Parameters:
name
- aName
object with the name for the newSOAPBodyElement
object- Returns:
- the new
SOAPBodyElement
object - 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:SOAPBody
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The newSOAPFault
will have afaultcode
element that is set to thefaultCode
parameter and afaultstring
set tofaultstring
and localized tolocale
.- Specified by:
addFault
in interfaceSOAPBody
- Parameters:
name
- aName
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 QNames
- aString
giving an explanation of the faultlocale
- aLocale
object indicating the native language of thefaultString - Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error
-
addFault
public SOAPFault addFault(Name name, java.lang.String s) throws SOAPException
Description copied from interface:SOAPBody
Creates a newSOAPFault
object and adds it to thisSOAPBody
object. The newSOAPFault
will have afaultcode
element that is set to thefaultCode
parameter and afaultstring
set tofaultstring
.- Specified by:
addFault
in interfaceSOAPBody
- Parameters:
name
- aName
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 QNames
- aString
giving an explanation of the fault- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error
-
addDocument
public SOAPBodyElement addDocument(org.w3c.dom.Document document) throws SOAPException
Description copied from interface:SOAPBody
Adds the root node of the DOMDocument
to thisSOAPBody
object.Calling this method invalidates the
document
parameter. The client application should discard all references to thisDocument
and its contents upon callingaddDocument
. The behavior of an application that continues to use such references is undefined.- Specified by:
addDocument
in interfaceSOAPBody
- Parameters:
document
- theDocument
object whose root node will be added to thisSOAPBody
- Returns:
- the
SOAPBodyElement
that represents the root node that was added - Throws:
SOAPException
- if theDocument
cannot be added
-
addFault
public SOAPFault addFault() throws SOAPException
Description copied from interface:SOAPBody
Creates a newSOAPFault
object and adds it to thisSOAPBody
object.- Specified by:
addFault
in interfaceSOAPBody
- Returns:
- the new
SOAPFault
object - Throws:
SOAPException
- if there is a SOAP error
-
getFault
public SOAPFault getFault()
Description copied from interface:SOAPBody
Returns theSOAPFault
object in thisSOAPBody
object.
-
hasFault
public boolean hasFault()
Description copied from interface:SOAPBody
Indicates whether aSOAPFault
object exists in thisSOAPBody
object.
-
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 classMessageElement
- 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 interfaceSOAPElement
- Overrides:
addChildElement
in classMessageElement
- Parameters:
element
- theSOAPElement
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 interfaceSOAPElement
- Overrides:
addChildElement
in 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 theSOAPElement
object- See Also:
SOAPElement.addChildElement(javax.xml.soap.Name)
-
addChildElement
public SOAPElement addChildElement(java.lang.String localName) throws SOAPException
Description copied from class:MessageElement
add a child element in the message element's own namespace- Specified by:
addChildElement
in interfaceSOAPElement
- Overrides:
addChildElement
in classMessageElement
- Parameters:
localName
- aString
giving the local name for the element- Returns:
- the child element
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object- See Also:
SOAPElement.addChildElement(String)
-
addChildElement
public SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix) throws SOAPException
Description copied from class:MessageElement
add a child element- Specified by:
addChildElement
in interfaceSOAPElement
- Overrides:
addChildElement
in classMessageElement
- Parameters:
localName
- aString
giving the local name for the new elementprefix
- aString
giving the namespace prefix for the new element- Returns:
- the child element
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object- 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:MessageElement
add a child element- Specified by:
addChildElement
in interfaceSOAPElement
- Overrides:
addChildElement
in classMessageElement
- Parameters:
localName
- aString
giving the local name for the new elementprefix
- aString
giving the namespace prefix for the new elementuri
- aString
giving the URI of the namespace to which the new element belongs- Returns:
- the child element
- Throws:
SOAPException
- if there is an error in creating theSOAPElement
object- See Also:
SOAPElement.addChildElement(String, String, String)
-
setSAAJEncodingCompliance
public void setSAAJEncodingCompliance(boolean comply)
-
-