org.apache.axiom.soap
Interface SOAPHeaderBlock

All Superinterfaces:
OMContainer, OMElement, OMInformationItem, OMNamedInformationItem, OMNode, OMSerializable, OMSourcedElement

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.


Field Summary
static String MUST_UNDERSTAND_PROPERTY
           
static String RELAY_PROPERTY
           
static String ROLE_PROPERTY
          A SOAPHeaderBlock may be represented as an unexpanded OMSourcedElement.
 
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.
 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)
           
 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.
 
Methods inherited from interface org.apache.axiom.om.OMSourcedElement
getDataSource, getObject, isExpanded, setDataSource
 
Methods inherited from interface org.apache.axiom.om.OMElement
addAttribute, 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, writeTextTo
 
Methods inherited from interface org.apache.axiom.om.OMNode
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore
 
Methods inherited from interface org.apache.axiom.om.OMContainer
addChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren
 
Methods inherited from interface org.apache.axiom.om.OMSerializable
build, close, isComplete, serialize, serialize, serializeAndConsume
 
Methods inherited from interface org.apache.axiom.om.OMInformationItem
clone, getOMFactory
 
Methods inherited from interface org.apache.axiom.om.OMNamedInformationItem
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, setLocalName
 

Field Detail

ROLE_PROPERTY

static final String ROLE_PROPERTY
A SOAPHeaderBlock may be represented as an unexpanded OMSourcedElement. In such cases, the underlying OMDataSource may have a property that contains the value of the ROLE/ACTOR, RELAY or MUST_UNDERSTAND setting.

See Also:
Constant Field Values

RELAY_PROPERTY

static final String RELAY_PROPERTY
See Also:
Constant Field Values

MUST_UNDERSTAND_PROPERTY

static final String MUST_UNDERSTAND_PROPERTY
See Also:
Constant Field Values
Method Detail

setRole

void setRole(String roleURI)
Sets the actor associated with this SOAPHeaderBlock object to the specified actor.

Parameters:
roleURI - a String giving the URI of the actor to set
Throws:
IllegalArgumentException - if there is a problem in setting the actor.
See Also:
getRole()

getRole

String getRole()
Returns the uri of the actor associated with this SOAPHeaderBlock object.

Returns:
a String giving the URI of the actor
See Also:
setRole(java.lang.String)

setMustUnderstand

void setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this 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.

Parameters:
mustUnderstand - true to set the mustUnderstand attribute on; false to turn if off
Throws:
IllegalArgumentException - if there is a problem in setting the actor.
See Also:
getMustUnderstand()

setMustUnderstand

void setMustUnderstand(String mustUnderstand)
                       throws SOAPProcessingException
Throws:
SOAPProcessingException

getMustUnderstand

boolean getMustUnderstand()
                          throws SOAPProcessingException
Returns whether the mustUnderstand attribute for this SOAPHeaderBlock object is turned on.

Returns:
true if the mustUnderstand attribute of this SOAPHeaderBlock object is turned on; false otherwise
Throws:
SOAPProcessingException

isProcessed

boolean isProcessed()

setProcessed

void setProcessed()
We need to know whether all the mustUnderstand headers have been processed by the node. This will done by a specific validation handler at the end of the execution chain. For this all the handlers who process a particular header block must explicitly say that he processesd the header by calling setProcessed()


setRelay

void setRelay(boolean relay)
Sets the relay attribute for this SOAPHeaderBlock to be either true or false. The SOAP relay attribute is set to true to indicate that the SOAP header block must be relayed by any node that is targeted by the header block but not actually process it.

Parameters:
relay - a boolean giving the value to be set

getRelay

boolean getRelay()
Returns the relay status associated with this SOAPHeaderBlock object.

Returns:
a boolean giving the relay status

getVersion

SOAPVersion getVersion()
What SOAP version is this HeaderBlock?

Returns:
a SOAPVersion, one of the two singletons.


Copyright © 2004-2012 The Apache Software Foundation. All Rights Reserved.