org.apache.axis.message
Class SOAPHeaderElement

java.lang.Object
  |
  +--org.apache.axis.message.MessageElement
        |
        +--org.apache.axis.message.SOAPHeaderElement
All Implemented Interfaces:
Node, SOAPElement, SOAPHeaderElement

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@macromedia.com), Glyn Normington (glyn@apache.org)

Inner classes inherited from class org.apache.axis.message.MessageElement
MessageElement.QNameAttr
 
Field Summary
protected  java.lang.String actor
           
protected  boolean mustUnderstand
           
protected  boolean processed
           
 
Fields inherited from class org.apache.axis.message.MessageElement
_isDirty, _isRoot, attributes, context, elementRep, encodingStyle, endEventIndex, href, id, log, message, name, namespaces, namespaceURI, parent, prefix, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName
 
Constructor Summary
SOAPHeaderElement()
           
SOAPHeaderElement(org.w3c.dom.Element elem)
           
SOAPHeaderElement(java.lang.String namespace, java.lang.String localPart)
           
SOAPHeaderElement(java.lang.String namespace, java.lang.String localPart, java.lang.Object value)
           
SOAPHeaderElement(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context)
           
 
Method Summary
 java.lang.String getActor()
          Returns the uri of the actor associated with this SOAPHeaderElement object.
 boolean getMustUnderstand()
          Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
 boolean isProcessed()
           
 void setActor(java.lang.String a)
          Sets the actor associated with this SOAPHeaderElement object to the specified actor.
 void setMustUnderstand(boolean b)
          Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.
 void setProcessed(boolean value)
           
 
Methods inherited from class org.apache.axis.message.MessageElement
addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, detachNode, getAllAttributes, getAsDocument, getAsDOM, getAttributes, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildren, getElementName, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getObjectValue, getParentElement, getPrefix, getPrefix, getRealElement, getRecorder, getType, getValue, getValueAsType, isDirty, isRoot, output, outputImpl, publishContents, publishToHandler, recycleNode, removeAttribute, removeNamespaceDeclaration, setAttribute, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setParentElement, setPrefix, setRecorder, setType, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface javax.xml.soap.SOAPElement
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, removeAttribute, removeNamespaceDeclaration, setEncodingStyle
 
Methods inherited from interface javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement
 

Field Detail

processed

protected boolean processed

actor

protected java.lang.String actor

mustUnderstand

protected boolean mustUnderstand
Constructor Detail

SOAPHeaderElement

public SOAPHeaderElement()

SOAPHeaderElement

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

SOAPHeaderElement

public SOAPHeaderElement(java.lang.String namespace,
                         java.lang.String localPart,
                         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)
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
Following copied from interface: javax.xml.soap.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
Following copied from interface: javax.xml.soap.SOAPHeaderElement
Parameters:
mustUnderstand - true to set the mustUnderstand attribute on; false to turn if off
Throws:
java.lang.IllegalArgumentException - if there is a problem in setting the actor.
See Also:
getMustUnderstand()

getActor

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

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
Following copied from interface: javax.xml.soap.SOAPHeaderElement
Parameters:
actorURI - a String giving the URI of the actor to set
Throws:
java.lang.IllegalArgumentException - if there is a problem in setting the actor.
See Also:
getActor()

setProcessed

public void setProcessed(boolean value)

isProcessed

public boolean isProcessed()


Copyright © 2001 Apache XML Project. All Rights Reserved.