com.sun.xml.messaging.saaj.soap.impl

Class EnvelopeImpl

java.lang.Object

com.sun.xml.messaging.saaj.soap.impl.ElementImpl

com.sun.xml.messaging.saaj.soap.impl.EnvelopeImpl

All Implemented Interfaces:

Envelope, LazyEnvelope, SOAPBodyElement, SOAPElement, SOAPEnvelope, Element, Node

Direct Known Subclasses:

Envelope1_1Impl, Envelope1_2Impl

public abstract class EnvelopeImpl
extends ElementImpl
implements LazyEnvelope

Our implementation of the SOAP envelope.

Author:

Anil Vijendran (anil@sun.com)

Field Summary

Fields

Modifier and Type	Field and Description
protected BodyImpl	body
protected HeaderImpl	header

Fields inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

DSIG_NS, elementQName, log, WSU_NS, XENC_NS, XML_URI, XMLNS_URI

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

Modifier	Constructor and Description
	EnvelopeImpl(SOAPDocumentImpl ownerDoc, Element domElement)
protected	EnvelopeImpl(SOAPDocumentImpl ownerDoc, Name name)
protected	EnvelopeImpl(SOAPDocumentImpl ownerDoc, NameImpl name, boolean createHeader, boolean createBody)
protected	EnvelopeImpl(SOAPDocumentImpl ownerDoc, QName name)

Method Summary

Modifier and Type	Method and Description
SOAPBody	addBody() Creates a SOAPBody object and sets it as the SOAPBody object for this SOAPEnvelope object.
SOAPBody	addBody(String prefix)
protected SOAPElement	addElement(Name name)
protected SOAPElement	addElement(QName name)
SOAPHeader	addHeader() Creates a SOAPHeader object and sets it as the SOAPHeader object for this SOAPEnvelope object.
SOAPHeader	addHeader(String prefix)
Name	createName(String localName) Creates a new Name object initialized with the given local name.
Name	createName(String localName, String prefix)
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.
protected abstract NameImpl	getBodyName(String prefix)
Source	getContent() Get the content as a JAXP Source.
SOAPHeader	getHeader() Returns the SOAPHeader object for this SOAPEnvelope object.
protected abstract NameImpl	getHeaderName(String prefix)
String	getPayloadAttributeValue(QName qName) Retrieve payload attribute value without materializing its contents
String	getPayloadAttributeValue(String localName) Retrieve payload attribute value without materializing its contents
QName	getPayloadQName() Retrieve payload qname without materializing its contents
XMLStreamReader	getPayloadReader()
StaxBridge	getStaxBridge()
boolean	isLazy()
protected void	lookForBody()
protected void	lookForHeader()
void	output(OutputStream out) Output the content.
void	output(OutputStream out, boolean isFastInfoset) Serialize to FI if boolean parameter set.
void	setCharsetEncoding(String value)
SOAPElement	setElementQName(QName newName) Changes the name of this Element to newName if possible.
void	setOmitXmlDecl(String value)
void	setStaxBridge(StaxBridge bridge)
void	setXmlDecl(String value)
void	writeTo(XMLStreamWriter writer)

Methods inherited from class com.sun.xml.messaging.saaj.soap.impl.ElementImpl

addAttribute, addAttribute, addCDATA, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addNode, addText, addTextNode, appendChild, cloneNode, compareDocumentPosition, convertToSoapElement, convertToSoapText, createElement, createElement, createQName, detachNode, doGetNamespacePrefixes, ensureNamespaceIsDeclared, findAndConvertChildElement, findChild, findEncodingStyleAttributeName, getAllAttributes, getAllAttributesAsQNames, getAllAttributesFrom, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getAttributeValueFrom, getBaseURI, getChildElementNodes, getChildElements, getChildElements, getChildElements, getChildElementsFrom, getChildNodes, getDomElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFeature, getFirstChild, getLastChild, getLocalName, getLocalPart, getNamespaceAttr, getNamespaceAttrFrom, getNamespaceContextNodes, getNamespaceContextNodes, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQualifiedName, getSchemaTypeInfo, getSoapDocument, getSOAPNamespace, getTagName, getTextContent, getUserData, getValue, getValueNode, getValueNodeStrict, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, importElement, insertBefore, isDefaultNamespace, isEqualNode, isNamespaceQualified, isNamespaceQualified, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, recycleNode, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, replaceElementWithSOAPElement, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setEncodingStyle, setEncodingStyleNamespace, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setParentElement, setPrefix, setTextContent, setUserData, setValue, tryToFindEncodingStyleAttributeName

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.xml.soap.SOAPElement

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

Field Detail

header

protected HeaderImpl header

body

protected BodyImpl body

Constructor Detail

EnvelopeImpl

protected EnvelopeImpl(SOAPDocumentImpl ownerDoc,
                       Name name)

EnvelopeImpl

protected EnvelopeImpl(SOAPDocumentImpl ownerDoc,
                       QName name)

EnvelopeImpl

protected EnvelopeImpl(SOAPDocumentImpl ownerDoc,
                       NameImpl name,
                       boolean createHeader,
                       boolean createBody)
                throws SOAPException

Throws:

SOAPException

EnvelopeImpl

public EnvelopeImpl(SOAPDocumentImpl ownerDoc,
                    Element domElement)

Method Detail

getHeaderName

protected abstract NameImpl getHeaderName(String prefix)

getBodyName

protected abstract NameImpl getBodyName(String prefix)

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

addHeader

public SOAPHeader addHeader(String prefix)
                     throws SOAPException

Throws:

SOAPException

lookForHeader

protected void lookForHeader()
                      throws SOAPException

Throws:

SOAPException

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

lookForBody

protected void lookForBody()
                    throws SOAPException

Throws:

SOAPException

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

addBody

public SOAPBody addBody(String prefix)
                 throws SOAPException

Throws:

SOAPException

addElement

protected SOAPElement addElement(Name name)
                          throws SOAPException

Overrides:

addElement in class ElementImpl

Throws:

SOAPException

addElement

protected SOAPElement addElement(QName name)
                          throws SOAPException

Overrides:

addElement in class ElementImpl

Throws:

SOAPException

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

getContent

public Source getContent()

Description copied from interface: Envelope

Get the content as a JAXP Source.

Specified by:

getContent in interface Envelope

Returns:

source

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

createName

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

Throws:

SOAPException

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

setOmitXmlDecl

public void setOmitXmlDecl(String value)

setXmlDecl

public void setXmlDecl(String value)

setCharsetEncoding

public void setCharsetEncoding(String value)

output

public void output(OutputStream out)
            throws IOException

Description copied from interface: Envelope

Output the content.

Specified by:

output in interface Envelope

Parameters:

out - output stream.

Throws:

IOException - in case of an I/O error.

output

public void output(OutputStream out,
                   boolean isFastInfoset)
            throws IOException

Serialize to FI if boolean parameter set.

Specified by:

output in interface Envelope

Parameters:

out - output stream

isFastInfoset - true if it is fast infoset.

Throws:

IOException - in case of an I/O error.

setElementQName

public SOAPElement setElementQName(QName newName)
                            throws SOAPException

Description copied from interface: SOAPElement

Changes the name of this Element to newName if possible. SOAP Defined elements such as SOAPEnvelope, SOAPHeader, SOAPBody etc. cannot have their names changed using this method. Any attempt to do so will result in a SOAPException being thrown.

Callers should not rely on the element instance being renamed as is. Implementations could end up copying the content of the SOAPElement to a renamed instance.

Specified by:

setElementQName in interface SOAPElement

Overrides:

setElementQName in class ElementImpl

Parameters:

newName - the new name for the Element.

Returns:

The renamed Node

Throws:

SOAPException - if changing the name of this Element is not allowed.

setStaxBridge

public void setStaxBridge(StaxBridge bridge)
                   throws SOAPException

Specified by:

setStaxBridge in interface Envelope

Throws:

SOAPException

getStaxBridge

public StaxBridge getStaxBridge()
                         throws SOAPException

Specified by:

getStaxBridge in interface Envelope

Throws:

SOAPException

getPayloadReader

public XMLStreamReader getPayloadReader()
                                 throws SOAPException

Specified by:

getPayloadReader in interface LazyEnvelope

Throws:

SOAPException

writeTo

public void writeTo(XMLStreamWriter writer)
             throws XMLStreamException,
                    SOAPException

Specified by:

writeTo in interface LazyEnvelope

Throws:

XMLStreamException

SOAPException

getPayloadQName

public QName getPayloadQName()
                      throws SOAPException

Description copied from interface: LazyEnvelope

Retrieve payload qname without materializing its contents

Specified by:

getPayloadQName in interface LazyEnvelope

Returns:

QName

Throws:

SOAPException - in case of an error

getPayloadAttributeValue

public String getPayloadAttributeValue(String localName)
                                throws SOAPException

Description copied from interface: LazyEnvelope

Retrieve payload attribute value without materializing its contents

Specified by:

getPayloadAttributeValue in interface LazyEnvelope

Parameters:

localName - local name

Returns:

payload attribute value

Throws:

SOAPException - in case of an error

getPayloadAttributeValue

public String getPayloadAttributeValue(QName qName)
                                throws SOAPException

Description copied from interface: LazyEnvelope

Retrieve payload attribute value without materializing its contents

Specified by:

getPayloadAttributeValue in interface LazyEnvelope

Parameters:

qName - QName

Returns:

payload attribute value

Throws:

SOAPException - in case of an error

isLazy

public boolean isLazy()

Specified by:

isLazy in interface LazyEnvelope