JavaTM 2 Platform
Standard Ed. 6

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

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

版權所有 2008 Sun Microsystems, Inc. 保留所有權利。請遵守GNU General Public License, version 2 only