No cache version.

Caching disabled. Default setting for this page:enabled (code LNG204)
If the display is too slow, you can disable the user mode to view the cached version.
javax.xml.soap

Interface SOAPHeader

Contents
  • All Superinterfaces:
    Element, Node, SOAPElement

    public interface SOAPHeader
extends SOAPElement
    A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a SOAPHeader object.

    A SOAPEnvelope object contains an empty SOAPHeader object by default. If the SOAPHeader object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is a SOAPEnvelope object. 

          se.getHeader().detachNode();
    A SOAPHeader object is created with the SOAPEnvelope method addHeader. This method, which creates a new header and adds it to the envelope, may be called only after the existing header has been removed. 
          se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader();

    A SOAPHeader object can have only SOAPHeaderElement objects as its immediate children. The method addHeaderElement creates a new HeaderElement object and adds it to the SOAPHeader object. In the following line of code, the argument to the method addHeaderElement is a Name object that is the name for the new HeaderElement object. 

          SOAPHeaderElement shElement = sh.addHeaderElement(name);
    See Also:
    SOAPHeaderElement

    • Method Detail

      • addHeaderElement

        SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException
        Creates a new SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object.
        Parameters:
        name - a Name object with the name of the new SOAPHeaderElement object
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs
        See Also:
        addHeaderElement(javax.xml.namespace.QName)

      • addHeaderElement

        SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException
        Creates a new SOAPHeaderElement object initialized with the specified qname and adds it to this SOAPHeader object.
        Parameters:
        qname - a QName object with the qname of the new SOAPHeaderElement object
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs
        Since:
        SAAJ 1.3
        See Also:
        addHeaderElement(Name)

      • examineMustUnderstandHeaderElements

        Iterator examineMustUnderstandHeaderElements(String actor)
        Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent to true.

        In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

        Parameters:
        actor - a String giving the URI of the actor / role for which to search
        Returns:
        an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role and are marked as MustUnderstand
        Since:
        SAAJ 1.2
        See Also:
        examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • examineHeaderElements

        Iterator examineHeaderElements(String actor)
        Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor. An actor is a global attribute that indicates the intermediate parties that should process a message before it reaches its ultimate receiver. An actor receives the message and processes it before sending it on to the next actor. The default actor is the ultimate intended recipient for the message, so if no actor attribute is included in a SOAPHeader object, it is sent to the ultimate receiver along with the message body.

        In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

        Parameters:
        actor - a String giving the URI of the actor / role for which to search
        Returns:
        an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role
        See Also:
        extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • extractHeaderElements

        Iterator extractHeaderElements(String actor)
        Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object that have the specified actor and detaches them from this SOAPHeader object.

        This method allows an actor to process the parts of the SOAPHeader object that apply to it and to remove them before passing the message on to the next actor.

        In SOAP 1.2 the env:actor attribute is replaced by the env:role attribute, but with essentially the same semantics.

        Parameters:
        actor - a String giving the URI of the actor / role for which to search
        Returns:
        an Iterator object over all the SOAPHeaderElement objects that contain the specified actor / role
        See Also:
        examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

      • addNotUnderstoodHeaderElement

        SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                                throws SOAPException
        Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and adds it to this SOAPHeader object. This operation is supported only by SOAP 1.2.
        Parameters:
        name - a QName object with the name of the SOAPHeaderElement object that was not understood.
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs.
        UnsupportedOperationException - if this is a SOAP 1.1 Header.
        Since:
        SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                          throws SOAPException
        Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
        Parameters:
        supportedSOAPURIs - an Iterator object with the URIs of SOAP versions supported.
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs.
        Since:
        SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                          throws SOAPException
        Creates a new Upgrade SOAPHeaderElement object initialized with the specified array of supported SOAP URIs and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
        Parameters:
        supportedSoapUris - an array of the URIs of SOAP versions supported.
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs.
        Since:
        SAAJ 1.3

      • addUpgradeHeaderElement

        SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                          throws SOAPException
        Creates a new Upgrade SOAPHeaderElement object initialized with the specified supported SOAP URI and adds it to this SOAPHeader object. This operation is supported on both SOAP 1.1 and SOAP 1.2 header.
        Parameters:
        supportedSoapUri - the URI of SOAP the version that is supported.
        Returns:
        the new SOAPHeaderElement object that was inserted into this SOAPHeader object
        Throws:
        SOAPException - if a SOAP error occurs.
        Since:
        SAAJ 1.3

      • examineAllHeaderElements

        Iterator examineAllHeaderElements()
        Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object.
        Returns:
        an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader
        Since:
        SAAJ 1.2
        See Also:
        extractAllHeaderElements()

      • extractAllHeaderElements

        Iterator extractAllHeaderElements()
        Returns an Iterator over all the SOAPHeaderElement objects in this SOAPHeader object and detaches them from this SOAPHeader object.
        Returns:
        an Iterator object over all the SOAPHeaderElement objects contained by this SOAPHeader
        Since:
        SAAJ 1.2
        See Also:
        examineAllHeaderElements()

Document created the 11/06/2005, last modified the 04/03/2020
Source of the printed document:https://www.gaudry.be/en/java-api-rf-javax/xml/soap/SOAPHeader.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

  1. View the html document Language of the document:fr Manuel PHP : https://docs.oracle.com

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut