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(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 in a particular 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.
|
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getQName, getText, getTextAsQName, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore
addChild, buildNext, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching
build, close, getOMFactory, isComplete, serialize, serialize, serializeAndConsume
SOAPHeaderBlock addHeaderBlock(String localName, OMNamespace ns) throws OMException
SOAPHeaderBlock
object initialized with the specified name and
adds it to this SOAPHeader
object.localName
- ns
- SOAPHeaderBlock
object that was inserted into this
SOAPHeader
objectOMException
- if a SOAP error occursIterator getHeadersToProcess(RolePlayer rolePlayer)
Iterator 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. An 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
SOAPHeader
object, the message is sent to its ultimate destination.role
- a String
giving the URI of the role for which to searchIterator
object over all the SOAPHeaderBlock
objects that contain the specified roleextractHeaderBlocks(java.lang.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
- a String
giving the URI of the role for which to searchIterator
object over all the SOAPHeaderBlock
objects that contain the specified roleexamineHeaderBlocks(java.lang.String)
Iterator examineMustUnderstandHeaderBlocks(String role)
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
.role
- a String
giving the URI of the role for which to searchIterator
object over all the SOAPHeaderBlock
objects that contain the specified role and are marked as MustUnderstand.Iterator examineAllHeaderBlocks()
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object.Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
. If there are no header blocks then an
empty iterator is returned.Iterator extractAllHeaderBlocks()
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object and detaches them from this SOAPHeader
object.Iterator
object over all the SOAPHeaderBlock
objects contained by this SOAPHeader
ArrayList getHeaderBlocksWithNSURI(String nsURI)
nsURI
- Iterator getHeadersToProcess(RolePlayer rolePlayer, String namespace)
rolePlayer
- a RolePlayer containing our role configurationnamespace
- if specified, we'll only return headers from this namespaceCopyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.