Module com.sun.xml.messaging.saaj
Package com.sun.xml.messaging.saaj.soap.impl

Class HeaderElementImpl

java.lang.Object
com.sun.xml.messaging.saaj.soap.impl.ElementImpl
com.sun.xml.messaging.saaj.soap.impl.HeaderElementImpl
All Implemented Interfaces:
Node, SOAPBodyElement, SOAPElement, SOAPHeaderElement, Element, Node
Direct Known Subclasses:
HeaderElement1_1Impl, HeaderElement1_2Impl
public abstract class HeaderElementImpl extends ElementImpl implements SOAPHeaderElement

  • Field Details

    • RELAY_ATTRIBUTE_LOCAL_NAME

      protected static final Name RELAY_ATTRIBUTE_LOCAL_NAME

    • MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME

      protected static final Name MUST_UNDERSTAND_ATTRIBUTE_LOCAL_NAME

  • Constructor Details

  • Method Details

    • getActorAttributeName

      protected abstract NameImpl getActorAttributeName()

    • getRoleAttributeName

      protected abstract NameImpl getRoleAttributeName()

    • getMustunderstandAttributeName

      protected abstract NameImpl getMustunderstandAttributeName()

    • getMustunderstandAttributeValue

      protected abstract boolean getMustunderstandAttributeValue(String str)

    • getMustunderstandLiteralValue

      protected abstract String getMustunderstandLiteralValue(boolean mu)

    • getRelayAttributeName

      protected abstract NameImpl getRelayAttributeName()

    • getRelayAttributeValue

      protected abstract boolean getRelayAttributeValue(String str)

    • getRelayLiteralValue

      protected abstract String getRelayLiteralValue(boolean mu)

    • getActorOrRole

      protected abstract String getActorOrRole()

    • setParentElement

      public void setParentElement(SOAPElement element) throws SOAPException
      Description copied from interface: Node
      Sets the parent of this Node object to the given SOAPElement object.
      Specified by:
      setParentElement in interface Node
      Overrides:
      setParentElement in class ElementImpl
      Parameters:
      element - the SOAPElement object to be set as the parent of this Node object
      Throws:
      SOAPException - if there is a problem in setting the parent to the given element
      See Also:

    • setActor

      public void setActor(String actorUri)
      Description copied from interface: SOAPHeaderElement
      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 SOAPHeaderElement.setRole(String)

      Specified by:
      setActor in interface SOAPHeaderElement
      Parameters:
      actorUri - a String giving the URI of the actor to set
      See Also:

    • setRole

      public void setRole(String roleUri) throws SOAPException
      Description copied from interface: SOAPHeaderElement
      Sets the Role associated with this SOAPHeaderElement object to the specified Role.
      Specified by:
      setRole in interface SOAPHeaderElement
      Parameters:
      roleUri - the URI of the Role
      Throws:
      SOAPException - if there is an error in setting the role

    • getActor

      public String getActor()
      Description copied from interface: SOAPHeaderElement
      Returns the uri of the actor attribute of this SOAPHeaderElement.

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

      Specified by:
      getActor in interface SOAPHeaderElement
      Returns:
      a String giving the URI of the actor
      See Also:

    • getRole

      public String getRole()
      Description copied from interface: SOAPHeaderElement
      Returns the value of the Role attribute of this SOAPHeaderElement.
      Specified by:
      getRole in interface SOAPHeaderElement
      Returns:
      a String giving the URI of the Role

    • setMustUnderstand

      public void setMustUnderstand(boolean mustUnderstand)
      Description copied from interface: SOAPHeaderElement
      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.

      Specified by:
      setMustUnderstand in interface SOAPHeaderElement
      Parameters:
      mustUnderstand - true to set the mustUnderstand attribute to true; false to set it to false
      See Also:

    • getMustUnderstand

      public boolean getMustUnderstand()
      Description copied from interface: SOAPHeaderElement
      Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.
      Specified by:
      getMustUnderstand in interface SOAPHeaderElement
      Returns:
      true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

    • setRelay

      public void setRelay(boolean relay) throws SOAPException
      Description copied from interface: SOAPHeaderElement
      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 SOAPHeaderElement
      Parameters:
      relay - the new value of the relay attribute
      Throws:
      SOAPException - if there is a problem in setting the relay attribute.
      See Also:

    • getRelay

      public boolean getRelay()
      Description copied from interface: SOAPHeaderElement
      Returns the boolean value of the relay attribute for this SOAPHeaderElement
      Specified by:
      getRelay in interface SOAPHeaderElement
      Returns:
      true if the relay attribute is turned on; false otherwise
      See Also: