public interface SOAPHeaderBlock extends OMSourcedElement
An object representing the contents in the SOAP header part of the SOAP envelope. The
immediate children of a SOAPHeader object can be represented only as
SOAPHeaderBlock objects.
B SOAPHeaderBlock object can have other
OMElement objects as its children.
| Modifier and Type | Field and Description |
|---|---|
static String |
MUST_UNDERSTAND_PROPERTY |
static String |
RELAY_PROPERTY |
static String |
ROLE_PROPERTY
A SOAPHeaderBlock may be represented as an unexpanded OMSourcedElement.
|
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE| Modifier and Type | Method and Description |
|---|---|
boolean |
getMustUnderstand()
Returns the boolean value of the mustUnderstand attribute for this header block.
|
boolean |
getRelay()
Returns the relay status associated with this
SOAPHeaderBlock object. |
String |
getRole()
Returns the uri of the actor associated with this
SOAPHeaderBlock object. |
SOAPVersion |
getVersion()
What SOAP version is this HeaderBlock?
|
boolean |
isProcessed() |
void |
setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this
SOAPHeaderBlock object to be on or
off. |
void |
setMustUnderstand(String mustUnderstand)
Deprecated.
Use
setMustUnderstand(boolean) instead. |
void |
setProcessed()
We need to know whether all the mustUnderstand headers have been processed by the node.
|
void |
setRelay(boolean relay)
Sets the relay attribute for this SOAPHeaderBlock to be either true or false.
|
void |
setRole(String roleURI)
Sets the actor associated with this
SOAPHeaderBlock object to the specified
actor. |
getDataSource, getObject, isExpanded, setDataSourceaddAttribute, 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, 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, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildrenbuild, close, isComplete, serialize, serialize, serializeAndConsumeclone, getOMFactorygetLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, hasName, setLocalName, setNamespacestatic final String ROLE_PROPERTY
static final String RELAY_PROPERTY
static final String MUST_UNDERSTAND_PROPERTY
void setRole(String roleURI)
SOAPHeaderBlock object to the specified
actor.roleURI - a String giving the URI of the actor to setIllegalArgumentException - if there is a problem in setting the actor.getRole()String getRole()
SOAPHeaderBlock object.String giving the URI of the actorsetRole(java.lang.String)void setMustUnderstand(boolean mustUnderstand)
SOAPHeaderBlock object to be on or
off. If the mustUnderstand attribute is on, the actor who receives the
SOAPHeaderBlock must process it correctly. This ensures, for example, that if
the SOAPHeaderBlock object modifies the message, that the message is being
modified correctly.
mustUnderstand - true to set the mustUnderstand attribute on;
false to turn if offIllegalArgumentException - if there is a problem in setting the actor.getMustUnderstand()void setMustUnderstand(String mustUnderstand) throws SOAPProcessingException
setMustUnderstand(boolean) instead.SOAPProcessingExceptionboolean getMustUnderstand()
throws SOAPProcessingException
true if a mustUnderstand attribute is present and its value is
equivalent to true, false if the mustUnderstand is not present
or its value is equivalent to falseSOAPProcessingException - if the mustUnderstand attribute is present, but has an invalid valueboolean isProcessed()
void setProcessed()
void setRelay(boolean relay)
relay - a boolean giving the value to be setboolean getRelay()
SOAPHeaderBlock object.boolean giving the relay statusSOAPVersion getVersion()
Copyright © The Apache Software Foundation. All Rights Reserved.