public interface SOAPHeader extends OMElement
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
Modifier and Type | Method and Description |
---|---|
SOAPHeaderBlock |
addHeaderBlock(QName qname)
Creates a new
SOAPHeaderBlock object initialized with the specified name and adds it
to this SOAPHeader object. |
SOAPHeaderBlock |
addHeaderBlock(String localName,
OMNamespace ns)
Creates a new
SOAPHeaderBlock object initialized with the specified name and adds it
to this SOAPHeader object. |
Iterator |
examineAllHeaderBlocks()
Returns an iterator over all the
SOAPHeaderBlock objects in this SOAPHeader
object. |
Iterator |
examineHeaderBlocks(String role)
Returns a list of all the
SOAPHeaderBlock objects in this SOAPHeader object
that have the the specified role. |
Iterator |
examineMustUnderstandHeaderBlocks(String role)
Returns an iterator over all the
SOAPHeaderBlock objects in this SOAPHeader
object that have the specified role and that have a MustUnderstand attribute whose
value is equivalent to true . |
Iterator |
extractAllHeaderBlocks()
Returns an iterator over all the
SOAPHeaderBlock objects in this SOAPHeader
object and detaches them from this SOAPHeader object. |
Iterator |
extractHeaderBlocks(String role)
Returns a list of all the
SOAPHeaderBlock objects in this SOAPHeader object
that have the the specified role and detaches them from this SOAPHeader object. |
ArrayList |
getHeaderBlocksWithNSURI(String nsURI)
Return all the Headers that has the Namespace URI to given NS URI.
|
Iterator |
getHeadersToProcess(RolePlayer rolePlayer)
Get the appropriate set of headers for a
RolePlayer . |
Iterator |
getHeadersToProcess(RolePlayer rolePlayer,
String namespace)
Get the appropriate set of headers for a RolePlayer and a particular namespace.
|
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setLineNumber, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore
addChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren
build, close, isComplete, serialize, serialize, serializeAndConsume
clone, getOMFactory
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, hasName, setLocalName, setNamespace
SOAPHeaderBlock addHeaderBlock(String localName, OMNamespace ns) throws OMException
SOAPHeaderBlock
object initialized with the specified name and adds it
to this SOAPHeader
object.localName
- the local name of the header blockns
- the namespace of the header block; must not be null
and must specify
a non empty namespace URISOAPHeaderBlock
object that was inserted into this SOAPHeader
objectOMException
- if an error occurs, e.g. if no namespace was specifiedSOAPHeaderBlock addHeaderBlock(QName qname) throws OMException
SOAPHeaderBlock
object initialized with the specified name and adds it
to this SOAPHeader
object.qname
- the name of the header block (which must have a non empty namespace URI)SOAPHeaderBlock
object that was inserted into this SOAPHeader
objectOMException
- if an error occurs, e.g. if the namespace URI specified by the QName
is
emptyIterator getHeadersToProcess(RolePlayer rolePlayer)
RolePlayer
.
The RolePlayer
indicates whether it is the ultimate destination (in which case
headers with no role or the explicit UltimateDestination role will be included), and any
non-standard roles it supports. Headers targeted to "next" will always be included, and those
targeted to "none" (for SOAP 1.2) will never be included.
rolePlayer
- the RolePlayer
object specifying the role configurationSOAPHeaderBlock
objects the RolePlayer should
processIterator examineHeaderBlocks(String role)
SOAPHeaderBlock
objects in this SOAPHeader
object
that have the the specified role. An role is a global attribute that indicates the
intermediate parties to whom the message should be sent. A role receives the message and then
sends it to the next role. The default role is the ultimate intended recipient for the
message, so if no role attribute is included in a SOAPHeaderBlock
object, the message
is sent to its ultimate destination.role
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
roleextractHeaderBlocks(String)
Iterator extractHeaderBlocks(String role)
SOAPHeaderBlock
objects in this SOAPHeader
object
that have the the specified role and detaches them from this SOAPHeader
object.
This method allows an role 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 role.
role
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
roleexamineHeaderBlocks(String)
Iterator examineMustUnderstandHeaderBlocks(String role)
SOAPHeaderBlock
objects in this SOAPHeader
object that have the specified role and that have a MustUnderstand attribute whose
value is equivalent to true
.role
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
role and are marked as MustUnderstand.Iterator examineAllHeaderBlocks()
SOAPHeaderBlock
objects in this SOAPHeader
object.SOAPHeaderBlock
objects contained by this
SOAPHeader
. If there are no header blocks then an empty iterator is returned.Iterator extractAllHeaderBlocks()
SOAPHeaderBlock
objects in this SOAPHeader
object and detaches them from this SOAPHeader
object.SOAPHeaderBlock
objects contained by this
SOAPHeader
ArrayList getHeaderBlocksWithNSURI(String nsURI)
nsURI
- Iterator getHeadersToProcess(RolePlayer rolePlayer, String namespace)
The RolePlayer
indicates whether it is the ultimate destination (in which case
headers with no role or the explicit UltimateDestination role will be included), and any
non-standard roles it supports. Headers targeted to "next" will always be included, and those
targeted to "none" (for SOAP 1.2) will never be included.
This version of the API allows us to iterate only once over the headers searching for a particular namespace for headers targeted at "us".
rolePlayer
- the RolePlayer
object specifying the role configurationnamespace
- if specified, we'll only return headers from this namespaceSOAPHeaderBlock
objects the RolePlayer should
processCopyright © The Apache Software Foundation. All Rights Reserved.