javax.xml.soap

Interface SOAPBody

All Superinterfaces:

Element， Node， SOAPElement

public interface SOAPBody
extends SOAPElement

表示在一个肥皂消息中的皂体元素的内容的对象。一个SOAP体元素由影响应用程序特定内容的方式处理的XML数据组成。

一个SOAPBody对象包含SOAPBodyElement对象，这对皂体的含量。一个SOAPFault对象，进行和/或错误信息的状态，是一个SOAPBodyElement对象实例。

另请参见：

SOAPFault

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
SOAPBodyElement	addBodyElement(Name name) 创建一个新的具有指定名称的 SOAPBodyElement对象并将其添加到这个 SOAPBody对象。
SOAPBodyElement	addBodyElement(QName qname) 创建一个新的具有指定属性 SOAPBodyElement对象并将其添加到这个 SOAPBody对象。
SOAPBodyElement	addDocument(Document document) 添加DOM Document根节点到这 SOAPBody对象。
SOAPFault	addFault() 创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。
SOAPFault	addFault(Name faultCode, String faultString) 创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。
SOAPFault	addFault(Name faultCode, String faultString, Locale locale) 创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。
SOAPFault	addFault(QName faultCode, String faultString) 创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。
SOAPFault	addFault(QName faultCode, String faultString, Locale locale) 创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。
Document	extractContentAsDocument() 创建一个新的DOM Document和本 SOAPBody第一个子集作为它的文档元素。
SOAPFault	getFault() 在这 SOAPBody返回对象的 SOAPFault对象。
boolean	hasFault() 指示 SOAPFault对象存在于这个 SOAPBody对象。

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

方法详细信息

addFault

SOAPFault addFault()
            throws SOAPException

创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。新 SOAPFault将默认值设置为强制性的子元素。该 SOAPFault类型将肥皂或香皂1.1 1.2 SOAPFault取决于 protocol指定在创建 MessageFactory实例。

一个SOAPBody最多只能包含一SOAPFault子元素。

结果

新 SOAPFault对象

异常

SOAPException -如果有一个SOAP错误

addFault

SOAPFault addFault(Name faultCode,
                   String faultString,
                   Locale locale)
            throws SOAPException

创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。该 SOAPFault类型将肥皂或香皂1.1 1.2 SOAPFault根据指定在创建 MessageFactory实例的 protocol。

肥皂1.2 faultCode参数的故障/代码/价值元素的值和faultString参数的故障/原因/文本元素的值。肥皂1.1 faultCode参数的faultcode元素的值和faultString参数的faultstring元素的值。

一个SOAPBody最多只能包含一SOAPFault子元素。

参数

faultCode - Name对象给出故障代码进行设置；必须有一个在使用SOAP规范的版本定义的故障码

faultString - String给出故障解释

locale - Locale对象表示的 faultString母语

结果

新 SOAPFault对象

异常

SOAPException -如果有一个SOAP错误

从以下版本开始：

SAAJ 1.2

另请参见：

SOAPFault.setFaultCode(javax.xml.soap.Name)， SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault addFault(QName faultCode,
                   String faultString,
                   Locale locale)
            throws SOAPException

创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。该 SOAPFault类型将肥皂或香皂1.1 1.2 SOAPFault根据指定在创建 MessageFactory实例的 protocol。

肥皂1.2 faultCode参数的故障/代码/价值元素的值和faultString参数的故障/原因/文本元素的值。肥皂1.1 faultCode参数的faultcode元素的值和faultString参数的faultstring元素的值。

一个SOAPBody最多只能包含一SOAPFault子元素。

参数

faultCode - QName对象给出故障代码进行设置；必须有一个在使用SOAP规范的版本定义的故障码。

faultString - String给出故障解释

locale - Locale对象表示的 faultString母语

结果

新 SOAPFault对象

异常

SOAPException -如果有一个SOAP错误

从以下版本开始：

SAAJ 1.3

另请参见：

SOAPFault.setFaultCode(javax.xml.soap.Name)， SOAPFault.setFaultString(java.lang.String)， addFault(Name faultCode, String faultString, Locale locale)

addFault

SOAPFault addFault(Name faultCode,
                   String faultString)
            throws SOAPException

创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。该 SOAPFault类型将肥皂或香皂1.1 1.2 SOAPFault根据指定在创建 MessageFactory实例的 protocol。

肥皂1.2 faultCode参数的故障/代码/价值元素的值和faultString参数的故障/原因/文本元素的值。肥皂1.1 faultCode参数的故障代码元素的值和faultString参数的faultstring元素的值。

在SOAP 1.2故障的情况下，在故障/原因/文本元强制性xml:lang属性的默认值将被设置为java.util.Locale.getDefault()

一个SOAPBody最多只能包含一SOAPFault子元素。

参数

faultCode - Name对象给出故障代码进行设置；必须有一个在使用SOAP规范的版本定义的故障码

faultString - String给出故障解释

结果

新 SOAPFault对象

异常

SOAPException -如果有一个SOAP错误

从以下版本开始：

SAAJ 1.2

另请参见：

SOAPFault.setFaultCode(javax.xml.soap.Name)， SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault addFault(QName faultCode,
                   String faultString)
            throws SOAPException

创建一个新的 SOAPFault对象并将其添加到这个 SOAPBody对象。该 SOAPFault类型将肥皂或香皂1.1 1.2 SOAPFault根据指定在创建 MessageFactory实例的 protocol。

肥皂1.2 faultCode参数的故障/代码/价值元素的值和faultString参数的故障/原因/文本元素的值。肥皂1.1 faultCode参数的故障代码元素的值和faultString参数的faultstring元素的值。

在SOAP 1.2故障的情况下，在故障/原因/文本元强制性xml:lang属性的默认值将被设置为java.util.Locale.getDefault()

一个SOAPBody最多只能包含一SOAPFault子元素

参数

faultCode - QName对象给出故障代码进行设置；必须有一个在使用SOAP规范的版本定义的故障码

faultString - String给出故障解释

结果

新 SOAPFault对象

异常

SOAPException -如果有一个SOAP错误

从以下版本开始：

SAAJ 1.3

另请参见：

SOAPFault.setFaultCode(javax.xml.soap.Name)， SOAPFault.setFaultString(java.lang.String)， addFault(Name faultCode, String faultString)

hasFault

boolean hasFault()

指示 SOAPFault对象存在于这个 SOAPBody对象。

结果

true如果 SOAPFault对象存在于这个 SOAPBody对象； false否则

getFault

SOAPFault getFault()

在这 SOAPBody返回对象的 SOAPFault对象。

结果

的 SOAPFault对象在这 SOAPBody对象如果存在，否则无效。

addBodyElement

SOAPBodyElement addBodyElement(Name name)
                        throws SOAPException

创建一个新的具有指定名称的 SOAPBodyElement对象并将其添加到这个 SOAPBody对象。

参数

name -一个叫 Name对象为新 SOAPBodyElement对象

结果

新 SOAPBodyElement对象

异常

SOAPException如果SOAP错误发生

另请参见：

addBodyElement(javax.xml.namespace.QName)

addBodyElement

SOAPBodyElement addBodyElement(QName qname)
                        throws SOAPException

创建一个新的具有指定属性 SOAPBodyElement对象并将其添加到这个 SOAPBody对象。

参数

qname -一种新的 SOAPBodyElement对象将 QName对象

结果

新 SOAPBodyElement对象

异常

SOAPException如果SOAP错误发生

从以下版本开始：

SAAJ 1.3

另请参见：

addBodyElement(Name)

addDocument

SOAPBodyElement addDocument(Document document)
                     throws SOAPException

添加DOM Document根节点到这 SOAPBody对象。

调用此方法无效的document参数。客户端应用程序应该抛弃所有引用这Document及其内容addDocument召唤。继续使用这些引用的应用程序的行为是不确定的。

参数

document - Document对象的根节点将被添加到该 SOAPBody。

结果

表示根节点被添加的 SOAPBodyElement。

异常

SOAPException -如果 Document不能添加

从以下版本开始：

SAAJ 1.2

extractContentAsDocument

Document extractContentAsDocument()
                           throws SOAPException

创建一个新的DOM Document和本 SOAPBody第一个子集作为它的文档元素。孩子 SOAPElement是作为过程的一部分删除。

结果

该 SOAPBody含量 Document表示。

异常

SOAPException -如果没有一个孩子的 SOAPBody. SOAPElement

从以下版本开始：

SAAJ 1.3