Overview Package Class Use Tree Index Deprecated About
Prev Class | Next ClassFrames | No Frames
Summary: Nested | Field | Method | ConstrDetail: Nested | Field | Method | Constr

javax.xml.soap

Interface SOAPHeaderElement

All Superinterfaces:
org.w3c.dom.Element, Node, SOAPElement
Known Implementing Classes:
RPCHeaderParam, SOAPHeaderElement
public interface SOAPHeaderElement
extends SOAPElement
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 SOAPHeaderElement objects.

A SOAPHeaderElement object can have other SOAPElement objects as its children.

Method Summary

abstract String
getActor()
Returns the uri of the actor associated with this SOAPHeaderElement object.
abstract boolean
getMustUnderstand()
Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
abstract void
setActor(String actorURI)
Sets the actor associated with this SOAPHeaderElement object to the specified actor.
abstract void
setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.

Methods inherited from interface javax.xml.soap.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface javax.xml.soap.SOAPElement

addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle

Method Details

getActor

public abstract String getActor()
Returns the uri of the actor associated with this SOAPHeaderElement object.
Returns:
a String giving the URI of the actor
See Also:
setActor(java.lang.String)

getMustUnderstand

public abstract boolean getMustUnderstand()
Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
Returns:
true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

setActor

public abstract void setActor(String actorURI)
Sets the actor associated with this SOAPHeaderElement object to the specified actor. The default value of an actor is: SOAPConstants.URI_SOAP_ACTOR_NEXT
Parameters:
actorURI - a String giving the URI of the actor to set
See Also:
getActor()

setMustUnderstand

public abstract void setMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.

If the mustUnderstand attribute is on, the actor who receives the SOAPHeaderElement must process it correctly. This ensures, for example, that if the SOAPHeaderElement 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
See Also:
getMustUnderstand()

Overview Package Class Use Tree Index Deprecated About
Copyright © 2005 Apache Web Services Project. All Rights Reserved.