javax.xml.soap

Interface SOAPHeaderElement

Table des matières
  • All Superinterfaces:
    Element, Node, SOAPElement

    public interface SOAPHeaderElement
extends SOAPElement
    An object representing the contents in the SOAP header part of the SOAP envelope. The immediate children of a SOAPHeader object can be represented only as SOAPHeaderElement objects.

    A SOAPHeaderElement object can have other SOAPElement objects as its children.

    • Method Detail

      • setActor

        void setActor(String actorURI)
        Sets the actor associated with this SOAPHeaderElement object to the specified actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT

        If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to setRole(String)

        Parameters:
        actorURI - a String giving the URI of the actor to set
        Throws:
        IllegalArgumentException - if there is a problem in setting the actor.
        See Also:
        getActor()

      • setRole

        void setRole(String uri)
             throws SOAPException
        Sets the Role associated with this SOAPHeaderElement object to the specified Role.
        Parameters:
        uri - - the URI of the Role
        Throws:
        SOAPException - if there is an error in setting the role
        UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.
        Since:
        SAAJ 1.3

      • getActor

        String getActor()
        Returns the uri of the actor attribute of this SOAPHeaderElement.

        If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to getRole()

        Returns:
        a String giving the URI of the actor
        See Also:
        setActor(java.lang.String)

      • getRole

        String getRole()
        Returns the value of the Role attribute of this SOAPHeaderElement.
        Returns:
        a String giving the URI of the Role
        Throws:
        UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.
        Since:
        SAAJ 1.3

      • setMustUnderstand

        void setMustUnderstand(boolean mustUnderstand)
        Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false.

        If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderElement must process it correctly. This ensures, for example, that if the SOAPHeaderElement object modifies the message, that the message is being modified correctly.

        Parameters:
        mustUnderstand - true to set the mustUnderstand attribute to true; false to set it to false
        Throws:
        IllegalArgumentException - if there is a problem in setting the mustUnderstand attribute
        See Also:
        getMustUnderstand(), setRelay(boolean)

      • getMustUnderstand

        boolean getMustUnderstand()
        Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.
        Returns:
        true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

      • setRelay

        void setRelay(boolean relay)
              throws SOAPException
        Sets the relay attribute for this SOAPHeaderElement to be either true or false.

        The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it. This attribute is ignored on header blocks whose mustUnderstand attribute is set to true or that are targeted at the ultimate reciever (which is the default). The default value of this attribute is false.

        Parameters:
        relay - the new value of the relay attribute
        Throws:
        SOAPException - if there is a problem in setting the relay attribute.
        UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.
        Since:
        SAAJ 1.3
        See Also:
        setMustUnderstand(boolean), getRelay()

      • getRelay

        boolean getRelay()
        Returns the boolean value of the relay attribute for this SOAPHeaderElement
        Returns:
        true if the relay attribute is turned on; false otherwise
        Throws:
        UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.
        Since:
        SAAJ 1.3
        See Also:
        getMustUnderstand(), setRelay(boolean)

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

22/11/2024 09:57:52 Cette version de la page est en cache (à la date du 22/11/2024 09:57:52) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 11/06/2005, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-javax/xml/soap/soapheaderelement.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut