Top Description Methods
javax.xml.soap

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.

Since
1.6

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

a String giving the URI of the actor
getActor()

Returns the uri of the actor attribute of this SOAPHeaderElement.

public boolean

Returns:

true if the mustUnderstand attribute of this SOAPHeaderElement object is turned on; false otherwise
getMustUnderstand()

Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.

public boolean

Returns:

true if the relay attribute is turned on; false otherwise
getRelay()

Returns the boolean value of the relay attribute for this SOAPHeaderElement

public String

Returns:

a String giving the URI of the Role
getRole()

Returns the value of the Role attribute of this SOAPHeaderElement.

public void
setActor(String
a String giving the URI of the actor to set
actorURI)

Sets the actor associated with this SOAPHeaderElement object to the specified actor.

public void
setMustUnderstand(boolean
true to set the mustUnderstand attribute to true; false to set it to false
mustUnderstand)

Sets the mustUnderstand attribute for this SOAPHeaderElement object to be either true or false.

public void
setRelay(boolean
the new value of the relay attribute
relay)

Sets the relay attribute for this SOAPHeaderElement to be either true or false.

public void
setRole(String
the URI of the Role
uri)

Sets the Role associated with this SOAPHeaderElement object to the specified Role.

Inherited from javax.xml.soap.SOAPElement:
addAttributeaddAttributeaddChildElementaddChildElementaddChildElementaddChildElementaddChildElementaddChildElementaddNamespaceDeclarationaddTextNodecreateQNamegetAllAttributesgetAllAttributesAsQNamesgetAttributeValuegetAttributeValuegetChildElementsgetChildElementsgetChildElementsgetElementNamegetElementQNamegetEncodingStylegetNamespacePrefixesgetNamespaceURIgetVisibleNamespacePrefixesremoveAttributeremoveAttributeremoveContentsremoveNamespaceDeclarationsetElementQNamesetEncodingStyle

Method Detail

getActorback to summary
public 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 getRole()

Returns:String

a String giving the URI of the actor

See Also
setActor
getMustUnderstandback to summary
public boolean getMustUnderstand()

Returns the boolean value of the mustUnderstand attribute for this SOAPHeaderElement.

Returns:boolean

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

getRelayback to summary
public boolean getRelay()

Returns the boolean value of the relay attribute for this SOAPHeaderElement

Returns:boolean

true if the relay attribute is turned on; false otherwise

Exceptions
UnsupportedOperationException:
if this message does not support the SOAP 1.2 concept of Relay attribute.
Since
1.6, SAAJ 1.3
See Also
getMustUnderstand, setRelay
getRoleback to summary
public String getRole()

Returns the value of the Role attribute of this SOAPHeaderElement.

Returns:String

a String giving the URI of the Role

Exceptions
UnsupportedOperationException:
if this message does not support the SOAP 1.2 concept of Fault Role.
Since
1.6, SAAJ 1.3
setActorback to summary
public 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

If this SOAPHeaderElement supports SOAP 1.2 then this call is equivalent to setRole(String)

Parameters
actorURI:String

a String giving the URI of the actor to set

Exceptions
IllegalArgumentException:
if there is a problem in setting the actor.
See Also
getActor
setMustUnderstandback to summary
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.

Parameters
mustUnderstand:boolean

true to set the mustUnderstand attribute to true; false to set it to false

Exceptions
IllegalArgumentException:
if there is a problem in setting the mustUnderstand attribute
See Also
getMustUnderstand, setRelay
setRelayback to summary
public void setRelay(boolean relay) throws SOAPException

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.

Parameters
relay:boolean

the new value of the relay attribute

Exceptions
SOAPException:
if there is a problem in setting the relay attribute.
UnsupportedOperationException:
if this message does not support the SOAP 1.2 concept of Relay attribute.
Since
1.6, SAAJ 1.3
See Also
setMustUnderstand, getRelay
setRoleback to summary
public void setRole(String uri) throws SOAPException

Sets the Role associated with this SOAPHeaderElement object to the specified Role.

Parameters
uri:String

the URI of the Role

Exceptions
SOAPException:
if there is an error in setting the role
UnsupportedOperationException:
if this message does not support the SOAP 1.2 concept of Fault Role.
Since
1.6, SAAJ 1.3