File	Doc	Category	Size	Date	Package
SOAPHeaderElement.java	API Doc	Java SE 6 API	6105	Tue Jun 10 00:27:10 BST 2008	javax.xml.soap

SOAPHeaderElement

Fields Summary

Constructors Summary

Methods Summary
public java.lang.String	getActor() Returns the uri of the actor attribute of this SOAPHeaderElement. If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to {@link #getRole()} return a String giving the URI of the actor see #setActor
public boolean	getMustUnderstand() Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement. return true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise
public boolean	getRelay() Returns the boolean value of the relay attribute for this SOAPHeaderElement return true if the relay attribute is turned on; false otherwise exception UnsupportedOperationException if this message does not support the SOAP 1.2 concept of Relay attribute. see #getMustUnderstand see #setRelay since SAAJ 1.3
public java.lang.String	getRole() Returns the value of the Role attribute of this SOAPHeaderElement. return a String giving the URI of the Role exception UnsupportedOperationException if this message does not support the SOAP 1.2 concept of Fault Role. since SAAJ 1.3
public void	setActor(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 If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to {@link #setRole(String)} param actorURI a String giving the URI of the actor to set exception IllegalArgumentException if there is a problem in setting the actor. see #getActor
public void	setMustUnderstand(boolean mustUnderstand) Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false. 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 to true; false to set it to false exception IllegalArgumentException if there is a problem in setting the mustUnderstand attribute see #getMustUnderstand see #setRelay
public void	setRelay(boolean relay) Sets the relay attribute for this SOAPHeaderElement 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. This attribute is ignored on header blocks whose mustUnderstand attribute is set to true or that are targeted at the ultimate reciever (which is the default). The default value of this attribute is false. param relay the new value of the relay attribute exception SOAPException if there is a problem in setting the relay attribute. exception UnsupportedOperationException if this message does not support the SOAP 1.2 concept of Relay attribute. see #setMustUnderstand see #getRelay since SAAJ 1.3
public void	setRole(java.lang.String uri) Sets the Role associated with this SOAPHeaderElement object to the specified Role. param uri - the URI of the Role throws SOAPException if there is an error in setting the role exception UnsupportedOperationException if this message does not support the SOAP 1.2 concept of Fault Role. since SAAJ 1.3