|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.axiom.om.impl.llom.OMNodeImpl
org.apache.axiom.om.impl.llom.OMElementImpl
org.apache.axiom.soap.impl.llom.SOAPElement
org.apache.axiom.soap.impl.llom.SOAPHeaderImpl
public abstract class SOAPHeaderImpl
A class representing the SOAP Header, primarily allowing access to the contained HeaderBlocks.
Nested Class Summary | |
---|---|
(package private) class |
SOAPHeaderImpl.HeaderIterator
An Iterator which walks the header list as needed, potentially filtering as we traverse. |
Field Summary | |
---|---|
(package private) static org.apache.commons.logging.Log |
log
|
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl |
---|
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns |
Fields inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl |
---|
builder, done, factory, nextSibling, nodeType, parent, previousSibling |
Fields inherited from interface org.apache.axiom.om.OMNode |
---|
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_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 |
Constructor Summary | |
---|---|
protected |
SOAPHeaderImpl(org.apache.axiom.om.OMNamespace ns,
org.apache.axiom.soap.SOAPFactory factory)
|
|
SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope,
org.apache.axiom.om.OMXMLParserWrapper builder,
org.apache.axiom.soap.SOAPFactory factory)
Constructor SOAPHeaderImpl |
|
SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope,
org.apache.axiom.soap.SOAPFactory factory)
|
Method Summary | |
---|---|
void |
addChild(org.apache.axiom.om.OMNode child)
Adds child to the element. |
abstract org.apache.axiom.soap.SOAPHeaderBlock |
addHeaderBlock(java.lang.String localName,
org.apache.axiom.om.OMNamespace ns)
Creates a new SOAPHeaderBlock object initialized with the specified name and
adds it to this SOAPHeader object. |
protected void |
checkParent(org.apache.axiom.om.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 role)
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 . |
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)
|
java.util.Iterator |
getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer)
Get the appropriate set of headers for a RolePlayer. |
java.util.Iterator |
getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer,
java.lang.String namespace)
Get the appropriate set of headers for a RolePlayer. |
Methods inherited from class org.apache.axiom.soap.impl.llom.SOAPElement |
---|
registerContentHandler, setParent |
Methods inherited from class org.apache.axiom.om.impl.llom.OMNodeImpl |
---|
close, getOMFactory, getParent, getPreviousOMSibling, importNode, insertSiblingAfter, insertSiblingBefore, serialize, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setComplete, setNextOMSibling, setPreviousOMSibling, setType |
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, close, 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.apache.axiom.om.OMContainer |
---|
buildNext, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getFirstChildWithName, getFirstOMChild, isComplete |
Methods inherited from interface org.apache.axiom.om.impl.OMContainerEx |
---|
setComplete |
Field Detail |
---|
static org.apache.commons.logging.Log log
Constructor Detail |
---|
protected SOAPHeaderImpl(org.apache.axiom.om.OMNamespace ns, org.apache.axiom.soap.SOAPFactory factory)
public SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.soap.SOAPFactory factory) throws org.apache.axiom.soap.SOAPProcessingException
org.apache.axiom.soap.SOAPProcessingException
public SOAPHeaderImpl(org.apache.axiom.soap.SOAPEnvelope envelope, org.apache.axiom.om.OMXMLParserWrapper builder, org.apache.axiom.soap.SOAPFactory factory)
envelope
- builder
- Method Detail |
---|
public abstract org.apache.axiom.soap.SOAPHeaderBlock addHeaderBlock(java.lang.String localName, org.apache.axiom.om.OMNamespace ns) throws org.apache.axiom.om.OMException
SOAPHeaderBlock
object initialized with the specified name and
adds it to this SOAPHeader
object.
addHeaderBlock
in interface org.apache.axiom.soap.SOAPHeader
localName
- ns
-
SOAPHeaderBlock
object that was inserted into this
SOAPHeader
object
org.apache.axiom.om.OMException
- if a SOAP error occurs
org.apache.axiom.om.OMException
public java.util.Iterator getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer)
getHeadersToProcess
in interface org.apache.axiom.soap.SOAPHeader
public java.util.Iterator getHeadersToProcess(org.apache.axiom.soap.RolePlayer rolePlayer, java.lang.String namespace)
getHeadersToProcess
in interface org.apache.axiom.soap.SOAPHeader
rolePlayer
- a RolePlayer containing our role configurationnamespace
- if specified, we'll only return headers from this namespace
public java.util.Iterator examineHeaderBlocks(java.lang.String role)
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.
examineHeaderBlocks
in interface org.apache.axiom.soap.SOAPHeader
role
- a String
giving the URI of the actor for which to search
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified actorextractHeaderBlocks(java.lang.String)
public abstract java.util.Iterator extractHeaderBlocks(java.lang.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.
extractHeaderBlocks
in interface org.apache.axiom.soap.SOAPHeader
role
- a String
giving the URI of the role for which to search
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified roleexamineHeaderBlocks(java.lang.String)
public java.util.Iterator examineMustUnderstandHeaderBlocks(java.lang.String actor)
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
.
examineMustUnderstandHeaderBlocks
in interface org.apache.axiom.soap.SOAPHeader
actor
- a String
giving the URI of the actor for which to search
Iterator
object over all the SOAPHeaderBlock
objects
that contain the specified actor and are marked as MustUnderstandpublic java.util.Iterator examineAllHeaderBlocks()
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)
examineAllHeaderBlocks
in interface org.apache.axiom.soap.SOAPHeader
Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
public java.util.Iterator extractAllHeaderBlocks()
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object and detaches them from this SOAPHeader
object.
extractAllHeaderBlocks
in interface org.apache.axiom.soap.SOAPHeader
Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
public java.util.ArrayList getHeaderBlocksWithNSURI(java.lang.String nsURI)
getHeaderBlocksWithNSURI
in interface org.apache.axiom.soap.SOAPHeader
protected void checkParent(org.apache.axiom.om.OMElement parent) throws org.apache.axiom.soap.SOAPProcessingException
SOAPElement
checkParent
in class SOAPElement
org.apache.axiom.soap.SOAPProcessingException
public void addChild(org.apache.axiom.om.OMNode child)
OMElementImpl
addChild
in interface org.apache.axiom.om.OMContainer
addChild
in class OMElementImpl
public static java.lang.String exceptionToString(java.lang.Throwable e)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |