概觀  軟體套件   類別  使用  階層樹  已過時  索引  說明 
JavaTM 2 Platform
Standard Ed. 6
 上一個類別   下一個類別 框架    無框架    
摘要： 巢狀 | 欄位 | 建構子 | 方法 詳細資訊： 欄位 | 建構子 | 方法

javax.xml.soap
介面 SOAPHeader

所有父級介面：
Element, Node, SOAPElement
public interface SOAPHeader
extends SOAPElement

SOAP 頭元素的表示形式。SOAP 頭元素由能影響訊息提供者處理特定於應用程序內容的方式的 XML 資料組成。例如，事務語義、驗證資訊等，都可以被指定為 SOAPHeader 物件的內容。

SOAPEnvelope 物件預設包含一個空 SOAPHeader 物件。如果不需要 SOAPHeader 物件（可選），則可以使用以下程式碼行檢索和刪除該物件。變數 se 是一個 SOAPEnvelope 物件。 

se.getHeader().detachNode();
SOAPHeader 物件是使用 SOAPEnvelope 的 addHeader 方法創建的。只有在移除現有的頭之後，才能調用此方法創建新頭並將其添加到信封中。 
se.getHeader().detachNode();
SOAPHeader sh = se.addHeader();

SOAPHeader 物件只能將 SOAPHeaderElement 物件作為其直接子級。方法 addHeaderElement 創建一個新 HeaderElement 物件並將其添加到 SOAPHeader 物件。在以下程式碼行中，方法 addHeaderElement 的參數是一個 Name 物件，該物件是新 HeaderElement 物件的名稱。 

SOAPHeaderElement shElement = sh.addHeaderElement(name);

另請參見：
SOAPHeaderElement

欄位摘要
 
從介面 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
 
方法摘要
 SOAPHeaderElement addHeaderElement(Name name)
          創建使用指定名稱初始化的新的 SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 SOAPHeaderElement addHeaderElement(QName qname)
          創建使用指定 qname 初始化的新的 SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
          創建使用指定名稱初始化的新的 NotUnderstood SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
          創建使用指定的 SOAP URI 支持列表初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
          創建使用指定受支持 SOAP URI 初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
          創建使用指定 SOAP URI 支持陣列初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。
 Iterator examineAllHeaderElements()
          返回可在此 SOAPHeader 物件中所有 SOAPHeaderElement 物件上進行迭代的 Iterator。
 Iterator examineHeaderElements(String actor)
          返回可在此 SOAPHeader 物件中具有指定的 actor 的 SOAPHeaderElement 物件上進行迭代的 Iterator。
 Iterator examineMustUnderstandHeaderElements(String actor)
          返回可在此 SOAPHeader 物件中所有符合以下條件的 SOAPHeaderElement 物件上進行迭代的 Iterator：具有指定的 actor 以及一個值等於 true 的 MustUnderstand 屬性。
 Iterator extractAllHeaderElements()
          返回可在此 SOAPHeader 物件中所有 SOAPHeaderElement 物件上進行迭代的 Iterator，並將這些 SOAPHeaderElement 物件從此 SOAPHeader 物件中分離出來。
 Iterator extractHeaderElements(String actor)
          返回可在此 SOAPHeader 物件中所有具有指定 actor 的 SOAPHeaderElement 物件上進行迭代的 Iterator，並將這些 SOAPHeaderElement 物件從此 SOAPHeader 物件中分離出來。
 
從介面 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
 

方法詳細資訊

addHeaderElement

SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException
創建使用指定名稱初始化的新的 SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。

參數：
name - 帶有新 SOAPHeaderElement 物件名稱的 Name 物件
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤
另請參見：
addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException
創建使用指定 qname 初始化的新的 SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。

參數：
qname - 帶有新 SOAPHeaderElement 物件 qname 的 QName 物件
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤
從以下版本開始：
SAAJ 1.3
另請參見：
addHeaderElement(Name)

examineMustUnderstandHeaderElements

Iterator examineMustUnderstandHeaderElements(String actor)
返回可在此 SOAPHeader 物件中所有符合以下條件的 SOAPHeaderElement 物件上進行迭代的 Iterator：具有指定的 actor 以及一個值等於 true 的 MustUnderstand 屬性。

在 SOAP 1.2 中，env:actor 屬性應替換為 env:role 屬性，但實質上語義是相同的。

參數：
actor - 一個 String，給出要搜尋的 actor/role 的 URI
返回：
一個 Iterator 物件，可在所有符合以下條件的 SOAPHeaderElement 物件上進行迭代：包含指定的 actor / role 並標記為 MustUnderstand
從以下版本開始：
SAAJ 1.2
另請參見：
examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

examineHeaderElements

Iterator examineHeaderElements(String actor)
返回可在此 SOAPHeader 物件中具有指定的 actor 的 SOAPHeaderElement 物件上進行迭代的 Iterator。actor 是一個全體屬性，指示訊息到達其最終接收者之前應對該訊息進行處理的中間參與方。actor 接收並處理訊息，然後將該訊息發送到下一個 actor。預設 actor 是訊息的最終預定接收方，所以如果 SOAPHeader 物件中沒有包括 actor 屬性，那麼 message 將與訊息正文一起發送到最終接收者。

在 SOAP 1.2 中，env:actor 屬性應替換為 env:role 屬性，但實質上語義是相同的。

參數：
actor - 一個 String，給出要搜尋的 actor / role 的 URI
返回：
一個 Iterator 物件，可在所有套件含指定的 actor / role 的 SOAPHeaderElement 物件上進行迭代
另請參見：
extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

Iterator extractHeaderElements(String actor)
返回可在此 SOAPHeader 物件中所有具有指定 actor 的 SOAPHeaderElement 物件上進行迭代的 Iterator，並將這些 SOAPHeaderElement 物件從此 SOAPHeader 物件中分離出來。

此方法允許 actor 處理並移除適用於它的 SOAPHeader 物件部分，然後將該訊息發送到下一個 actor。

在 SOAP 1.2 中，env:actor 屬性應替換為 env:role 屬性，但實質上語義是相同的。

參數：
actor - 一個 String，給出要搜尋的 actor / role 的 URI
返回：
一個 Iterator 物件，可在所有套件含指定 actor / role 的 SOAPHeaderElement 物件上進行迭代
另請參見：
examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                                throws SOAPException
創建使用指定名稱初始化的新的 NotUnderstood SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。只有 SOAP 1.2 支持此操作。

參數：
name - 帶有不可理解的 SOAPHeaderElement 物件名稱的 QName 物件。
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤。
UnsupportedOperationException - 如果這是一個 SOAP 1.1 Header。
從以下版本開始：
SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                          throws SOAPException
創建使用指定的 SOAP URI 支持列表初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。SOAP 1.1 頭和 SOAP 1.2 頭上都支持此操作。

參數：
supportedSOAPURIs - 帶有受支持 SOAP 版本 URI 的 Iterator 物件。
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤。
從以下版本開始：
SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                          throws SOAPException
創建使用指定 SOAP URI 支持陣列初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。SOAP 1.1 頭和 SOAP 1.2 頭上都支持此操作。

參數：
supportedSoapUris - 受支持 SOAP 版本的 URI 陣列
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤。
從以下版本開始：
SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                          throws SOAPException
創建使用指定受支持 SOAP URI 初始化的新的 Upgrade SOAPHeaderElement 物件，並將其添加到此 SOAPHeader 物件。SOAP 1.1 頭和 SOAP 1.2 頭上都支持此操作。

參數：
supportedSoapUri - 受支持 SOAP 版本的 URI。
返回：
插入此 SOAPHeader 物件的新的 SOAPHeaderElement 物件
拋出：
SOAPException - 如果發生 SOAP 錯誤。
從以下版本開始：
SAAJ 1.3

examineAllHeaderElements

Iterator examineAllHeaderElements()
返回可在此 SOAPHeader 物件中所有 SOAPHeaderElement 物件上進行迭代的 Iterator。

返回：
一個 Iterator 物件，可在此 SOAPHeader 物件包含的所有 SOAPHeaderElement 物件上進行迭代
從以下版本開始：
SAAJ 1.2
另請參見：
extractAllHeaderElements()

extractAllHeaderElements

Iterator extractAllHeaderElements()
返回可在此 SOAPHeader 物件中所有 SOAPHeaderElement 物件上進行迭代的 Iterator，並將這些 SOAPHeaderElement 物件從此 SOAPHeader 物件中分離出來。

返回：
一個 Iterator 物件，可在此 SOAPHeader 物件包含的所有 SOAPHeaderElement 物件上進行迭代
從以下版本開始：
SAAJ 1.2
另請參見：
examineAllHeaderElements()
概觀  軟體套件   類別  使用  階層樹  已過時  索引  說明 
JavaTM 2 Platform
Standard Ed. 6
 上一個類別   下一個類別 框架    無框架    
摘要： 巢狀 | 欄位 | 建構子 | 方法 詳細資訊： 欄位 | 建構子 | 方法
提交錯誤或意見

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