public abstract class SOAPHeaderImpl extends SOAPElement implements SOAPHeader
| Modifier and Type | Field and Description |
|---|---|
private static org.apache.commons.logging.Log |
log |
attributes, builder, firstChild, lastChild, localName, namespaces, ns, qName, statenextSibling, parent, previousSiblingfactoryCDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODECOMPLETE, DISCARDED, INCOMPLETEARRAY_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| Modifier | Constructor and Description |
|---|---|
protected |
SOAPHeaderImpl(OMNamespace ns,
SOAPFactory factory) |
|
SOAPHeaderImpl(SOAPEnvelope envelope,
OMXMLParserWrapper builder,
SOAPFactory factory)
Constructor SOAPHeaderImpl
|
|
SOAPHeaderImpl(SOAPEnvelope envelope,
SOAPFactory factory) |
| Modifier and Type | Method and Description |
|---|---|
void |
addChild(OMNode child,
boolean fromBuilder) |
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.
|
protected OMElement |
createClone(OMCloneOptions options,
OMContainer targetParent) |
java.util.Iterator |
examineAllHeaderBlocks()
Returns an iterator over all the
SOAPHeaderBlock objects in this SOAPHeader
object. |
java.util.Iterator |
examineHeaderBlocks(java.lang.String role)
Returns a list of all the
SOAPHeaderBlock objects in this SOAPHeader object
that have the the specified role. |
java.util.Iterator |
examineMustUnderstandHeaderBlocks(java.lang.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. |
static java.lang.String |
exceptionToString(java.lang.Throwable e) |
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. |
java.util.Iterator |
getHeadersToProcess(RolePlayer rolePlayer,
java.lang.String namespace)
Get the appropriate set of headers for a RolePlayer and a particular namespace.
|
registerContentHandler, setParentaddAttribute, addAttribute, addChild, addNamespaceDeclaration, build, buildWithAttachments, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, detach, discard, discarded, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getBuilder, getChildElements, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDefaultNamespace, getDescendants, getFirstChildWithName, getFirstElement, getFirstOMChild, getFirstOMChildIfAvailable, getLastKnownOMChild, getLineNumber, getLocalName, getNamespace, getNamespaceContext, getNamespacesInScope, getNamespaceURI, getPrefix, getQName, getSAXSource, getState, getText, getTextAsQName, getTextAsStream, getType, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, internalSerialize, isComplete, removeAttribute, removeChildren, resolveQName, setBuilder, setComplete, setFirstChild, setLastChild, setLineNumber, setLocalName, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextToclone, getIParentNode, getNextOMSibling, getNextOMSiblingIfAvailable, getParent, getPreviousOMSibling, insertSiblingAfter, insertSiblingBefore, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSiblingclose, getOMFactory, serialize, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsumeclone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitaddAttribute, 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, writeTextTobuildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBeforeaddChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildrenbuild, close, isComplete, serialize, serialize, serializeAndConsumeclone, getOMFactorygetLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, setLocalNamegetIParentNodegetNextOMSiblingIfAvailable, internalSerialize, internalSerializeAndConsume, setNextOMSibling, setPreviousOMSiblingprotected SOAPHeaderImpl(OMNamespace ns, SOAPFactory factory)
public SOAPHeaderImpl(SOAPEnvelope envelope, SOAPFactory factory) throws SOAPProcessingException
SOAPProcessingExceptionpublic SOAPHeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
envelope - builder - public SOAPHeaderBlock addHeaderBlock(java.lang.String localName, OMNamespace ns) throws OMException
SOAPHeaderSOAPHeaderBlock object initialized with the specified name and adds it
to this SOAPHeader object.addHeaderBlock in interface SOAPHeaderlocalName - 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 java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer)
SOAPHeaderRolePlayer.
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 SOAPHeaderrolePlayer - the RolePlayer object specifying the role configurationSOAPHeaderBlock objects the RolePlayer should
processpublic java.util.Iterator getHeadersToProcess(RolePlayer rolePlayer, java.lang.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 SOAPHeaderrolePlayer - the RolePlayer object specifying the role configurationnamespace - if specified, we'll only return headers from this namespaceSOAPHeaderBlock objects the RolePlayer should
processpublic java.util.Iterator examineHeaderBlocks(java.lang.String role)
SOAPHeaderSOAPHeaderBlock 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 SOAPHeaderrole - the URI of the role for which to searchSOAPHeaderBlock objects that contain the specified
roleSOAPHeader.extractHeaderBlocks(String)public abstract java.util.Iterator extractHeaderBlocks(java.lang.String role)
SOAPHeaderSOAPHeaderBlock 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 SOAPHeaderrole - the URI of the role for which to searchSOAPHeaderBlock objects that contain the specified
roleSOAPHeader.examineHeaderBlocks(String)public java.util.Iterator examineMustUnderstandHeaderBlocks(java.lang.String actor)
SOAPHeaderSOAPHeaderBlock 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 SOAPHeaderactor - the URI of the role for which to searchSOAPHeaderBlock objects that contain the specified
role and are marked as MustUnderstand.public java.util.Iterator examineAllHeaderBlocks()
SOAPHeaderSOAPHeaderBlock objects in this SOAPHeader
object.examineAllHeaderBlocks in interface SOAPHeaderSOAPHeaderBlock objects contained by this
SOAPHeader. If there are no header blocks then an empty iterator is returned.public java.util.Iterator extractAllHeaderBlocks()
SOAPHeaderSOAPHeaderBlock objects in this SOAPHeader
object and detaches them from this SOAPHeader object.extractAllHeaderBlocks in interface SOAPHeaderSOAPHeaderBlock objects contained by this
SOAPHeaderpublic java.util.ArrayList getHeaderBlocksWithNSURI(java.lang.String nsURI)
SOAPHeadergetHeaderBlocksWithNSURI in interface SOAPHeaderprotected void checkParent(OMElement parent) throws SOAPProcessingException
SOAPElementcheckParent in class SOAPElementSOAPProcessingExceptionpublic void addChild(OMNode child, boolean fromBuilder)
addChild in interface OMContainerExaddChild in class OMElementImplpublic static java.lang.String exceptionToString(java.lang.Throwable e)
protected OMElement createClone(OMCloneOptions options, OMContainer targetParent)
createClone in class OMElementImpl