javax.xml.soap
接口 SOAPHeaderElement

所有超级接口：

Element, Node, SOAPElement

public interface SOAPHeaderElement
     

      extends 
      SOAPElement
     

表示 SOAP 信封 SOAP 头部分的内容的对象。SOAPHeader 对象的直接子级只能用 SOAPHeaderElement 对象的形式表示。

SOAPHeaderElement 对象可以将其他 SOAPElement 对象作为其子级。

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

将此 SOAPHeaderElement 的 relay 属性设置为 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)