javax.xml.soap

Interface SOAPEnvelope

All Superinterfaces:

Element， Node， SOAPElement

public interface SOAPEnvelope
extends SOAPElement

为soapheader和一 SOAPPart配糖体部分的容器对象。默认情况下，一个 SOAPMessage对象与一个 SOAPPart对象有一个 SOAPEnvelope对象创建。默认情况下， SOAPEnvelope对象有一个空的 SOAPBody对象和一个空的 SOAPHeader对象。的 SOAPBody对象是必需的，而 SOAPHeader对象，虽然是可选的，在大多数情况下使用。如果 SOAPHeader对象是不需要的，它可以被删除，这表明。

客户端可以通过调用方法SOAPEnvelope.getHeader和SOAPEnvelope.getBody访问SOAPHeader和SOAPBody对象。下面的代码使用这两种方法开始与SOAPMessage对象消息得到SOAPPart服务提供商对象后，然后用得到的SOAPEnvelope对象东南方。

soappart SP =消息。getsoappart()；soapenvelope SE = sp. getenvelope()；soapheader SH = getheader() SE；某人getbody()配糖体本身；

它可以通过检索当前，改变一个SOAPEnvelope对象身体或头部删除它，然后添加一个新的身体或头。的javax.xml.soap.Node方法deleteNode删除XML元素（节点），它被称为。例如，以下代码行删除的方法getBody检索对象的SOAPBody。

硒。getbody()。detachnode()；

创造 SOAPHeader对象来代替被删除的一个，客户端使用方法 SOAPEnvelope.addHeader，创建一个新的头，将它添加到 SOAPEnvelope对象。同样，该方法 addBody创建一个新的 SOAPBody对象并将其添加到 SOAPEnvelope对象。下面的代码片段检索当前标题，删除它，并添加一个新的。然后它检索当前的身体，移除它，并添加一个新的。这是一个错误

soappart SP =消息。getsoappart()；soapenvelope SE = sp. getenvelope()；硒。getheader()。detachnode()；soapheader SH = addheader() SE；硒。getbody()。detachnode()；某人addbody()配糖体本身；

添加 SOAPBody或 SOAPHeader如果一个已经存在的对象。

的SOAPEnvelope接口提供了用于创建对象的三种方法Name。一个方法创建Name对象与本地名称、命名空间前缀，和namesapce URI。第二方法创建Name对象与本地名称和命名空间前缀，和第三创建Name对象只是一个地方的名字。下面这行代码，其中东南方是SOAPEnvelope对象，创建一个新的所有三Name对象。

名称= SE。createname（“getlasttradeprice”、“袋熊”，“HTTP：/ / www.wombat。org /贸易商”）；

Field Summary

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

方法摘要

Modifier and Type	Method and Description
SOAPBody	addBody() 创建一个 SOAPBody对象并设置为这个 SOAPEnvelope对象的 SOAPBody对象。
SOAPHeader	addHeader() 创建一个 SOAPHeader对象并设置为这个 SOAPEnvelope对象的 SOAPHeader对象。
Name	createName(String localName) 创建一个新的 Name对象与给定的本地名称初始化。
Name	createName(String localName, String prefix, String uri) 创建一个新的 Name对象与给定的本地名称和命名空间URI命名空间前缀初始化。
SOAPBody	getBody() 返回与此 SOAPEnvelope对象相关的 SOAPBody对象。
SOAPHeader	getHeader() 返回该对象的对象 SOAPEnvelope SOAPHeader。

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, 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, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

方法详细信息

createName

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

创建一个新的 Name对象与给定的本地名称和命名空间URI命名空间前缀初始化。

这个工厂方法创建用于SOAP / XML文档Name对象。

参数

localName - String给本地名称

prefix - String给命名空间的前缀

uri - String给命名空间的URI

结果

一个 Name对象初始化与给定的本地名称和命名空间URI命名空间前缀，

异常

SOAPException -如果有一个SOAP错误

createName

Name createName(String localName)
         throws SOAPException

创建一个新的 Name对象与给定的本地名称初始化。

这个工厂方法创建用于SOAP / XML文档Name对象。

参数

localName - String给本地名称

结果

一个 Name对象初始化与给定的本地名称

异常

SOAPException -如果有一个SOAP错误

getHeader

SOAPHeader getHeader()
              throws SOAPException

返回该对象的对象 SOAPEnvelope SOAPHeader。

一个新的SOAPMessage对象由一SOAPEnvelope对象包含一个空的SOAPHeader对象创建的默认。因此，该方法getHeader将总是返回一个SOAPHeader对象除非头已被删除，新的尚未添加。

结果

的 SOAPHeader对象或 null如果没有

异常

SOAPException -如果有一个问题得到 SOAPHeader对象

getBody

SOAPBody getBody()
          throws SOAPException

返回与此 SOAPEnvelope对象相关的 SOAPBody对象。

一个新的SOAPMessage对象由一SOAPEnvelope对象包含一个空的SOAPBody对象创建的默认。因此，该方法getBody将总是返回一个SOAPBody对象除非身体已被删除，新的尚未添加。

结果

这 SOAPEnvelope对象或 null的 SOAPBody对象如果没有

异常

SOAPException -如果有一个问题得到 SOAPBody对象

addHeader

SOAPHeader addHeader()
              throws SOAPException

创建一个 SOAPHeader对象并设置为这个 SOAPEnvelope对象的 SOAPHeader对象。

在信封已经包含头文件时添加头文件是非法的。因此，只有在现有的头已被删除后，这种方法才应该被调用。

结果

新 SOAPHeader对象

异常

SOAPException -如果这 SOAPEnvelope对象已包含一个有效的 SOAPHeader对象

addBody

SOAPBody addBody()
          throws SOAPException

创建一个 SOAPBody对象并设置为这个 SOAPEnvelope对象的 SOAPBody对象。

在信封已经包含了一个物体时，添加一个物体是非法的。因此，这种方法应该被称为只有在现有的身体已被删除。

结果

新 SOAPBody对象

异常

SOAPException -如果这 SOAPEnvelope对象已包含一个有效的 SOAPBody对象