javax.xml.soap

Interface 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 StringgetActor()
Returns the uri of the actor associated with this SOAPHeaderElement object.
abstract booleangetMustUnderstand()
Returns whether the mustUnderstand attribute for this SOAPHeaderElement object is turned on.
abstract voidsetActor(String actorURI)
Sets the actor associated with this SOAPHeaderElement object to the specified actor.
abstract voidsetMustUnderstand(boolean mustUnderstand)
Sets the mustUnderstand attribute for this SOAPHeaderElement object to be on or off.

Method Detail

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

Throws: java.lang.IllegalArgumentException if there is a problem in setting the actor.

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

Throws: java.lang.IllegalArgumentException if there is a problem in setting the actor.

See Also: getMustUnderstand()

Copyright B) 2005 Apache Web Services Project. All Rights Reserved.