Module  java.xml.ws
软件包  javax.xml.soap

Interface SOAPHeaderElement

  • All Superinterfaces:
    Element ， Node ， Node ， SOAPElement 

    public interface SOAPHeaderElement
extends SOAPElement
    表示SOAP信封SOAP头部分内容的对象。 SOAPHeader对象的直接子项只能表示为SOAPHeaderElement对象。

    一个SOAPHeaderElement对象可以有其他SOAPElement对象作为其子项。

    从以下版本开始：
    1.6

    • 方法详细信息

      • setActor

        void setActor​(String actorURI)
        将与此SOAPHeaderElement对象相关联的actor设置为指定的actor。 演员的默认值为： SOAPConstants.URI_SOAP_ACTOR_NEXT

        如果这个SOAPHeaderElement支持SOAP 1.2，那么这个调用相当于setRole(String)

        参数
        actorURI - 一个 String给出演员的URI设置
        异常
        IllegalArgumentException - 如果设置演员有问题。
        另请参见：
        getActor()

      • setRole

        void setRole​(String uri)
      throws SOAPException
        将与此 SOAPHeaderElement对象相关联的 Role设置为指定的 Role 。
        参数
        uri - - 的URI为 Role
        异常
        SOAPException - 如果设置角色有错误
        UnsupportedOperationException - 如果此消息不支持SOAP 1.2概念的故障角色。
        从以下版本开始：
        1.6，SAAJ 1.3

      • getActor

        String getActor​()
        返回此SOAPHeaderElement的actor属性的uri。

        如果这个SOAPHeaderElement支持SOAP 1.2，那么这个调用相当于getRole()

        结果
        一个 String给出演员的URI
        另请参见：
        setActor(java.lang.String)

      • getRole

        String getRole​()
        返回此 SOAPHeaderElement的 Role属性的 SOAPHeaderElement 。
        结果
        一个 String给出的URI的 Role
        异常
        UnsupportedOperationException - 如果此消息不支持“故障角色”的SOAP 1.2概念。
        从以下版本开始：
        1.6，SAAJ 1.3

      • setMustUnderstand

        void setMustUnderstand​(boolean mustUnderstand)
        将此SOAPHeaderElement对象的mustUnderstand属性设置为true或false。

        如果mustUnderstand属性打开，则接收SOAPHeaderElement的演员必须正确处理。 这可以确保，例如，如果SOAPHeaderElement对象修改消息，那么该消息正在被正确修改。

        参数
        mustUnderstand - true将mustUnderstand属性设置为true; false将其设置为false
        异常
        IllegalArgumentException - 如果在设置mustUnderstand属性时出现问题
        另请参见：
        getMustUnderstand() ， setRelay(boolean)

      • getMustUnderstand

        boolean getMustUnderstand​()
        返回此 SOAPHeaderElement的mustUnderstand属性的布尔值。
        结果
        true如果此SOAPHeaderElement对象的mustUnderstand属性已打开; 否则为false

      • setRelay

        void setRelay​(boolean relay)
       throws SOAPException
        将此SOAPHeaderElement的继电器属性设置为true或false。

        SOAP中继属性设置为true，表示SOAP头块必须由头块目标的任何节点进行中继，但实际上不处理它。 对于其mustUnderstand属性设置为true或针对最终接收者（这是默认值）的标头块，此属性将被忽略。 此属性的默认值为false 。

        参数
        relay - 中继属性的新值
        异常
        SOAPException - 如果设置中继属性有问题。
        UnsupportedOperationException - 如果此消息不支持中继属性的SOAP 1.2概念。
        从以下版本开始：
        1.6，SAAJ 1.3
        另请参见：
        setMustUnderstand(boolean) ， getRelay()

      • getRelay

        boolean getRelay​()
        返回此 SOAPHeaderElement的 中继属性的布尔值
        结果
        true如果继电器属性打开; 否则为false
        异常
        UnsupportedOperationException - 如果此消息不支持中继属性的SOAP 1.2概念。
        从以下版本开始：
        1.6，SAAJ 1.3
        另请参见：
        getMustUnderstand() ， setRelay(boolean)