org.apache.axis.message
Class SOAPHeader
java.lang.Object
|
+--org.apache.axis.message.MessageElement
|
+--org.apache.axis.message.SOAPHeader
- All Implemented Interfaces:
- Node, SOAPElement, SOAPHeader
- public class SOAPHeader
- extends MessageElement
- implements SOAPHeader
Holder for header elements.
- Author:
- Glyn Normington (glyn@apache.org)
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 |
Method Summary |
SOAPHeaderElement |
addHeaderElement(Name name)
Creates a new SOAPHeaderElement object
initialized with the specified name and adds it to this
SOAPHeader object. |
void |
detachNode()
Removes this Node object from the tree. |
java.util.Iterator |
examineHeaderElements(java.lang.String actor)
Returns a list of all the SOAPHeaderElement
objects in this SOAPHeader object that have the
the specified actor. |
java.util.Iterator |
extractHeaderElements(java.lang.String actor)
Returns a list of all the SOAPHeaderElement
objects in this SOAPHeader object that have
the the specified actor and detaches them from this
SOAPHeader object. |
protected void |
outputImpl(SerializationContext context)
Subclasses can override |
void |
setParentElement(SOAPElement parent)
Sets the parent of this Node object to the given
SOAPElement object. |
Methods inherited from class org.apache.axis.message.MessageElement |
addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, 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, publishContents, publishToHandler, recycleNode, removeAttribute, removeNamespaceDeclaration, setAttribute, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, 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 |
setParentElement
public void setParentElement(SOAPElement parent)
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 MessageElement
- Following copied from interface:
javax.xml.soap.Node
- 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:
getParentElement()
detachNode
public void detachNode()
- Description copied from interface:
Node
- Removes this
Node
object from the tree. Once
removed, this node can be garbage collected if there are no
application references to it.
- Specified by:
detachNode
in interface Node
- Overrides:
detachNode
in class MessageElement
addHeaderElement
public SOAPHeaderElement addHeaderElement(Name name)
throws SOAPException
- Description copied from interface:
SOAPHeader
- Creates a new
SOAPHeaderElement
object
initialized with the specified name and adds it to this
SOAPHeader
object.
- Specified by:
addHeaderElement
in interface SOAPHeader
- Following copied from interface:
javax.xml.soap.SOAPHeader
- Parameters:
name
- a Name
object with
the name of the new SOAPHeaderElement
object- Returns:
- the new
SOAPHeaderElement
object that
was inserted into this SOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs
examineHeaderElements
public java.util.Iterator examineHeaderElements(java.lang.String actor)
- Description copied from interface:
SOAPHeader
- Returns a list of all the
SOAPHeaderElement
objects in this SOAPHeader
object that have the
the specified actor. An actor is a global attribute that
indicates the intermediate parties to whom the message should
be sent. An actor receives the message and then sends it to
the next actor. The default actor is the ultimate intended
recipient for the message, so if no actor attribute is
included in a SOAPHeader
object, the message is
sent to its ultimate destination.
- Specified by:
examineHeaderElements
in interface SOAPHeader
- Following copied from interface:
javax.xml.soap.SOAPHeader
- Parameters:
actor
- a String
giving the
URI of the actor for which to search- Returns:
- an
Iterator
object over all the
SOAPHeaderElement
objects that contain the
specified actor - See Also:
extractHeaderElements(java.lang.String)
extractHeaderElements
public java.util.Iterator extractHeaderElements(java.lang.String actor)
- Description copied from interface:
SOAPHeader
- Returns a list of all the
SOAPHeaderElement
objects in this SOAPHeader
object that have
the the specified actor and detaches them from this
SOAPHeader
object.
This method allows an actor to process only the parts of
the SOAPHeader
object that apply to it and to
remove them before passing the message on to the next
actor.
- Specified by:
extractHeaderElements
in interface SOAPHeader
- Following copied from interface:
javax.xml.soap.SOAPHeader
- Parameters:
actor
- a String
giving the
URI of the actor for which to search- Returns:
- an
Iterator
object over all the
SOAPHeaderElement
objects that contain the
specified actor - See Also:
examineHeaderElements(java.lang.String)
outputImpl
protected void outputImpl(SerializationContext context)
throws java.lang.Exception
- Description copied from class:
MessageElement
- Subclasses can override
- Overrides:
outputImpl
in class MessageElement
Copyright © 2001 Apache XML Project. All Rights Reserved.