javax.xml.soap

接口
类
异常

javax.xml.soap
接口 SOAPBody

所有超级接口：
Element, Node, SOAPElement 
public interface SOAPBody
     

      extends 
      SOAPElement

表示 SOAP 消息中 SOAP 正文元素内容的对象。SOAP 正文元素由能影响特定于应用程序内容的处理方式的 XML 数据组成。

SOAPBody 对象包含了 SOAPBodyElement 对象，后者具有 SOAP 正文的内容。携带状态和/或错误信息的 SOAPFault 对象是 SOAPBodyElement 对象的一个示例。

另请参见：
SOAPFault

字段摘要
 
从接口 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
 
方法摘要
 SOAPBodyElement addBodyElement(Name name)
          使用指定名称创建新的 SOAPBodyElement 对象，并将其添加到此 SOAPBody 对象。
 SOAPBodyElement addBodyElement(QName 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()
          指示此 SOAPBody 对象中是否存在 SOAPFault 对象。
 
从接口 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
 
从接口 javax.xml.soap.Node 继承的方法
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
 
从接口 org.w3c.dom.Element 继承的方法
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
从接口 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 会将强制性 (mandatory) 子元素设置为默认值。 SOAPFault 的类型可以是 SOAP 1.1 或 SOAP 1.2 SOAPFault，这取决于创建 MessageFactory 实例时指定的 protocol。

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

返回：
新的 SOAPFault 对象
抛出：
SOAPException - 如果存在 SOAP 错误

addFault

SOAPFault addFault(Name faultCode,
                   String faultString,
                   Locale locale)
                   throws SOAPException
创建新的 SOAPFault 对象，并将其添加到此 SOAPBody 对象。 SOAPFault 的类型可以是 SOAP 1.1 或 SOAP 1.2 SOAPFault，这取决于创建 MessageFactory 实例时指定的 protocol。

对于 SOAP 1.2，faultCode 参数是 Fault/Code/Value 元素的值，faultString 参数是 Fault/Reason/Text 元素的值。对于 SOAP 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 的类型可以是 SOAP 1.1 或 SOAP 1.2 SOAPFault，这取决于创建 MessageFactory 实例时指定的 protocol。

对于 SOAP 1.2，faultCode 参数是 Fault/Code/Value 元素的值，faultString 参数是 Fault/Reason/Text 元素的值。对于 SOAP 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 的类型可以是 SOAP 1.1 或 SOAP 1.2 SOAPFault，这取决于创建 MessageFactory 实例时指定的 protocol。

对于 SOAP 1.2，faultCode 参数是 Fault/Code/Value 元素的值，faultString 参数是 Fault/Reason/Text 元素的值。对于 SOAP 1.1，faultCode 参数是 faultcode 元素的值，faultString 参数是 faultstring 元素的值。

如果是 SOAP 1.2 错误，Fault/Reason/Text 元素上强制性 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 的类型可以是 SOAP 1.1 或 SOAP 1.2 SOAPFault，这取决于创建 MessageFactory 实例时指定的 protocol。

对于 SOAP 1.2，faultCode 参数是 Fault/Code/Value 元素的值，faultString 参数是 Fault/Reason/Text 元素的值。对于 SOAP 1.1，faultCode 参数是 faultcode 元素的值，faultString 参数是 faultstring 元素的值。

如果是 SOAP 1.2 错误，Fault/Reason/Text 元素上强制性 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()
指示此 SOAPBody 对象中是否存在 SOAPFault 对象。

返回：
如果此 SOAPBody 对象中存在 SOAPFault 对象，则返回 true；否则返回 false

getFault

SOAPFault getFault()
返回此 SOAPBody 对象中的 SOAPFault 对象。

返回：
此 SOAPBody 对象中的 SOAPFault 对象（如果存在）；若不存在，则返回 null。

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
使用指定 QName 创建新的 SOAPBodyElement 对象，并将其添加到此 SOAPBody 对象。

参数：
qname - QName 对象，带有新 SOAPBodyElement 对象的名称
返回：
新的 SOAPBodyElement 对象
抛出：
SOAPException - 如果发生 SOAP 错误
从以下版本开始：
SAAJ 1.3
另请参见：
addBodyElement(Name)

addDocument

SOAPBodyElement addDocument(Document document)
                            throws SOAPException
将 DOM Document 的根节点添加到此 SOAPBody 对象。

调用此方法会使 document 参数失效。在调用 addDocument 时，客户端应用程序应丢弃所有对此 Document 及其内容的引用。继续使用此类引用的应用程序将产生不确定的行为。

参数：
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