Rogue Wave web site:  Home Page  |  Main Documentation Page

rwsf::SoapEnvelopeType Class Reference
[Web Services]

Represents a SOAP envelope. More...

#include <rwsf/webservice/SoapEnvelopeType.h>

Inheritance diagram for rwsf::SoapEnvelopeType:

List of all members.

Public Member Functions
	SoapEnvelopeType ()
	~SoapEnvelopeType ()
const rwsf::SoapHeaderType &	getHeader () const
void	setHeader (const rwsf::SoapHeaderType &Header)
bool	isHeaderSet () const
void	setHeaderSet (bool setValue)
const rwsf::SoapBodyType &	getBody () const
void	setBody (const rwsf::SoapBodyType &Body)
void	beginParse (rwsf::XmlReader &reader, rwsf::CallInfo &info, rwsf::TypeUtils::messageType type, bool isDocLitType)
void	endParse (rwsf::XmlReader &reader)
virtual rwsf::XmlName	getDefaultElementName () const

---

Detailed Description

An instance of rwsf::SoapEnvelopeType represents a SOAP envelope.

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::SoapEnvelopeType::SoapEnvelopeType

(

)

Default constructor. Constructs a SOAP envelope containing an empty body and empty header.

rwsf::SoapEnvelopeType::~SoapEnvelopeType

(

)

Destructor.

---

Member Function Documentation

void rwsf::SoapEnvelopeType::beginParse	(	rwsf::XmlReader &	reader,
		rwsf::CallInfo &	info,
		rwsf::TypeUtils::messageType	type,
		bool	isDocLitType
	)

Parses this SOAP envelope using reader as a source. The XmlReader reader should be set up with its position at the beginning of a SOAP Envelope element. After this function completes, the reader will be positioned just before the end tag for the SOAP Envelope. You then must call endParse() to parse the end tag and set the reader's cursor to a position after the SOAP Envelope.

The info object will be filled in with all of the relevant parameters from the SOAP Envelope. This includes objects such as the operation name, its parameters, etc.

The type parameter should be set to rwsf::TypeUtils::request for a request and rwsf::TypeUtils::response for a response.

The isDocLitType parameter should be true if this Envelope contains information for a document literal operation (defined in the WSDL file under the bindings section as "style="document" and \c use="literal".

The type is specified in the part for the operation in the general portType section.

Parameters:

	reader	rwsf::XmlReader instance that contains the SOAP envelope to parse.
	info	The rwsf::CallInfo instance associated with this envelope.
	type	Either a request or a response.
	isDocLitType	Bool to determine whether the SOAP envelope has a Doc Literal encoding.

void rwsf::SoapEnvelopeType::endParse

(

rwsf::XmlReader &

reader

)

Parses the last element in this envelope. Applications must call this function after beginParse() completes in order to set the reader instance's cursor to a position just after the SOAP Envelope element.

const rwsf::SoapBodyType& rwsf::SoapEnvelopeType::getBody

(

)

const

Returns the SOAP body contained in this envelope.

virtual rwsf::XmlName rwsf::SoapEnvelopeType::getDefaultElementName

(

)

const [virtual]

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

Implements rwsf::SoapBase.

const rwsf::SoapHeaderType& rwsf::SoapEnvelopeType::getHeader

(

)

const

Returns the header.

bool rwsf::SoapEnvelopeType::isHeaderSet

(

)

const

Returns true if this envelope contains a header, false otherwise.

void rwsf::SoapEnvelopeType::setBody

(

const rwsf::SoapBodyType &

Body

)

Adds a body to this envelope.

void rwsf::SoapEnvelopeType::setHeader

(

const rwsf::SoapHeaderType &

Header

)

Adds a header.

void rwsf::SoapEnvelopeType::setHeaderSet

(

bool

setValue

)

Sets whether or not this envelope contains a header.