javax.xml.soap
接口 SOAPHeader

所有超级接口：

Element, Node, SOAPElement

public interface SOAPHeader
     

      extends 
      SOAPElement
     

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

SOAPEnvelope 对象默认包含一个空 SOAPHeader 对象。如果不需要 SOAPHeader 对象（可选），则可以使用以下代码行检索和删除该对象。变量 se 是一个 SOAPEnvelope 对象。

se.getHeader().detachNode();
 

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

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

SOAPHeaderElement shElement = sh.addHeaderElement(name);
 

另请参见：

SOAPHeaderElement

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()