|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--org.apache.axis.message.MessageElement | +--org.apache.axis.message.SOAPHeader
Holder for header elements.
Nested Class Summary |
Nested classes inherited from class org.apache.axis.message.MessageElement |
MessageElement.QNameAttr |
Field Summary |
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, textRep, typeQName |
Constructor Summary | |
SOAPHeader(java.lang.String namespace,
java.lang.String localPart,
java.lang.String prefix,
org.xml.sax.Attributes attributes,
DeserializationContext context,
SOAPConstants soapConsts)
|
Method Summary | |
void |
addChild(MessageElement el)
Note that this method will log a error and no-op if there is a value (set using setObjectValue) in the MessageElement. |
SOAPElement |
addChildElement(Name name)
Creates a new SOAPElement object initialized with the
given Name object and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(SOAPElement element)
we have to override this to enforce that SOAPHeader immediate children are exclusively of type SOAPHeaderElement (otherwise we'll get mysterious ClassCastExceptions down the road... |
SOAPElement |
addChildElement(java.lang.String localName)
Creates a new SOAPElement object initialized with the
given String object and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(java.lang.String localName,
java.lang.String prefix)
Creates a new SOAPElement object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement object. |
SOAPElement |
addChildElement(java.lang.String localName,
java.lang.String prefix,
java.lang.String uri)
Creates a new SOAPElement object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement object. |
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. |
java.util.Iterator |
getChildElements()
Returns an iterator over all the immediate content of this element. |
java.util.Iterator |
getChildElements(Name name)
Returns an iterator over all the child elements with the specified name. |
protected void |
outputImpl(SerializationContext context)
Subclasses can override |
void |
removeChild(MessageElement child)
Remove a child element. |
void |
setParentElement(SOAPElement parent)
Sets the parent of this Node object to the given
SOAPElement object. |
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, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, removeAttribute, removeNamespaceDeclaration, setEncodingStyle |
Methods inherited from interface javax.xml.soap.Node |
getParentElement, getValue, recycleNode |
Constructor Detail |
public SOAPHeader(java.lang.String namespace, java.lang.String localPart, java.lang.String prefix, org.xml.sax.Attributes attributes, DeserializationContext context, SOAPConstants soapConsts) throws AxisFault
Method Detail |
public void setParentElement(SOAPElement parent) throws SOAPException
Node
Node
object to the given
SOAPElement
object.
setParentElement
in interface Node
setParentElement
in class MessageElement
parent
- the SOAPElement
object to be set as
the parent of this Node
object
SOAPException
- if there is a problem in setting the
parent to the given elementgetParentElement()
public void detachNode()
Node
Node
object from the tree. Once
removed, this node can be garbage collected if there are no
application references to it.
detachNode
in interface Node
detachNode
in class MessageElement
public SOAPHeaderElement addHeaderElement(Name name) throws SOAPException
SOAPHeader
SOAPHeaderElement
object
initialized with the specified name and adds it to this
SOAPHeader
object.
addHeaderElement
in interface SOAPHeader
name
- a Name
object with
the name of the new SOAPHeaderElement
object
SOAPHeaderElement
object that
was inserted into this SOAPHeader
object
SOAPException
- if a SOAP error occurspublic java.util.Iterator examineHeaderElements(java.lang.String actor)
SOAPHeader
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.
examineHeaderElements
in interface SOAPHeader
actor
- a String
giving the
URI of the actor for which to search
Iterator
object over all the
SOAPHeaderElement
objects that contain the
specified actorextractHeaderElements(java.lang.String)
public java.util.Iterator extractHeaderElements(java.lang.String actor)
SOAPHeader
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.
extractHeaderElements
in interface SOAPHeader
actor
- a String
giving the
URI of the actor for which to search
Iterator
object over all the
SOAPHeaderElement
objects that contain the
specified actorexamineHeaderElements(java.lang.String)
protected void outputImpl(SerializationContext context) throws java.lang.Exception
MessageElement
outputImpl
in class MessageElement
java.lang.Exception
public void addChild(MessageElement el) throws SOAPException
MessageElement
addChild
in class MessageElement
SOAPException
public java.util.Iterator getChildElements()
SOAPElement
Text
objects as well
as SOAPElement
objects.
getChildElements
in interface SOAPElement
getChildElements
in class MessageElement
SOAPElement
objectpublic java.util.Iterator getChildElements(Name name)
SOAPElement
getChildElements
in interface SOAPElement
getChildElements
in class MessageElement
name
- a Name
object with
the name of the child elements to be returned
Iterator
object over all the elements
in this SOAPElement
object with the
specified namepublic void removeChild(MessageElement child)
MessageElement
removeChild
in class MessageElement
public SOAPElement addChildElement(SOAPElement element) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class MessageElement
element
- child element
SOAPException
public SOAPElement addChildElement(Name name) throws SOAPException
SOAPElement
SOAPElement
object initialized with the
given Name
object and adds the new element to this
SOAPElement
object.
addChildElement
in interface SOAPElement
addChildElement
in class MessageElement
name
- a Name
object with the XML name for the
new element
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
objectpublic SOAPElement addChildElement(java.lang.String localName) throws SOAPException
SOAPElement
SOAPElement
object initialized with the
given String
object and adds the new element to this
SOAPElement
object.
addChildElement
in interface SOAPElement
addChildElement
in class MessageElement
localName
- a String
giving the local name for
the element
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
objectpublic SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix) throws SOAPException
SOAPElement
SOAPElement
object initialized with the
specified local name and prefix and adds the new element to this
SOAPElement
object.
addChildElement
in interface SOAPElement
addChildElement
in class MessageElement
localName
- a String
giving the local name for
the new elementprefix
- a String
giving the namespace prefix for
the new element
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
objectpublic SOAPElement addChildElement(java.lang.String localName, java.lang.String prefix, java.lang.String uri) throws SOAPException
SOAPElement
SOAPElement
object initialized with the
specified local name, prefix, and URI and adds the new element to this
SOAPElement
object.
addChildElement
in interface SOAPElement
addChildElement
in class MessageElement
localName
- a String
giving the local name for
the new elementprefix
- a String
giving the namespace prefix for
the new elementuri
- a String
giving the URI of the namespace
to which the new element belongs
SOAPElement
object that was created
SOAPException
- if there is an error in creating the
SOAPElement
object
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |