org.apache.axiom.soap.impl.dom
Class SOAPHeaderImpl
java.lang.Object
org.apache.axiom.om.impl.dom.NodeImpl
org.apache.axiom.om.impl.dom.ChildNode
org.apache.axiom.om.impl.dom.ParentNode
org.apache.axiom.om.impl.dom.ElementImpl
org.apache.axiom.soap.impl.dom.SOAPElement
org.apache.axiom.soap.impl.dom.SOAPHeaderImpl
- All Implemented Interfaces:
- java.lang.Cloneable, org.w3c.dom.Element, org.w3c.dom.Node, org.w3c.dom.NodeList, OMConstants, OMContainer, OMContainerEx, OMElement, OMNode, OMNodeEx, SOAPHeader
- Direct Known Subclasses:
- SOAP11HeaderImpl, SOAP12HeaderImpl
- public abstract class SOAPHeaderImpl
- extends SOAPElement
- implements SOAPHeader
Fields inherited from interface org.w3c.dom.Node |
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE |
Fields inherited from interface org.apache.axiom.om.OMConstants |
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, XMLNS_NS_PREFIX, XMLNS_NS_URI, XMLNS_PREFIX, XMLNS_URI |
Method Summary |
abstract SOAPHeaderBlock |
addHeaderBlock(java.lang.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. |
java.util.Iterator |
examineAllHeaderBlocks()
Returns an Iterator over all the SOAPHeaderBlock objects in this
SOAPHeader object. |
java.util.Iterator |
examineHeaderBlocks(java.lang.String paramRole)
Returns a list of all the SOAPHeaderBlock objects in this
SOAPHeader object that have the the specified actor. |
java.util.Iterator |
examineMustUnderstandHeaderBlocks(java.lang.String actor)
Returns an Iterator over all the SOAPHeaderBlock objects in this
SOAPHeader object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to true . |
java.util.Iterator |
extractAllHeaderBlocks()
Returns an Iterator over all the SOAPHeaderBlock objects in this
SOAPHeader object and detaches them from this SOAPHeader object. |
abstract java.util.Iterator |
extractHeaderBlocks(java.lang.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. |
java.util.ArrayList |
getHeaderBlocksWithNSURI(java.lang.String nsURI)
Return all the Headers that has the Namespace URI to given NS URI. |
java.util.Iterator |
getHeadersToProcess(RolePlayer rolePlayer)
Get the appropriate set of headers for a RolePlayer. |
Methods inherited from class org.apache.axiom.om.impl.dom.ElementImpl |
addAttribute, addAttribute, buildWithAttachments, cloneNode, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, discard, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getElementsByTagName, getElementsByTagNameNS, getFirstElement, getLineNumber, getLocalName, getNamespace, getNamespaceURI, getNamespaceURI, getNextOMSibling, getNodeName, getNodeType, getPrefix, getQName, getSchemaTypeInfo, getTagName, getText, getTextAsQName, getTrimmedText, getType, getXMLStreamReader, getXMLStreamReaderWithoutCaching, hasAttribute, hasAttributeNS, hasAttributes, internalSerialize, internalSerialize, internalSerializeAndConsume, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeNamespace, resolveQName, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setBuilder, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setOwnerDocument, setText, setText, setType, toString, toStringWithConsume |
Methods inherited from class org.apache.axiom.om.impl.dom.ParentNode |
addChild, buildNext, getChildNodes, getChildren, getChildrenWithName, getFirstChild, getFirstChildWithName, getFirstOMChild, getLastChild, hasChildNodes, importNode, insertBefore, removeChild, replaceChild, setFirstChild |
Methods inherited from class org.apache.axiom.om.impl.dom.ChildNode |
detach, getNextSibling, getParent, getParentNode, getPreviousOMSibling, getPreviousSibling, insertSiblingAfter, insertSiblingBefore, setNextOMSibling, setParent, setPreviousOMSibling |
Methods inherited from class org.apache.axiom.om.impl.dom.NodeImpl |
appendChild, build, compareDocumentPosition, getBaseURI, getFeature, getLength, getNodeValue, getOMFactory, getOwnerDocument, getTextContent, getUserData, internalSerializeWithCache, isComplete, isDefaultNamespace, isEqualNode, isSameNode, isSupported, item, lookupNamespaceURI, lookupPrefix, normalize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNodeValue, setPrefix, setTextContent, setUserData |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.axiom.om.OMElement |
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getLocalName, getNamespace, getQName, getText, getTextAsQName, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeAttribute, resolveQName, setBuilder, setFirstChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume |
Methods inherited from interface org.apache.axiom.om.OMNode |
build, buildWithAttachments, detach, discard, getNextOMSibling, getOMFactory, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore, isComplete, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume |
Methods inherited from interface org.w3c.dom.Node |
appendChild, getChildNodes, getFirstChild, getLastChild, getNextSibling, getNodeValue, getOwnerDocument, getParentNode, getPreviousSibling, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix |
SOAPHeaderImpl
public SOAPHeaderImpl(SOAPEnvelope envelope,
SOAPFactory factory)
throws SOAPProcessingException
- Parameters:
envelope
-
SOAPHeaderImpl
public SOAPHeaderImpl(SOAPEnvelope envelope,
OMXMLParserWrapper builder,
SOAPFactory factory)
- Constructor SOAPHeaderImpl
- Parameters:
envelope
- builder
-
addHeaderBlock
public abstract SOAPHeaderBlock addHeaderBlock(java.lang.String localName,
OMNamespace ns)
throws OMException
- Creates a new
SOAPHeaderBlock
object initialized with the specified name and
adds it to this SOAPHeader
object.
- Specified by:
addHeaderBlock
in interface SOAPHeader
- Parameters:
localName
- ns
-
- Returns:
- the new
SOAPHeaderBlock
object that was inserted into this
SOAPHeader
object
- Throws:
OMException
- if a SOAP error occurs
OMException
getHeadersToProcess
public java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer)
- Get the appropriate set of headers for a 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.
- Specified by:
getHeadersToProcess
in interface SOAPHeader
- Returns:
- an Iterator over all the HeaderBlocks this RolePlayer should process.
examineHeaderBlocks
public java.util.Iterator examineHeaderBlocks(java.lang.String paramRole)
- Returns a list of all the
SOAPHeaderBlock
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.
- Specified by:
examineHeaderBlocks
in interface SOAPHeader
- Parameters:
paramRole
- a String
giving the URI of the actor for which to search
- Returns:
- an
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified actor - See Also:
extractHeaderBlocks(java.lang.String)
extractHeaderBlocks
public abstract java.util.Iterator extractHeaderBlocks(java.lang.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. 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.
- Specified by:
extractHeaderBlocks
in interface SOAPHeader
- Parameters:
role
- a String
giving the URI of the role for which to search
- Returns:
- an
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified role - See Also:
examineHeaderBlocks(java.lang.String)
examineMustUnderstandHeaderBlocks
public java.util.Iterator examineMustUnderstandHeaderBlocks(java.lang.String actor)
- Returns an
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object that have the specified actor and that have a MustUnderstand
attribute whose value is equivalent to true
.
- Specified by:
examineMustUnderstandHeaderBlocks
in interface SOAPHeader
- Parameters:
actor
- a String
giving the URI of the actor for which to search
- Returns:
- an
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified actor and are marked as MustUnderstand
examineAllHeaderBlocks
public java.util.Iterator examineAllHeaderBlocks()
- Returns an
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object. Not that this will return elements containing the QName
(http://schemas.xmlsoap.org/soap/envelope/, Header)
- Specified by:
examineAllHeaderBlocks
in interface SOAPHeader
- Returns:
- an
Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
extractAllHeaderBlocks
public java.util.Iterator extractAllHeaderBlocks()
- Returns an
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object and detaches them from this SOAPHeader
object.
- Specified by:
extractAllHeaderBlocks
in interface SOAPHeader
- Returns:
- an
Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
getHeaderBlocksWithNSURI
public java.util.ArrayList getHeaderBlocksWithNSURI(java.lang.String nsURI)
- Description copied from interface:
SOAPHeader
- Return all the Headers that has the Namespace URI to given NS URI.
- Specified by:
getHeaderBlocksWithNSURI
in interface SOAPHeader
- Parameters:
nsURI
-
- Returns:
- Returns ArrayList.
checkParent
protected void checkParent(OMElement parent)
throws SOAPProcessingException
- Description copied from class:
SOAPElement
- This has to be implemented by all the derived classes to check for the correct parent.
- Specified by:
checkParent
in class SOAPElement
- Throws:
SOAPProcessingException