Package org.apache.axis2.saaj

Class SOAPHeaderElementImpl

java.lang.Object
org.apache.axis2.saaj.ProxyNode<T,S>
org.apache.axis2.saaj.NodeImpl<Element,T>
org.apache.axis2.saaj.SOAPElementImpl<org.apache.axiom.soap.SOAPHeaderBlock>
org.apache.axis2.saaj.SOAPHeaderElementImpl
All Implemented Interfaces:
jakarta.xml.soap.Node, jakarta.xml.soap.SOAPElement, jakarta.xml.soap.SOAPHeaderElement, Element, Node
public class SOAPHeaderElementImpl extends SOAPElementImpl<org.apache.axiom.soap.SOAPHeaderBlock> implements jakarta.xml.soap.SOAPHeaderElement

  • Constructor Details

    • SOAPHeaderElementImpl

      public SOAPHeaderElementImpl(org.apache.axiom.soap.SOAPHeaderBlock element)
      Parameters:
      element -

  • Method Details

    • setActor

      public 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
      Specified by:
      setActor in interface jakarta.xml.soap.SOAPHeaderElement
      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

      public String getActor()
      Returns the uri of the actor associated with this SOAPHeaderElement object.
      Specified by:
      getActor in interface jakarta.xml.soap.SOAPHeaderElement
      Returns:
      a String giving the URI of the actor
      See Also:

    • setMustUnderstand

      public void setMustUnderstand(boolean mustUnderstand)
      Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.

      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.

      Specified by:
      setMustUnderstand in interface jakarta.xml.soap.SOAPHeaderElement
      Parameters:
      mustUnderstand - true to set the mustUnderstand attribute on; false to turn if off
      Throws:
      IllegalArgumentException - if there is a problem in setting the actor.
      See Also:

    • getMustUnderstand

      public boolean getMustUnderstand()
      Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
      Specified by:
      getMustUnderstand in interface jakarta.xml.soap.SOAPHeaderElement
      Returns:
      true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

    • setRole

      public void setRole(String uri) throws jakarta.xml.soap.SOAPException
      Sets the Role associated with this SOAPHeaderElement object to the specified Role.
      Specified by:
      setRole in interface jakarta.xml.soap.SOAPHeaderElement
      Parameters:
      uri - - the URI of the Role
      Throws:
      jakarta.xml.soap.SOAPException - - if there is an error in setting the role java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Fault Role.

    • getRole

      public String getRole()
      Specified by:
      getRole in interface jakarta.xml.soap.SOAPHeaderElement

    • setRelay

      public void setRelay(boolean flag) throws jakarta.xml.soap.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.
      Specified by:
      setRelay in interface jakarta.xml.soap.SOAPHeaderElement
      Parameters:
      relay - - the new value of the relay attribute
      Throws:
      jakarta.xml.soap.SOAPException - - if there is a problem in setting the relay attribute. java.lang.UnsupportedOperationException - if this message does not support the SOAP 1.2 concept of Relay attribute.

    • getRelay

      public boolean getRelay()
      Specified by:
      getRelay in interface jakarta.xml.soap.SOAPHeaderElement

    • setParentElement

      public void setParentElement(jakarta.xml.soap.SOAPElement parent) throws jakarta.xml.soap.SOAPException
      Specified by:
      setParentElement in interface jakarta.xml.soap.Node
      Overrides:
      setParentElement in class NodeImpl<Element,org.apache.axiom.soap.SOAPHeaderBlock>
      Throws:
      jakarta.xml.soap.SOAPException