Interface SOAPHeader
-
- All Superinterfaces:
org.w3c.dom.Element
,Node
,org.w3c.dom.Node
,SOAPElement
public interface SOAPHeader extends SOAPElement
A representation of the SOAP header element. A SOAP header element consists of XML data that affects the way the application-specific content is processed by the message provider. For example, transaction semantics, authentication information, and so on, can be specified as the content of a
SOAPHeader
object.A
SOAPEnvelope
object contains an emptySOAPHeader
object by default. If theSOAPHeader
object, which is optional, is not needed, it can be retrieved and deleted with the following line of code. The variable se is aSOAPEnvelope
object.se.getHeader().detachNode();
ASOAPHeader
object is created with theSOAPEnvelope
methodaddHeader
. This method, which creates a new header and adds it to the envelope, may be called only after the existing header has been removed.se.getHeader().detachNode(); SOAPHeader sh = se.addHeader();
A
SOAPHeader
object can have onlySOAPHeaderElement
objects as its immediate children. The methodaddHeaderElement
creates a newHeaderElement
object and adds it to theSOAPHeader
object. In the following line of code, the argument to the methodaddHeaderElement
is aName
object that is the name for the newHeaderElement
object.SOAPHeaderElement shElement = sh.addHeaderElement(name);
- See Also:
SOAPHeaderElement
-
-
Field Summary
-
Fields inherited from interface org.w3c.dom.Node
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
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description SOAPHeaderElement
addHeaderElement(Name name)
Creates a newSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.java.util.Iterator
examineAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object.java.util.Iterator
examineHeaderElements(java.lang.String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the the specified actor.java.util.Iterator
examineMustUnderstandHeaderElements(java.lang.String actor)
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent totrue
.java.util.Iterator
extractAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object and detaches them from thisSOAPHeader
object.java.util.Iterator
extractHeaderElements(java.lang.String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the the specified actor and detaches them from thisSOAPHeader
object.-
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS
-
Methods inherited from interface org.apache.xmlbeans.impl.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
Methods inherited from interface org.w3c.dom.Node
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
-
Methods inherited from interface org.apache.xmlbeans.impl.soap.SOAPElement
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle
-
-
-
-
Method Detail
-
addHeaderElement
SOAPHeaderElement addHeaderElement(Name name) throws SOAPException
Creates a newSOAPHeaderElement
object initialized with the specified name and adds it to thisSOAPHeader
object.- Parameters:
name
- aName
object with the name of the newSOAPHeaderElement
object- Returns:
- the new
SOAPHeaderElement
object that was inserted into thisSOAPHeader
object - Throws:
SOAPException
- if a SOAP error occurs
-
examineHeaderElements
java.util.Iterator examineHeaderElements(java.lang.String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
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 aSOAPHeader
object, the message is sent to its ultimate destination.- Parameters:
actor
- aString
giving the URI of the actor for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor - See Also:
extractHeaderElements(java.lang.String)
-
extractHeaderElements
java.util.Iterator extractHeaderElements(java.lang.String actor)
Returns a list of all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the the specified actor and detaches them from thisSOAPHeader
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.- Parameters:
actor
- aString
giving the URI of the actor for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor - See Also:
examineHeaderElements(java.lang.String)
-
examineMustUnderstandHeaderElements
java.util.Iterator examineMustUnderstandHeaderElements(java.lang.String actor)
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object that have the specified actor and that have a MustUnderstand attribute whose value is equivalent totrue
.- Parameters:
actor
- aString
giving the URI of the actor for which to search- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects that contain the specified actor and are marked as MustUnderstand
-
examineAllHeaderElements
java.util.Iterator examineAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object.- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
-
extractAllHeaderElements
java.util.Iterator extractAllHeaderElements()
Returns anIterator
over all theSOAPHeaderElement
objects in thisSOAPHeader
object and detaches them from thisSOAPHeader
object.- Returns:
- an
Iterator
object over all theSOAPHeaderElement
objects contained by thisSOAPHeader
-
-