JavaTM 2 Platform
Standard Ed. 6

javax.xml.soap
介面 SOAPHeaderElement

所有父級介面:
Element, Node, SOAPElement

public interface SOAPHeaderElement
extends SOAPElement

表示 SOAP 信封 SOAP 頭部分的內容的物件。SOAPHeader 物件的直接子級只能用 SOAPHeaderElement 物件的形式表示。

SOAPHeaderElement 物件可以將其他 SOAPElement 物件作為其子級。


欄位摘要
 
從介面 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
 
方法摘要
 String getActor()
          返回此 SOAPHeaderElement actor 屬性的 URL。
 boolean getMustUnderstand()
          返回此 SOAPHeaderElement mustUnderstand 屬性的 boolean 值。
 boolean getRelay()
          返回此 SOAPHeaderElement relay 屬性的 boolean 值。
 String getRole()
          返回此 SOAPHeaderElement Role 屬性的值。
 void setActor(String actorURI)
          將與此 SOAPHeaderElement 物件關聯的 actor 設置為指定 actor。
 void setMustUnderstand(boolean mustUnderstand)
          將此 SOAPHeaderElement 物件的 mustUnderstand 屬性設置為 true 或 false。
 void setRelay(boolean relay)
          將此 SOAPHeaderElementrelay 屬性設置為 true 或 false。
 void setRole(String uri)
          將與此 SOAPHeaderElement 物件關聯的 Role 設置為指定 Role
 
從介面 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
 

方法詳細資訊

setActor

void setActor(String actorURI)
將與此 SOAPHeaderElement 物件關聯的 actor 設置為指定 actor。actor 的預設值為:SOAPConstants.URI_SOAP_ACTOR_NEXT

如果此 SOAPHeaderElement 支持 SOAP 1.2,則此調用等效於 setRole(String)

參數:
actorURI - 給出要設置 actor URI 的 String
拋出:
IllegalArgumentException - 如果在設置 actor 時出現問題。
另請參見:
getActor()

setRole

void setRole(String uri)
             throws SOAPException
將與此 SOAPHeaderElement 物件關聯的 Role 設置為指定 Role

參數:
uri - Role 的 URI
拋出:
SOAPException - 如果在設置 role 時出現錯誤
UnsupportedOperationException - 如果此訊息不支持 SOAP 1.2 定義的 Fault Role。
從以下版本開始:
SAAJ 1.3

getActor

String getActor()
返回此 SOAPHeaderElement actor 屬性的 URL。

如果此 SOAPHeaderElement 支持 SOAP 1.2,則此調用等效於 getRole()

返回:
給出 actor URI 的 String
另請參見:
setActor(java.lang.String)

getRole

String getRole()
返回此 SOAPHeaderElement Role 屬性的值。

返回:
給出 Role URI 的 String
拋出:
UnsupportedOperationException - 如果此訊息不支持 SOAP 1.2 定義的 Fault Role。
從以下版本開始:
SAAJ 1.3

setMustUnderstand

void setMustUnderstand(boolean mustUnderstand)
將此 SOAPHeaderElement 物件的 mustUnderstand 屬性設置為 true 或 false。

如果 mustUnderstand 屬性處於開狀態,則收到 SOAPHeaderElement 的 actor 必須對其進行正確處理。在 SOAPHeaderElement 物件修改訊息的情況下,這可確保訊息能被正確的修改。

參數:
mustUnderstand - 該參數為 true 時,將 mustUnderstand 屬性設置為 true;該參數為 false 時,則將其設置為 false
拋出:
IllegalArgumentException - 如果在設置 mustUnderstand 屬性時出現問題。
另請參見:
getMustUnderstand(), setRelay(boolean)

getMustUnderstand

boolean getMustUnderstand()
返回此 SOAPHeaderElement mustUnderstand 屬性的 boolean 值。

返回:
如果啟用了此 SOAPHeaderElement 物件的 mustUnderstand 屬性,則返回 true;否則返回 false

setRelay

void setRelay(boolean relay)
              throws SOAPException
將此 SOAPHeaderElementrelay 屬性設置為 true 或 false。

SOAP relay 屬性設置為 true 指示 SOAP 頭塊必須通過其指定的所有節點進行中繼,但實際並不處理該頭塊。此屬性在 mustUnderstand 屬性設置為 true 或被最終接收者(預設)指定的頭塊處被忽略。此屬性的預設值為 false

參數:
relay - relay 屬性的新值
拋出:
SOAPException - 如果在設置 relay 屬性時出現問題。
UnsupportedOperationException - 如果此訊息不支持 SOAP 1.2 定義的 Relay 屬性。
從以下版本開始:
SAAJ 1.3
另請參見:
setMustUnderstand(boolean), getRelay()

getRelay

boolean getRelay()
返回此 SOAPHeaderElement relay 屬性的 boolean 值。

返回:
如果 relay 屬性已開啟,則返回 true;否則返回 false
拋出:
UnsupportedOperationException - 如果此訊息不支持 SOAP 1.2 定義的 Relay 屬性。
從以下版本開始:
SAAJ 1.3
另請參見:
getMustUnderstand(), setRelay(boolean)

JavaTM 2 Platform
Standard Ed. 6

提交錯誤或意見

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