Class SOAPHeaderElement

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, Node, SOAPElement, SOAPHeaderElement, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.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:
    Serialized Form
    • Field Detail

      • processed

        protected boolean processed
      • actor

        protected java.lang.String actor
      • mustUnderstand

        protected boolean mustUnderstand
      • relay

        protected boolean relay
    • Constructor Detail

      • SOAPHeaderElement

        public SOAPHeaderElement​(java.lang.String namespace,
                                 java.lang.String localPart)
      • SOAPHeaderElement

        public SOAPHeaderElement​(Name name)
      • SOAPHeaderElement

        public SOAPHeaderElement​(QName qname)
      • SOAPHeaderElement

        public SOAPHeaderElement​(java.lang.String namespace,
                                 java.lang.String localPart,
                                 java.lang.Object value)
      • SOAPHeaderElement

        public SOAPHeaderElement​(QName qname,
                                 java.lang.Object value)
      • SOAPHeaderElement

        public SOAPHeaderElement​(org.w3c.dom.Element elem)
      • SOAPHeaderElement

        public SOAPHeaderElement​(java.lang.String namespace,
                                 java.lang.String localPart,
                                 java.lang.String prefix,
                                 org.xml.sax.Attributes attributes,
                                 DeserializationContext context)
                          throws AxisFault
        Throws:
        AxisFault
    • Method Detail

      • 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:
        getMustUnderstand()
      • setActor

        public void setActor​(java.lang.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:
        getActor()
      • getRole

        public java.lang.String getRole()
      • setRole

        public void setRole​(java.lang.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 java.lang.Exception
        Subclasses can override
        Overrides:
        outputImpl in class MessageElement
        Parameters:
        context - destination.
        Throws:
        java.lang.Exception - if something went wrong.
      • getAttributes

        public org.w3c.dom.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 org.w3c.dom.Node
        Overrides:
        getAttributes in class NodeImpl