org.jboss.ws.core.soap

Class SOAPEnvelopeImpl

java.lang.Object

org.jboss.ws.core.soap.NodeImpl

org.jboss.ws.core.soap.SOAPElementImpl

org.jboss.ws.core.soap.SOAPEnvelopeImpl

All Implemented Interfaces:

SOAPElement, SOAPEnvelope, Element, Node

public class SOAPEnvelopeImpl
extends SOAPElementImpl
implements SOAPEnvelope

The container for the SOAPHeader and SOAPBody portions of a SOAPPart object. By default, a SOAPMessage object is created with a SOAPPart object that has a SOAPEnvelope object. The SOAPEnvelope object by default has an empty SOAPBody object and an empty SOAPHeader object. The SOAPBody object is required, and the SOAPHeader object, though optional, is used in the majority of cases.

Author:

Thomas.Diesler@jboss.org

Field Summary

Fields inherited from class org.jboss.ws.core.soap.NodeImpl

domNode, soapParent

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 and Description
SOAPEnvelopeImpl(SOAPPartImpl soapPart, SOAPElementImpl element, boolean addHeaderAndBody) Construct a SOAP envelope for the given SOAP version URI prefix, etc.

Method Summary

Methods

Modifier and Type	Method and Description
SOAPElement	addAttribute(Name name, String value) Adds an attribute with the specified name and value to this SOAPElement object.
SOAPBody	addBody() Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.
SOAPElement	addChildElement(SOAPElement child) Make sure the child is either a SOAPHeader or SOAPBody
SOAPHeader	addHeader() Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.
SOAPElement	addTextNode(String value) Text nodes are not supported.
Name	createName(String localName) Creates a new Name object initialized with the given local name.
Name	createName(String localName, String prefix, String uri) Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.
SOAPBody	getBody() Returns the SOAPBody object associated with this SOAPEnvelope object.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
Document	getOwnerDocument()
SOAPMessage	getSOAPMessage()

Methods inherited from class org.jboss.ws.core.soap.SOAPElementImpl

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, createQName, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChildElementByLocalName, getNamespacePrefixes, getNamespaceURI, getSchemaTypeInfo, getSOAPEnvelope, getTagName, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setElementQNameInternal, setEncodingStyle, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setPrefix, writeElement, writeElementContent

Methods inherited from class org.jboss.ws.core.soap.NodeImpl

appendChild, cloneNode, compareDocumentPosition, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, getValue, hasAttributes, hasChildNodes, hashCode, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeChild, replaceChild, setNodeValue, setParentElement, setTextContent, setUserData, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, 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, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Constructor Detail

SOAPEnvelopeImpl

public SOAPEnvelopeImpl(SOAPPartImpl soapPart,
                SOAPElementImpl element,
                boolean addHeaderAndBody)
                 throws SOAPException

Construct a SOAP envelope for the given SOAP version URI prefix, etc.

Throws:

SOAPException

Method Detail

getSOAPMessage

public SOAPMessage getSOAPMessage()

addBody

public SOAPBody addBody()
                 throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.

It is illegal to add a body when the envelope already contains a body. Therefore, this method should be called only after the existing body has been removed.

Specified by:

addBody in interface SOAPEnvelope

Returns:

the new SOAPBody object

Throws:

SOAPException - if this SOAPEnvelope object already contains a valid SOAPBody object

addHeader

public SOAPHeader addHeader()
                     throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.

It is illegal to add a header when the envelope already contains a header. Therefore, this method should be called only after the existing header has been removed.

Specified by:

addHeader in interface SOAPEnvelope

Returns:

the new SOAPHeader object

Throws:

SOAPException - if this SOAPEnvelope object already contains a valid SOAPHeader object

addAttribute

public SOAPElement addAttribute(Name name,
                       String value)
                         throws SOAPException

Description copied from class: SOAPElementImpl

Adds an attribute with the specified name and value to this SOAPElement object.

Specified by:

addAttribute in interface SOAPElement

Overrides:

addAttribute in class SOAPElementImpl

Parameters:

name - a Name object with the name of the attribute

value - a String giving the value of the attribute

Returns:

the SOAPElement object into which the attribute was inserted

Throws:

SOAPException - if there is an error in creating the Attribute, or it is invalid to set an attribute with Name name on this SOAPElement.

See Also:

SOAPElement.addAttribute(javax.xml.namespace.QName, String)

addChildElement

public SOAPElement addChildElement(SOAPElement child)
                            throws SOAPException

Make sure the child is either a SOAPHeader or SOAPBody

Specified by:

addChildElement in interface SOAPElement

Overrides:

addChildElement in class SOAPElementImpl

Parameters:

child - 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

createName

public Name createName(String localName)
                throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a new Name object initialized with the given local name.

This factory method creates Name objects for use in the SOAP/XML document.

Specified by:

createName in interface SOAPEnvelope

Parameters:

localName - a String giving the local name

Returns:

a Name object initialized with the given local name

Throws:

SOAPException - if there is a SOAP error

createName

public Name createName(String localName,
              String prefix,
              String uri)
                throws SOAPException

Description copied from interface: SOAPEnvelope

Creates a new Name object initialized with the given local name, namespace prefix, and namespace URI.

This factory method creates Name objects for use in the SOAP/XML document.

Specified by:

createName in interface SOAPEnvelope

Parameters:

localName - a String giving the local name

prefix - a String giving the prefix of the namespace

uri - a String giving the URI of the namespace

Returns:

a Name object initialized with the given local name, namespace prefix, and namespace URI

Throws:

SOAPException - if there is a SOAP error

getBody

public SOAPBody getBody()
                 throws SOAPException

Description copied from interface: SOAPEnvelope

Returns the SOAPBody object associated with this SOAPEnvelope object.

A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPBody object. As a result, the method getBody will always return a SOAPBody object unless the body has been removed and a new one has not been added.

Specified by:

getBody in interface SOAPEnvelope

Returns:

the SOAPBody object for this SOAPEnvelope object or null if there is none

Throws:

SOAPException - if there is a problem obtaining the SOAPBody object

getHeader

public SOAPHeader getHeader()
                     throws SOAPException

Description copied from interface: SOAPEnvelope

Returns the SOAPHeader object for this SOAPEnvelope object.

A new SOAPMessage object is by default created with a SOAPEnvelope object that contains an empty SOAPHeader object. As a result, the method getHeader will always return a SOAPHeader object unless the header has been removed and a new one has not been added.

Specified by:

getHeader in interface SOAPEnvelope

Returns:

the SOAPHeader object or null if there is none

Throws:

SOAPException - if there is a problem obtaining the SOAPHeader object

addTextNode

public SOAPElement addTextNode(String value)
                        throws SOAPException

Text nodes are not supported.

Specified by:

addTextNode in interface SOAPElement

Overrides:

addTextNode in class SOAPElementImpl

Parameters:

value - a String object with the textual content to be added

Returns:

the SOAPElement object into which the new Text object was inserted

Throws:

SOAPException - if there is an error in creating the new Text object or if it is not legal to attach it as a child to this SOAPElement

getOwnerDocument

public Document getOwnerDocument()

Specified by:

getOwnerDocument in interface Node

Overrides:

getOwnerDocument in class NodeImpl