JavaTM 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 Platform
Standard Ed. 6

提交错误或意见
有关更多的 API 参考资料和开发人员文档,请参阅 Java SE 开发人员文档。该文档包含更详细的、面向开发人员的描述,以及总体概述、术语定义、使用技巧和工作代码示例。

版权所有 2007 Sun Microsystems, Inc. 保留所有权利。 请遵守许可证条款。另请参阅文档重新分发政策