org.apache.axis.message
Class SOAPHeaderElement
java.lang.Object
   org.apache.axis.message.NodeImpl
org.apache.axis.message.NodeImpl
       org.apache.axis.message.MessageElement
org.apache.axis.message.MessageElement
           org.apache.axis.message.SOAPHeaderElement
org.apache.axis.message.SOAPHeaderElement
- All Implemented Interfaces: 
- java.lang.Cloneable, org.w3c.dom.Element, Node, org.w3c.dom.Node, org.w3c.dom.NodeList, java.io.Serializable, SOAPElement, SOAPHeaderElement
- 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
 
 
 
| Fields inherited from class org.apache.axis.message.MessageElement | 
| _isRoot, context, encodingStyle, endEventIndex, fixupDeserializer, href, id, log, message, namespaces, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName | 
 
 
| Fields inherited from interface org.w3c.dom.Node | 
| ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE | 
 
 
| Method Summary | 
|  java.lang.String | getActor()Returns the uri of the actor associated with this
 
 SOAPHeaderElementobject. | 
|  org.w3c.dom.NamedNodeMap | getAttributes()A
 NamedNodeMapcontaining the attributes of this node (if
 it is anElement) ornullotherwise. | 
|  boolean | getMustUnderstand()Returns whether the mustUnderstand attribute for this
 SOAPHeaderElementobject is turned on. | 
|  boolean | getRelay()
 | 
|  java.lang.String | getRole()
 | 
|  boolean | isProcessed()
 | 
| protected  void | outputImpl(SerializationContext context)Subclasses can override
 | 
|  void | setActor(java.lang.String a)Sets the actor associated with this
 
 SOAPHeaderElementobject to the specified actor. | 
|  void | setMustUnderstand(boolean b)Sets the mustUnderstand attribute for this
 
   SOAPHeaderElementobject to be on or off. | 
|  void | setParentElement(SOAPElement parent)Sets the parent of this
 Nodeobject to the givenSOAPElementobject. | 
|  void | setProcessed(boolean value)
 | 
|  void | setRelay(boolean relay)
 | 
|  void | setRole(java.lang.String a)
 | 
 
| Methods inherited from class org.apache.axis.message.MessageElement | 
| addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, childDeepCloned, cloneNode, cloning, detachAllChildren, equals, findElement, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributesEx, getAttributeValue, getAttributeValue, getChildElement, getChildElements, getChildElements, getChildElements, getChildren, getCompleteAttributes, getDeserializationContext, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getLength, getName, getNamespacePrefixes, getNamespaceURI, getObjectValue, getObjectValue, getOwnerDocument, getPrefix, getQName, getRealElement, getRecorder, getTagName, getType, getValue, getValueAsType, getValueAsType, getValueDOM, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, isRoot, item, output, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAllAttributes, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setQName, setRecorder, setType, setValue, toString | 
 
| Methods inherited from class org.apache.axis.message.NodeImpl | 
| appendChild, convertAttrSAXtoDOM, detachNode, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, initializeChildren, insertBefore, isDirty, isSupported, makeAttributesEditable, normalize, recycleNode, removeChild, replaceChild, reset, setDirty, setDirty, setNodeValue, setOwnerDocument, setParent, setPrefix | 
 
| Methods inherited from class java.lang.Object | 
| clone, 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, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle | 
 
 
| Methods inherited from interface org.w3c.dom.Node | 
| appendChild, cloneNode, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix | 
 
| Methods inherited from interface org.w3c.dom.Element | 
| getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS | 
 
processed
protected boolean processed
actor
protected java.lang.String actor
mustUnderstand
protected boolean mustUnderstand
relay
protected boolean relay
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
setParentElement
public void setParentElement(SOAPElement parent)
                      throws SOAPException
- Description copied from interface: Node
- Sets the parent of this Nodeobject to the givenSOAPElementobject.
 
- 
- Specified by:
- setParentElementin interface- Node
- Overrides:
- setParentElementin class- NodeImpl
 
- 
- Parameters:
- parent- the- SOAPElementobject to be set as
               the parent of this- Nodeobject
- Throws:
- SOAPException- if there is a problem in setting the
                                      parent to the given element
- See Also:
- getParentElement()
 
getMustUnderstand
public boolean getMustUnderstand()
- Description copied from interface: SOAPHeaderElement
- Returns whether the mustUnderstand attribute for this
 SOAPHeaderElementobject is turned on.
 
- 
- Specified by:
- getMustUnderstandin interface- SOAPHeaderElement
 
- 
- Returns:
- trueif the mustUnderstand attribute of
     this- SOAPHeaderElementobject is turned on;- falseotherwise
 
setMustUnderstand
public void setMustUnderstand(boolean b)
- Description copied from interface: SOAPHeaderElement
- Sets the mustUnderstand attribute for this 
   SOAPHeaderElementobject to be on or off.If the mustUnderstand attribute is on, the actor who
   receives the SOAPHeaderElementmust process it
   correctly. This ensures, for example, that if the
   SOAPHeaderElementobject modifies the message, that
   the message is being modified correctly.
 
 
- 
- Specified by:
- setMustUnderstandin interface- SOAPHeaderElement
 
- 
- Parameters:
- b-- trueto
     set the mustUnderstand attribute on;- falseto turn if off
- See Also:
- getMustUnderstand()
 
getActor
public java.lang.String getActor()
- Description copied from interface: SOAPHeaderElement
- Returns the uri of the actor associated with this 
 SOAPHeaderElementobject.
 
- 
- Specified by:
- getActorin interface- SOAPHeaderElement
 
- 
- Returns:
- a Stringgiving the URI of the
     actor
- See Also:
- setActor(java.lang.String)
 
setActor
public void setActor(java.lang.String a)
- Description copied from interface: SOAPHeaderElement
- Sets the actor associated with this 
 SOAPHeaderElementobject to the specified actor. The
 default value of an actor is:
 SOAPConstants.URI_SOAP_ACTOR_NEXT
 
- 
- Specified by:
- setActorin interface- SOAPHeaderElement
 
- 
- Parameters:
- a- a- Stringgiving
     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:
- outputImplin 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 NamedNodeMapcontaining the attributes of this node (if
 it is anElement) ornullotherwise.
 
- 
- Specified by:
- getAttributesin interface- org.w3c.dom.Node
- Overrides:
- getAttributesin class- NodeImpl
 
- 
 
Copyright © 2005 Apache Web Services Project. All Rights Reserved.