Package org.springframework.ws.soap

Interface SoapHeaderElement

All Superinterfaces:

SoapElement

public interface SoapHeaderElement
extends SoapElement

Represents the contents of an individual SOAP header in the a SOAP message. All SoapHeaderElements are contained in a SoapHeader.

Since:

1.0.0

Author:

Arjen Poutsma

See Also:

• SoapHeader

Method Summary

Modifier and Type	Method	Description
String	getActorOrRole()	Returns the actor or role for this header element.
boolean	getMustUnderstand()	Indicates whether the mustUnderstand attribute for this header element is set.
Result	getResult()	Returns a Result that allows for writing to the contents of the header element.
String	getText()	Returns the text content of this header element, if any.
void	setActorOrRole(String actorOrRole)	Sets the actor or role for this header element.
void	setMustUnderstand(boolean mustUnderstand)	Sets the mustUnderstand attribute for this header element.
void	setText(String content)	Sets the text content of this header element.

Methods inherited from interface org.springframework.ws.soap.SoapElement

addAttribute, addNamespaceDeclaration, getAllAttributes, getAttributeValue, getName, getSource, removeAttribute

Method Details

getActorOrRole

String getActorOrRole()
               throws SoapHeaderException

Returns the actor or role for this header element. In a SOAP 1.1 compliant message, this will read the actor attribute; in SOAP 1.2, the role attribute.

Returns:

the role of the header

Throws:

SoapHeaderException

setActorOrRole

void setActorOrRole(String actorOrRole)
             throws SoapHeaderException

Sets the actor or role for this header element. In a SOAP 1.1 compliant message, this will result in an actor attribute being set; in SOAP 1.2, a actorOrRole attribute.

Parameters:

actorOrRole - the actorOrRole value

Throws:

SoapHeaderException

getMustUnderstand

boolean getMustUnderstand()
                   throws SoapHeaderException

Indicates whether the mustUnderstand attribute for this header element is set.

Returns:

true if the mustUnderstand attribute is set; false otherwise

Throws:

SoapHeaderException

setMustUnderstand

void setMustUnderstand(boolean mustUnderstand)
                throws SoapHeaderException

Sets the mustUnderstand attribute for this header element. If the attribute is on, the role who receives the header must process it.

Parameters:

mustUnderstand - true to set the mustUnderstand attribute on; false to turn it off

Throws:

SoapHeaderException

getResult

Result getResult()
          throws SoapHeaderException

Returns a Result that allows for writing to the contents of the header element.

Throws:

SoapHeaderException

getText

String getText()

Returns the text content of this header element, if any.

Returns:

the text content of this header element

setText

void setText(String content)

Sets the text content of this header element.

Parameters:

content - the new text content of this header element