|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SOAPHeaderBlock
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.
Field Summary |
---|
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 |
Method Summary | |
---|---|
boolean |
getMustUnderstand()
Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on. |
java.lang.String |
getRole()
Returns the uri of the actor associated with this
SOAPHeaderBlock object. |
boolean |
isProcessed()
|
void |
setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this SOAPHeaderBlock
object to be on or off. |
void |
setMustUnderstand(java.lang.String mustUnderstand)
|
void |
setProcessed()
We need to know whether all the mustUnderstand headers have been processed by the node. |
void |
setRole(java.lang.String roleURI)
Sets the actor associated with this SOAPHeaderBlock object
to the specified actor. |
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.apache.axiom.om.OMContainer |
---|
addChild, buildNext, getChildren, getChildrenWithName, getFirstChildWithName, getFirstOMChild, isComplete |
Method Detail |
---|
void setRole(java.lang.String roleURI)
SOAPHeaderBlock
object
to the specified actor.
roleURI
- a String
giving the URI of the actor to set
java.lang.IllegalArgumentException
- if there is a problem in setting the actor.getRole()
java.lang.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 off
java.lang.IllegalArgumentException
- if there is a problem in setting the actor.getMustUnderstand()
void setMustUnderstand(java.lang.String mustUnderstand) throws SOAPProcessingException
SOAPProcessingException
boolean getMustUnderstand() throws SOAPProcessingException
SOAPHeaderBlock
object is turned on.
true
if the mustUnderstand attribute of this
SOAPHeaderBlock
object is turned on;
false
otherwise
SOAPProcessingException
boolean isProcessed()
void setProcessed()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |