javax.xml.soap

Interface SOAPHeader

All Superinterfaces:

Element ， Node ， SOAPElement

public interface SOAPHeader
extends SOAPElement

SOAP头元素的表示。 SOAP头元素由影响消息提供者处理应用程序特定内容的方式的XML数据组成。 例如，可以将事务语义，认证信息等指定为SOAPHeader对象的内容。

默认情况下， SOAPEnvelope对象包含一个空的SOAPHeader对象。 如果SOAPHeader可选的SOAPHeader对象，则可以使用以下代码行检索和删除它。 变量se是一个SOAPEnvelope对象。

  se.getHeader().detachNode(); 

使用SOAPEnvelope方法创建SOAPHeader对象addHeader 。 创建新标题并将其添加到信封的方法只能在现有标题已被删除后才能被调用。

  se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader(); 

一个SOAPHeader对象可以只有SOAPHeaderElement对象作为它的直接子对象。 方法addHeaderElement创建一个新的HeaderElement对象，并将其添加到SOAPHeader对象。 在以下代码行中，方法addHeaderElement的参数是Name对象，它是新的HeaderElement对象的名称。

  SOAPHeaderElement shElement = sh.addHeaderElement(name); 

另请参见：

SOAPHeaderElement

Field Summary

Fields inherited from interface 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

方法摘要

Modifier and Type	Method and Description
SOAPHeaderElement	addHeaderElement(Name name) 创建一个新的 SOAPHeaderElement对象，使用指定的名称初始化，并将其添加到此 SOAPHeader对象。
SOAPHeaderElement	addHeaderElement(QName qname) 创建一个新的 SOAPHeaderElement对象，使用指定的qname初始化并将其添加到此 SOAPHeader对象。
SOAPHeaderElement	addNotUnderstoodHeaderElement(QName name) 创建一个新的NotUnderstood SOAPHeaderElement对象，并使用指定的名称进行初始化，并将其添加到此 SOAPHeader对象。
SOAPHeaderElement	addUpgradeHeaderElement(Iterator supportedSOAPURIs) 创建一个新的升级 SOAPHeaderElement对象，并使用指定的受支持的SOAP URI列表进行初始化，并将其添加到此 SOAPHeader对象。
SOAPHeaderElement	addUpgradeHeaderElement(String supportedSoapUri) 创建一个新的升级 SOAPHeaderElement对象，并使用指定的支持的SOAP URI进行初始化，并将其添加到此 SOAPHeader对象。
SOAPHeaderElement	addUpgradeHeaderElement(String[] supportedSoapUris) 创建一个新的升级 SOAPHeaderElement对象，并使用指定的受支持的SOAP URI数组进行初始化，并将其添加到此 SOAPHeader对象。
Iterator	examineAllHeaderElements() 返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象。
Iterator	examineHeaderElements(String actor) 返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象具有指定 演员 。
Iterator	examineMustUnderstandHeaderElements(String actor) 返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象具有指定 演员 ，有一个mustUnderstand属性，其价值相当于 true 。
Iterator	extractAllHeaderElements() 返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象，并从该中分离出来 SOAPHeader对象。
Iterator	extractHeaderElements(String actor) 返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象中具有指定 的actor并从此中分离出来 SOAPHeader对象。

Methods inherited from interface 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

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface 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 - 一个 Name对象与新的 SOAPHeaderElement对象的名称

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误

另请参见：

addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

SOAPHeaderElement addHeaderElement(QName qname)
                            throws SOAPException

创建一个新的 SOAPHeaderElement对象，使用指定的qname初始化并将其添加到此 SOAPHeader对象。

参数

qname - 一个 QName对象与新的 SOAPHeaderElement对象的qname

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误

从以下版本开始：

SAAJ 1.3

另请参见：

addHeaderElement(Name)

examineMustUnderstandHeaderElements

Iterator examineMustUnderstandHeaderElements(String actor)

返回一个Iterator在所有SOAPHeaderElement这个对象SOAPHeader对象具有指定演员 ，有一个mustUnderstand属性，其价值相当于true 。

在SOAP 1.2中， env：actor属性被env：role属性替换，但语义基本相同。

参数

actor -一个 String赋予的URI actor / role要搜索

结果

一个 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)

返回一个Iterator在所有SOAPHeaderElement这个对象SOAPHeader对象具有指定演员 。 演员是一个全局属性，表示中间方在达到其最终接收者之前应处理消息。 一个演员收到消息并处理它，然后发送给下一个演员。 默认的actor是消息的最终目标接收者，因此如果没有actor属性包含在一个SOAPHeader对象中，它将与消息体一起被发送到最终的接收者。

在SOAP 1.2中， env：actor属性被env：role属性替换，但语义基本相同。

参数

actor -一个 String赋予的URI actor / role要搜索

结果

一个 Iterator对象在所有 SOAPHeaderElement包含指定的对象 actor / role

另请参见：

extractHeaderElements(java.lang.String) ， SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

Iterator extractHeaderElements(String actor)

返回一个Iterator在所有SOAPHeaderElement这个对象SOAPHeader对象中具有指定的actor并从此中分离出来SOAPHeader对象。

此方法允许actor处理适用于它的SOAPHeader对象的部分，并在将消息传递给下一个actor之前将其删除。

在SOAP 1.2中， env：actor属性被env：role属性替换，但语义基本相同。

参数

actor -一个 String赋予的URI actor / role要搜索

结果

一个 Iterator对象在所有 SOAPHeaderElement包含指定的对象 actor / role

另请参见：

examineHeaderElements(java.lang.String) ， SOAPConstants.URI_SOAP_ACTOR_NEXT

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                         throws SOAPException

创建一个新的NotUnderstood SOAPHeaderElement对象，并使用指定的名称进行初始化，并将其添加到此SOAPHeader对象。 此操作仅由SOAP 1.2支持。

参数

name - 一个 QName对象，其名称为未被理解的 SOAPHeaderElement对象。

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误。

UnsupportedOperationException - 如果这是一个SOAP 1.1标头。

从以下版本开始：

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                   throws SOAPException

创建一个新的升级SOAPHeaderElement对象，并使用指定的受支持的SOAP URI列表进行初始化，并将其添加到此SOAPHeader对象。 SOAP 1.1和SOAP 1.2头都支持此操作。

参数

supportedSOAPURIs - 支持SOAP版本的URI的 Iterator对象。

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误。

从以下版本开始：

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                   throws SOAPException

创建一个新的升级SOAPHeaderElement对象，并使用指定的受支持的SOAP URI数组进行初始化，并将其添加到此SOAPHeader对象。 SOAP 1.1和SOAP 1.2头都支持此操作。

参数

supportedSoapUris - 支持的SOAP版本的URI数组。

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误。

从以下版本开始：

SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                   throws SOAPException

创建一个新的升级SOAPHeaderElement对象，并使用指定的支持的SOAP URI进行初始化，并将其添加到此SOAPHeader对象。 SOAP 1.1和SOAP 1.2头都支持此操作。

参数

supportedSoapUri - SOAP的URI版本支持。

结果

新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中

异常

SOAPException - 如果发生SOAP错误。

从以下版本开始：

SAAJ 1.3

examineAllHeaderElements

Iterator examineAllHeaderElements()

返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象。

结果

一个 Iterator对象在所有 SOAPHeaderElement这个包含的对象 SOAPHeader

从以下版本开始：

SAAJ 1.2

另请参见：

extractAllHeaderElements()

extractAllHeaderElements

Iterator extractAllHeaderElements()

返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象，并从该中分离出来 SOAPHeader对象。

结果

一个 Iterator对象在所有 SOAPHeaderElement这个包含的对象 SOAPHeader

从以下版本开始：

SAAJ 1.2

另请参见：

examineAllHeaderElements()