|
||||||||||
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.
Field Summary |
---|
Fields inherited from class org.apache.axiom.om.impl.llom.OMElementImpl |
---|
attributes, DEFAULT_DEFAULT_NS_OBJECT, firstChild, lastChild, localName, namespaces, noPrefixNamespaceCounter, ns, qName |
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 |
Constructor Summary | |
---|---|
protected |
SOAPHeaderImpl(OMNamespace ns,
SOAPFactory factory)
|
|
SOAPHeaderImpl(SOAPEnvelope envelope,
OMXMLParserWrapper builder,
SOAPFactory factory)
Constructor SOAPHeaderImpl |
|
SOAPHeaderImpl(SOAPEnvelope envelope,
SOAPFactory factory)
|
Method Summary | |
---|---|
void |
addChild(OMNode child)
Adds child to the element. |
abstract 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 actor. |
Iterator |
examineMustUnderstandHeaderBlocks(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 String |
exceptionToString(Throwable e)
|
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. |
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.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 |
Constructor Detail |
---|
protected SOAPHeaderImpl(OMNamespace ns, SOAPFactory factory)
public SOAPHeaderImpl(SOAPEnvelope envelope, SOAPFactory factory) throws SOAPProcessingException
SOAPProcessingException
public SOAPHeaderImpl(SOAPEnvelope envelope, OMXMLParserWrapper builder, SOAPFactory factory)
envelope
- builder
- Method Detail |
---|
public abstract SOAPHeaderBlock addHeaderBlock(String localName, OMNamespace ns) throws OMException
SOAPHeaderBlock
object initialized with the specified name and
adds it to this SOAPHeader
object.
addHeaderBlock
in interface SOAPHeader
localName
- ns
-
SOAPHeaderBlock
object that was inserted into this
SOAPHeader
object
OMException
- if a SOAP error occurs
OMException
public Iterator getHeadersToProcess(RolePlayer rolePlayer)
getHeadersToProcess
in interface SOAPHeader
public Iterator getHeadersToProcess(RolePlayer rolePlayer, String namespace)
getHeadersToProcess
in interface SOAPHeader
rolePlayer
- a RolePlayer containing our role configurationnamespace
- if specified, we'll only return headers from this namespace
public Iterator examineHeaderBlocks(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 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 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.
extractHeaderBlocks
in interface 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 Iterator examineMustUnderstandHeaderBlocks(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 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 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 SOAPHeader
Iterator
object over all the SOAPHeaderBlock
objects
contained by this SOAPHeader
public Iterator extractAllHeaderBlocks()
Iterator
over all the SOAPHeaderBlock
objects in this
SOAPHeader
object and detaches them from this SOAPHeader
object.
extractAllHeaderBlocks
in interface SOAPHeader
Iterator
object over all the 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
public void addChild(OMNode child)
OMElementImpl
addChild
in interface OMContainer
addChild
in class OMElementImpl
public static String exceptionToString(Throwable e)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |