Package org.apache.axis.message

Class SOAPHeaderElement

java.lang.Object
org.apache.axis.message.NodeImpl
org.apache.axis.message.MessageElement
org.apache.axis.message.SOAPHeaderElement
All Implemented Interfaces:
Serializable, Cloneable, Node, SOAPElement, SOAPHeaderElement, Element, Node, NodeList
Direct Known Subclasses:
RPCHeaderParam
public class SOAPHeaderElement extends MessageElement implements SOAPHeaderElement
A simple header element abstraction. Extends MessageElement with header-specific stuff like mustUnderstand, actor, and a 'processed' flag.
Author:
Glen Daniels (gdaniels@apache.org), Glyn Normington (glyn@apache.org)
See Also:

  • Field Details

    • processed

      protected boolean processed

    • actor

      protected String actor

    • mustUnderstand

      protected boolean mustUnderstand

    • relay

      protected boolean relay

  • Constructor Details

  • Method Details

    • setParentElement

      public void setParentElement(SOAPElement parent) throws SOAPException
      Description copied from class: NodeImpl
      Sets the parent of this Node object to the given SOAPElement object.
      Specified by:
      setParentElement in interface Node
      Overrides:
      setParentElement in class NodeImpl
      Parameters:
      parent - 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:

    • getMustUnderstand

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

    • setMustUnderstand

      public void setMustUnderstand(boolean b)
      Description copied from interface: SOAPHeaderElement
      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 SOAPHeaderElement
      Parameters:
      b - true to set the mustUnderstand attribute on; false to turn if off
      See Also:

    • getActor

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

    • setActor

      public void setActor(String a)
      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
      Specified by:
      setActor in interface SOAPHeaderElement
      Parameters:
      a - a String giving the URI of the actor to set
      See Also:

    • getRole

      public String getRole()

    • setRole

      public void setRole(String a)

    • getRelay

      public boolean getRelay()

    • setRelay

      public void setRelay(boolean relay)

    • setProcessed

      public void setProcessed(boolean value)

    • isProcessed

      public boolean isProcessed()

    • outputImpl

      protected void outputImpl(SerializationContext context) throws Exception
      Subclasses can override
      Overrides:
      outputImpl in class MessageElement
      Parameters:
      context - destination.
      Throws:
      Exception - if something went wrong.

    • getAttributes

      public NamedNodeMap getAttributes()
      Description copied from class: NodeImpl
      A NamedNodeMap containing the attributes of this node (if it is an Element) or null otherwise.
      Specified by:
      getAttributes in interface Node
      Overrides:
      getAttributes in class NodeImpl