public abstract class SOAPHeaderImpl extends SOAPElement implements SOAPHeader
builder, localName, namespace, state
firstChild, lastChild
factory, FIRSTCHILD, flags, HAS_PARENT, SPECIFIED
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_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
COMPLETE, DISCARDED, INCOMPLETE
ARRAY_ITEM_LOCALNAME, ARRAY_ITEM_NS_PREFIX, ARRAY_ITEM_NSURI, ARRAY_ITEM_QNAME, DATA_HANDLER, DEFAULT_CHAR_SET_ENCODING, DEFAULT_DEFAULT_NAMESPACE, DEFAULT_XML_VERSION, IS_BINARY, IS_DATA_HANDLERS_AWARE, PULL_TYPE_BUILDER, PUSH_TYPE_BUILDER, XMLATTRTYPE_CDATA, XMLATTRTYPE_ENTITIES, XMLATTRTYPE_ENTITY, XMLATTRTYPE_ID, XMLATTRTYPE_IDREF, XMLATTRTYPE_IDREFS, XMLATTRTYPE_NMTOKEN, XMLATTRTYPE_NMTOKENS, XMLATTRTYPE_NOTATION, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI
Constructor and Description |
---|
SOAPHeaderImpl(ParentNode parentNode,
OMNamespace ns,
OMXMLParserWrapper builder,
OMFactory factory,
boolean generateNSDecl) |
SOAPHeaderImpl(SOAPEnvelope envelope,
SOAPFactory factory) |
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. |
protected void |
checkParent(OMElement parent)
This has to be implemented by all the derived classes to check for the correct parent.
|
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 actor)
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. |
abstract 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.
|
setParent
addAttribute, addAttribute, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, createClone, declareDefaultNamespace, declareNamespace, declareNamespace, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getIParentNode, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNextSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getState, getTagName, getText, getTextAsQName, getTextAsStream, getType, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSetNamespace, isComplete, lookupNamespaceURI, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChildren, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setComplete, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setPrefix, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo
addChild, addChild, appendChild, getChildNodes, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChild, getFirstChildWithName, getFirstOMChild, getFirstOMChildIfAvailable, getLastChild, getLastKnownOMChild, getLength, getSAXSource, getTextContent, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasChildNodes, insertBefore, item, removeChild, replaceChild, setFirstChild, setLastChild, setTextContent
clone, cloneNode, close, compareDocumentPosition, detach, getBaseURI, getFeature, getNextOMSiblingIfAvailable, getNodeValue, getOMFactory, getOwnerDocument, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, getUserData, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setNextOMSibling, setNodeValue, setParent, setPreviousOMSibling, setUserData
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
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, setBuilder, 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, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren
build, close, isComplete, serialize, serialize, serializeAndConsume
clone, getOMFactory
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, setLocalName
appendChild, cloneNode, compareDocumentPosition, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, getTextContent, getUserData, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setTextContent, setUserData
getLastKnownOMChild, setFirstChild, setLastChild
addChild
getFirstOMChildIfAvailable
getNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setParent, setPreviousOMSibling
public SOAPHeaderImpl(SOAPEnvelope envelope, SOAPFactory factory) throws SOAPProcessingException
envelope
- SOAPProcessingException
public SOAPHeaderImpl(ParentNode parentNode, OMNamespace ns, OMXMLParserWrapper builder, OMFactory factory, boolean generateNSDecl)
public SOAPHeaderBlock addHeaderBlock(String localName, OMNamespace ns) throws OMException
SOAPHeader
SOAPHeaderBlock
object initialized with the specified name and adds it
to this SOAPHeader
object.addHeaderBlock
in interface SOAPHeader
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 specifiedpublic Iterator getHeadersToProcess(RolePlayer rolePlayer)
SOAPHeader
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.
getHeadersToProcess
in interface SOAPHeader
rolePlayer
- the RolePlayer
object specifying the role configurationSOAPHeaderBlock
objects the RolePlayer should
processpublic Iterator getHeadersToProcess(RolePlayer rolePlayer, String namespace)
SOAPHeader
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".
getHeadersToProcess
in interface SOAPHeader
rolePlayer
- the RolePlayer
object specifying the role configurationnamespace
- if specified, we'll only return headers from this namespaceSOAPHeaderBlock
objects the RolePlayer should
processpublic Iterator examineHeaderBlocks(String role)
SOAPHeader
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.examineHeaderBlocks
in interface SOAPHeader
role
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
roleSOAPHeader.extractHeaderBlocks(String)
public abstract Iterator extractHeaderBlocks(String role)
SOAPHeader
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.
extractHeaderBlocks
in interface SOAPHeader
role
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
roleSOAPHeader.examineHeaderBlocks(String)
public Iterator examineMustUnderstandHeaderBlocks(String actor)
SOAPHeader
SOAPHeaderBlock
objects in this SOAPHeader
object that have the specified role and that have a MustUnderstand attribute whose
value is equivalent to true
.examineMustUnderstandHeaderBlocks
in interface SOAPHeader
actor
- the URI of the role for which to searchSOAPHeaderBlock
objects that contain the specified
role and are marked as MustUnderstand.public Iterator examineAllHeaderBlocks()
SOAPHeader
SOAPHeaderBlock
objects in this SOAPHeader
object.examineAllHeaderBlocks
in interface SOAPHeader
SOAPHeaderBlock
objects contained by this
SOAPHeader
. If there are no header blocks then an empty iterator is returned.public Iterator extractAllHeaderBlocks()
SOAPHeader
SOAPHeaderBlock
objects in this SOAPHeader
object and detaches them from this SOAPHeader
object.extractAllHeaderBlocks
in interface SOAPHeader
SOAPHeaderBlock
objects contained by this
SOAPHeader
public ArrayList getHeaderBlocksWithNSURI(String nsURI)
SOAPHeader
getHeaderBlocksWithNSURI
in interface SOAPHeader
protected void checkParent(OMElement parent) throws SOAPProcessingException
SOAPElement
checkParent
in class SOAPElement
SOAPProcessingException
Copyright © 2004–2021 The Apache Software Foundation. All rights reserved.