rwsf::SoapHeaderType Class Reference

Represents a SOAP header element. More...

#include <rwsf/webservice/SoapHeaderType.h>

Inheritance diagram for rwsf::SoapHeaderType:

Public Member Functions
	SoapHeaderType ()
	SoapHeaderType (const SoapHeaderType &other)
	~SoapHeaderType ()
virtual rwsf::XmlName	getDefaultElementName () const
SoapHeaderType &	operator= (const SoapHeaderType &rhs)
void	unmarshal (rwsf::XmlReader &reader, rwsf::CallInfo &info, rwsf::TypeUtils::messageType type)
Public Member Functions inherited from rwsf::SoapBase
	SoapBase ()
	SoapBase (const SoapBase &sb)
virtual	~SoapBase ()
bool	getXsiNil () const
std::string	getXsiNoNamespaceSchemaLocation () const
std::string	getXsiSchemaLocation () const
std::string	getXsiType () const
bool	isXsiNilSet () const
bool	isXsiNoNamespaceSchemaLocationSet () const
bool	isXsiSchemaLocationSet () const
bool	isXsiTypeSet () const
void	setXsiNil (bool XsiNil)
void	setXsiNilSet (bool setValue)
void	setXsiNoNamespaceSchemaLocation (const std::string &XsiNoNamespaceSchemaLocation)
void	setXsiNoNamespaceSchemaLocationSet (bool setValue)
void	setXsiSchemaLocation (const std::string &XsiSchemaLocation)
void	setXsiSchemaLocationSet (bool setValue)
void	setXsiType (const std::string &XsiType)
void	setXsiTypeSet (bool setValue)

Additional Inherited Members
Protected Member Functions inherited from rwsf::SoapBase
virtual void	populateAttributes (rwsf::XmlAttributeSet &attributes) const
void	unmarshalAttributes (rwsf::XmlAttributeSet &attrs)

Detailed Description

rwsf::SoapHeaderType corresponds to the SOAP header element. Each instance contains a collection of rwsf::XmlName instances representing the four SOAP header elements:

header
actor
mustUnderstand
type

Note

This class is used by the generated skeletons to manipulate SOAP messages. Typically you will not need to use this class directly unless you are creating your own skeleton or a custom handler which manipulates SOAP messages.

Constructor & Destructor Documentation

rwsf::SoapHeaderType::SoapHeaderType

(

)

Default constructor. Constructs an empty header.

rwsf::SoapHeaderType::~SoapHeaderType

(

)

Destructor.

rwsf::SoapHeaderType::SoapHeaderType

(

const SoapHeaderType &

other

)

Copy constructor.

Member Function Documentation

virtual rwsf::XmlName rwsf::SoapHeaderType::getDefaultElementName ( ) const

virtual

Returns an instance of rwsf::XmlName with fixed values in which the local name is set to "Header", the namespace prefix is set to "SOAP-ENV", and the namespace URI is set to "http://schemas.xmlsoap.org/soap/envelope/".

Implements rwsf::SoapBase.

SoapHeaderType& rwsf::SoapHeaderType::operator=

(

const SoapHeaderType &

rhs

)

Assignment operator.

void rwsf::SoapHeaderType::unmarshal	(	rwsf::XmlReader &	reader,
		rwsf::CallInfo &	info,
		rwsf::TypeUtils::messageType	type
	)

Parses all SOAP headers under the SOAP header element using reader as a source. The XmlReader reader should be set up with its position at the beginning of the SOAP header element. After this function completes, the reader will have its internal cursor positioned just after the SOAP header element.

For each header under the SOAP header element, this function adds a request header or a response header to the info object, so that it contains the data present in the parsed header.

If type is set to TypeUtils::requestType, a request header is added. Likewise, if type is set to TypeUtils::responseType, a response header is added.

For more information on the header function, see rwsf::CallInfo and the Headers chapter in the Web Service Development Guide. Header elements are user-defined and can be any valid XML element. Any number of child elements may be present under the SOAP header element, and each child will be taken to be a separate header.

If the XML (either for the parent SOAP header element, or any of the user-defined header elements under it) is malformed, an XmlException is thrown.