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

java.lang.Object
  extended by com.sun.org.apache.xerces.internal.dom.NodeImpl
      extended by com.sun.org.apache.xerces.internal.dom.ChildNode
          extended by com.sun.org.apache.xerces.internal.dom.ParentNode
              extended by com.sun.org.apache.xerces.internal.dom.ElementImpl
                  extended by com.sun.org.apache.xerces.internal.dom.ElementNSImpl
                      extended by com.sun.xml.messaging.saaj.soap.impl.ElementImpl
                          extended by com.sun.xml.messaging.saaj.soap.impl.EnvelopeImpl
All Implemented Interfaces:
Envelope, LazyEnvelope, Serializable, Cloneable, SOAPBodyElement, SOAPElement, SOAPEnvelope, Element, EventTarget, Node, NodeList, TypeInfo
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)
See Also:
Serialized Form

Field Summary
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 class com.sun.org.apache.xerces.internal.dom.ElementNSImpl
localName, namespaceURI
 
Fields inherited from class com.sun.org.apache.xerces.internal.dom.ElementImpl
attributes, name
 
Fields inherited from class com.sun.org.apache.xerces.internal.dom.ParentNode
firstChild, fNodeListCache, ownerDocument
 
Fields inherited from class com.sun.org.apache.xerces.internal.dom.ChildNode
nextSibling, previousSibling
 
Fields inherited from class com.sun.org.apache.xerces.internal.dom.NodeImpl
DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_IS_CONTAINED, DOCUMENT_POSITION_PRECEDING, ELEMENT_DEFINITION_NODE, FIRSTCHILD, flags, HASSTRING, ID, IGNORABLEWS, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED, SYNCCHILDREN, SYNCDATA, TREE_POSITION_ANCESTOR, TREE_POSITION_DESCENDANT, TREE_POSITION_DISCONNECTED, TREE_POSITION_EQUIVALENT, TREE_POSITION_FOLLOWING, TREE_POSITION_PRECEDING, TREE_POSITION_SAME_NODE
 
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
 
Fields inherited from interface org.w3c.dom.TypeInfo
DERIVATION_EXTENSION, DERIVATION_LIST, DERIVATION_RESTRICTION, DERIVATION_UNION
 
Constructor Summary
protected EnvelopeImpl(SOAPDocumentImpl ownerDoc, Name name)
           
protected EnvelopeImpl(SOAPDocumentImpl ownerDoc, NameImpl name, boolean createHeader, boolean createBody)
           
protected EnvelopeImpl(SOAPDocumentImpl ownerDoc, QName name)
           
 
Method Summary
 SOAPBody addBody()
           
 SOAPBody addBody(String prefix)
           
protected  SOAPElement addElement(Name name)
           
protected  SOAPElement addElement(QName name)
           
 SOAPHeader addHeader()
           
 SOAPHeader addHeader(String prefix)
           
 Name createName(String localName)
           
 Name createName(String localName, String prefix)
           
 Name createName(String localName, String prefix, String uri)
           
 SOAPBody getBody()
           
protected abstract  NameImpl getBodyName(String prefix)
           
 Source getContent()
          Get the content as a JAXP Source.
 SOAPHeader getHeader()
           
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)
           
 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, circumventBug5034339, convertToSoapElement, createElement, createElement, createQName, detachNode, doGetNamespacePrefixes, ensureNamespaceIsDeclared, findAndConvertChildElement, findChild, findEncodingStyleAttributeName, getAllAttributes, getAllAttributesAsQNames, getAllAttributesFrom, getAttributeValue, getAttributeValue, getAttributeValueFrom, getChildElementNodes, getChildElements, getChildElements, getChildElements, getChildElementsFrom, getElementName, getElementQName, getEncodingStyle, getLocalPart, getNamespaceAttr, getNamespaceAttrFrom, getNamespaceContextNodes, getNamespaceContextNodes, getNamespacePrefix, getNamespacePrefixes, getNamespaceURI, getOwnerDocument, getParentElement, getPrefix, getQualifiedName, getSOAPNamespace, getValue, getValueNode, getValueNodeStrict, getVisibleNamespacePrefixes, importElement, isNamespaceQualified, isNamespaceQualified, recycleNode, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, replaceElementWithSOAPElement, setAttributeNS, setEncodingStyle, setEncodingStyleNamespace, setParentElement, setValue, tryToFindEncodingStyleAttributeName
 
Methods inherited from class com.sun.org.apache.xerces.internal.dom.ElementNSImpl
getBaseURI, getLocalName, getNamespaceURI, getPrefix, getTypeName, getTypeNamespace, isDerivedFrom, setPrefix, setType, setValues
 
Methods inherited from class com.sun.org.apache.xerces.internal.dom.ElementImpl
cloneNode, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getDefaultAttributes, getElementsByTagName, getElementsByTagNameNS, getNodeName, getNodeType, getSchemaTypeInfo, getTagName, getXercesAttribute, hasAttribute, hasAttributeNS, hasAttributes, isEqualNode, normalize, reconcileDefaultAttributes, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setReadOnly, setupDefaultAttributes, setXercesAttributeNode, synchronizeData
 
Methods inherited from class com.sun.org.apache.xerces.internal.dom.ParentNode
getChildNodes, getChildNodesUnoptimized, getFirstChild, getLastChild, getLength, getTextContent, hasChildNodes, insertBefore, item, removeChild, replaceChild, setTextContent, synchronizeChildren
 
Methods inherited from class com.sun.org.apache.xerces.internal.dom.ChildNode
getNextSibling, getParentNode, getPreviousSibling
 
Methods inherited from class com.sun.org.apache.xerces.internal.dom.NodeImpl
addEventListener, appendChild, changed, changes, compareDocumentPosition, compareTreePosition, dispatchEvent, getContainer, getFeature, getNodeNumber, getNodeValue, getReadOnly, getUserData, getUserData, getUserDataRecord, isDefaultNamespace, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, needsSyncChildren, removeEventListener, setNodeValue, setUserData, setUserData, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, 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
Method Detail

getHeaderName

protected abstract NameImpl getHeaderName(String prefix)

getBodyName

protected abstract NameImpl getBodyName(String prefix)

addHeader

public SOAPHeader addHeader()
                     throws SOAPException
Specified by:
addHeader in interface SOAPEnvelope
Throws:
SOAPException

addHeader

public SOAPHeader addHeader(String prefix)
                     throws SOAPException
Throws:
SOAPException

lookForHeader

protected void lookForHeader()
                      throws SOAPException
Throws:
SOAPException

getHeader

public SOAPHeader getHeader()
                     throws SOAPException
Specified by:
getHeader in interface SOAPEnvelope
Throws:
SOAPException

lookForBody

protected void lookForBody()
                    throws SOAPException
Throws:
SOAPException

addBody

public SOAPBody addBody()
                 throws SOAPException
Specified by:
addBody in interface SOAPEnvelope
Throws:
SOAPException

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
Specified by:
getBody in interface SOAPEnvelope
Throws:
SOAPException

getContent

public Source getContent()
Description copied from interface: Envelope
Get the content as a JAXP Source.

Specified by:
getContent in interface Envelope

createName

public Name createName(String localName,
                       String prefix,
                       String uri)
                throws SOAPException
Specified by:
createName in interface SOAPEnvelope
Throws:
SOAPException

createName

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

createName

public Name createName(String localName)
                throws SOAPException
Specified by:
createName in interface SOAPEnvelope
Throws:
SOAPException

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
Throws:
IOException

output

public void output(OutputStream out,
                   boolean isFastInfoset)
            throws IOException
Serialize to FI if boolean parameter set.

Specified by:
output in interface Envelope
Throws:
IOException

setElementQName

public SOAPElement setElementQName(QName newName)
                            throws SOAPException
Specified by:
setElementQName in interface SOAPElement
Overrides:
setElementQName in class ElementImpl
Throws:
SOAPException

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:
Throws:
SOAPException

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
Returns:
Throws:
SOAPException

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
Returns:
Throws:
SOAPException

isLazy

public boolean isLazy()
Specified by:
isLazy in interface LazyEnvelope


Copyright © 2005-2015 Oracle Corporation. All Rights Reserved.