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

Interface SOAPHeader

  • All Superinterfaces:
    Element ， Node ， Node ， SOAPElement 

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

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

       se.getHeader().detachNode();
    使用SOAPEnvelope方法addHeader创建一个SOAPHeader对象。 创建新标题并将其添加到信封的方法只能在现有标题已被删除后才能被调用。 
       se.getHeader().detachNode(); SOAPHeader sh = se.addHeader();

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

       SOAPHeaderElement shElement = sh.addHeaderElement(name);
    从以下版本开始：
    1.6
    另请参见：
    SOAPHeaderElement

    • 方法详细信息

      • 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错误
        从以下版本开始：
        1.6，SAAJ 1.3
        另请参见：
        addHeaderElement(Name)

      • examineHeaderElements

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

        在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<SOAPHeaderElement> 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标题。
        从以下版本开始：
        1.6，SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement​(Iterator<String> supportedSOAPURIs)
                                   throws SOAPException
        创建一个新的升级SOAPHeaderElement对象，并使用指定的支持SOAP URI的String Iterator进行初始化，并将其添加到此SOAPHeader对象。 SOAP 1.1和SOAP 1.2头都支持此操作。
        参数
        supportedSOAPURIs - 支持的SOAP版本的URI字符串 Iterator 。
        结果
        新的 SOAPHeaderElement对象被插入到这个 SOAPHeader对象中
        异常
        SOAPException - 如果发生SOAP错误。
        从以下版本开始：
        1.6，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错误。
        从以下版本开始：
        1.6，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错误。
        从以下版本开始：
        1.6，SAAJ 1.3

      • examineAllHeaderElements

        Iterator<SOAPHeaderElement> examineAllHeaderElements​()
        返回一个 Iterator在所有 SOAPHeaderElement这个对象 SOAPHeader对象。
        结果
        一个 Iterator对象，所有 SOAPHeaderElement对象包含在这个 SOAPHeader
        从以下版本开始：
        1.6，SAAJ 1.2
        另请参见：
        extractAllHeaderElements()

      • extractAllHeaderElements

        Iterator<SOAPHeaderElement> extractAllHeaderElements​()
        在此 SOAPHeader对象中的所有 SOAPHeaderElement对象中返回 Iterator ，并将其从该 SOAPHeader对象中分离出来。
        结果
        一个 Iterator对象在所有 SOAPHeaderElement这个包含的对象 SOAPHeader
        从以下版本开始：
        1.6，SAAJ 1.2
        另请参见：
        examineAllHeaderElements()