FileDocCategorySizeDatePackage
SOAPHeaderElement.javaAPI DocApache Axis 1.43090Sat Apr 22 18:57:28 BST 2006javax.xml.soap

SOAPHeaderElement

public interface SOAPHeaderElement implements 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.

Fields Summary
Constructors Summary
Methods Summary
public abstract java.lang.StringgetActor()
Returns the uri of the actor associated with this SOAPHeaderElement object.

return
a String giving the URI of the actor
see
#setActor(java.lang.String) setActor(java.lang.String)

public abstract booleangetMustUnderstand()
Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.

return
true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise

public abstract voidsetActor(java.lang.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

param
actorURI a String giving the URI of the actor to set
see
#getActor() getActor()
throws
java.lang.IllegalArgumentException if there is a problem in setting the actor.

public abstract voidsetMustUnderstand(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.

param
mustUnderstand true to set the mustUnderstand attribute on; false to turn if off
throws
java.lang.IllegalArgumentException if there is a problem in setting the actor.
see
#getMustUnderstand() getMustUnderstand()