public class SOAPHeaderImpl extends SOAPElementImpl implements SOAPHeader
element
parentElement
builder, done, factory, FIRSTCHILD, flags, NORMALIZED, OWNED, ownerNode, READONLY, SPECIFIED
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
Constructor and Description |
---|
SOAPHeaderImpl(org.apache.axiom.soap.SOAPHeader header)
Constructor
|
Modifier and Type | Method and Description |
---|---|
SOAPElement |
addChildElement(Name name) |
SOAPElement |
addChildElement(SOAPElement soapElement) |
SOAPElement |
addChildElement(String localName) |
SOAPElement |
addChildElement(String localName,
String prefix) |
SOAPElement |
addChildElement(String localName,
String prefix,
String uri) |
SOAPHeaderElement |
addHeaderElement(Name name)
Creates a new
SOAPHeaderElement object initialized with the specified name and
adds it to this SOAPHeader object. |
SOAPHeaderElement |
addHeaderElement(QName qname) |
SOAPHeaderElement |
addNotUnderstoodHeaderElement(QName qname)
Creates a new NotUnderstood SOAPHeaderElement object initialized with the specified name and
adds it to this SOAPHeader object.
|
SOAPElement |
addTextNode(String text)
Creates a new
Text object initialized with the given String and
adds it to this SOAPElement object. |
SOAPHeaderElement |
addUpgradeHeaderElement(Iterator iterator)
Creates a new Upgrade SOAPHeaderElement object initialized with the specified List of
supported SOAP URIs and adds it to this SOAPHeader object.
|
SOAPHeaderElement |
addUpgradeHeaderElement(String s) |
SOAPHeaderElement |
addUpgradeHeaderElement(String[] as) |
protected Element |
appendElement(org.apache.axiom.om.impl.dom.ElementImpl child) |
org.apache.axiom.om.OMNode |
detach() |
void |
detachNode()
Removes this
Node object from the tree. |
Iterator |
examineAllHeaderElements()
Returns an
Iterator over all the SOAPHeaderElement objects in this
SOAPHeader object. |
Iterator |
examineHeaderElements(String actor)
Returns a list of all the
SOAPHeaderElement objects in this
SOAPHeader object that have the the specified actor. |
Iterator |
examineMustUnderstandHeaderElements(String actor)
Returns an
Iterator over all the SOAPHeaderElement objects in this
SOAPHeader object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to true . |
Iterator |
extractAllHeaderElements()
Returns an
Iterator over all the SOAPHeaderElement objects in this
SOAPHeader object and detaches them from this SOAPHeader object. |
Iterator |
extractHeaderElements(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. |
Iterator |
getChildElements()
Returns an iterator over all the immediate content of this element.
|
Iterator |
getChildElements(Name name) |
addAttribute, addAttribute, addChildElement, addNamespaceDeclaration, appendChild, appendText, clone, copyContents, createQName, discard, getAllAttributes, getAllAttributesAsQNames, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getAttributeValue, getChildElements, getChildNodes, getElement, getElementName, getElementQName, getElementsByTagName, getElementsByTagNameNS, getEncodingStyle, getFirstChild, getLastChild, getLocalName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPreviousSibling, getTagName, getTextContent, getValue, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasChildNodes, internalSerialize, removeAttribute, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setElementQName, setEncodingStyle, setParent, setParentElement, setValue, toString
getParent, getSchemaTypeInfo, getType, recycleNode, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setType
build, buildWithAttachments, cloneNode, close, compareDocumentPosition, getBaseURI, getFeature, getLength, getNextOMSibling, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getPreviousOMSibling, getUserData, hasAttributes, insertBefore, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, replaceChild, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setNodeValue, setOwnerDocument, setPrefix, setPreviousOMSibling, setTextContent, setUserData
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
addAttribute, addAttribute, addChildElement, addNamespaceDeclaration, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle
getParentElement, getValue, recycleNode, setParentElement, setValue
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData
public SOAPHeaderImpl(org.apache.axiom.soap.SOAPHeader header)
header
- public SOAPElement addChildElement(String localName) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class SOAPElementImpl
SOAPException
public SOAPElement addChildElement(String localName, String prefix) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class SOAPElementImpl
SOAPException
public SOAPElement addChildElement(String localName, String prefix, String uri) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class SOAPElementImpl
SOAPException
public SOAPElement addChildElement(Name name) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class SOAPElementImpl
SOAPException
public SOAPElement addChildElement(SOAPElement soapElement) throws SOAPException
addChildElement
in interface SOAPElement
addChildElement
in class SOAPElementImpl
SOAPException
protected Element appendElement(org.apache.axiom.om.impl.dom.ElementImpl child) throws SOAPException
appendElement
in class SOAPElementImpl
SOAPException
public SOAPHeaderElement addHeaderElement(Name name) throws SOAPException
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
objectSOAPHeaderElement
object that was inserted into this
SOAPHeader
objectSOAPException
- if a SOAP error occurspublic Iterator examineHeaderElements(String actor)
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 searchIterator
object over all the SOAPHeaderElement
objects
that contain the specified actorextractHeaderElements(java.lang.String)
public Iterator extractHeaderElements(String actor)
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 searchIterator
object over all the SOAPHeaderElement
objects
that contain the specified actorexamineHeaderElements(java.lang.String)
public Iterator examineMustUnderstandHeaderElements(String actor)
Iterator
over all the SOAPHeaderElement
objects in this
SOAPHeader
object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to true
.examineMustUnderstandHeaderElements
in interface SOAPHeader
actor
- a String
giving the URI of the actor for which to searchIterator
object over all the SOAPHeaderElement
objects
that contain the specified actor and are marked as MustUnderstandpublic Iterator examineAllHeaderElements()
Iterator
over all the SOAPHeaderElement
objects in this
SOAPHeader
object.examineAllHeaderElements
in interface SOAPHeader
Iterator
object over all the SOAPHeaderElement
objects
contained by this SOAPHeader
public Iterator extractAllHeaderElements()
Iterator
over all the SOAPHeaderElement
objects in this
SOAPHeader
object and detaches them from this SOAPHeader
object.extractAllHeaderElements
in interface SOAPHeader
Iterator
object over all the SOAPHeaderElement
objects
contained by this SOAPHeader
public SOAPHeaderElement addHeaderElement(QName qname) throws SOAPException
addHeaderElement
in interface SOAPHeader
SOAPException
public SOAPHeaderElement addNotUnderstoodHeaderElement(QName qname) throws SOAPException
addNotUnderstoodHeaderElement
in interface SOAPHeader
name
- - a QName object with the name of the SOAPHeaderElement object that was not
understood.SOAPException-
- if a SOAP error occurs. java.lang.UnsupportedOperationException - if
this is a SOAP 1.1 Header.SOAPException
public SOAPHeaderElement addUpgradeHeaderElement(Iterator iterator) throws SOAPException
addUpgradeHeaderElement
in interface SOAPHeader
supportedSOAPURIs
- - an Iterator object with the URIs of SOAP versions supported.SOAPException
- - if a SOAP error occurs.public SOAPHeaderElement addUpgradeHeaderElement(String[] as) throws SOAPException
addUpgradeHeaderElement
in interface SOAPHeader
SOAPException
public SOAPHeaderElement addUpgradeHeaderElement(String s) throws SOAPException
addUpgradeHeaderElement
in interface SOAPHeader
SOAPException
public SOAPElement addTextNode(String text) throws SOAPException
SOAPElementImpl
Text
object initialized with the given String
and
adds it to this SOAPElement
object.addTextNode
in interface SOAPElement
addTextNode
in class SOAPElementImpl
text
- a String
object with the textual content to be addedSOAPElement
object into which the new Text
object was
insertedSOAPException
- if there is an error in creating the new Text
objectpublic Iterator getChildElements(Name name)
getChildElements
in interface SOAPElement
getChildElements
in class SOAPElementImpl
public Iterator getChildElements()
SOAPElementImpl
Text
objects as well as SOAPElement
objects.getChildElements
in interface SOAPElement
getChildElements
in class SOAPElementImpl
Text
and SOAPElement
contained within this
SOAPElement
objectpublic void detachNode()
NodeImplEx
Node
object from the tree. Once removed, this node can be garbage
collected if there are no application references to it.detachNode
in class SOAPElementImpl
public org.apache.axiom.om.OMNode detach()
detach
in interface org.apache.axiom.om.OMNode
detach
in class SOAPElementImpl
Copyright © 2004–2015 The Apache Software Foundation. All rights reserved.