HydraExpress™ C++ API Reference Guide

Product Documentation:
   HydraExpress C++
Documentation Home
List of all members | Public Member Functions
rwsf::SoapEnvelopeType Class Reference

Represents a SOAP envelope. More...

#include <rwsf/webservice/SoapEnvelopeType.h>

Inheritance diagram for rwsf::SoapEnvelopeType:

Public Member Functions

 SoapEnvelopeType ()
 ~SoapEnvelopeType ()
void beginParse (rwsf::XmlReader &reader, rwsf::CallInfo &info, rwsf::TypeUtils::messageType type, bool isDocLitType)
void endParse (rwsf::XmlReader &reader)
const rwsf::SoapBodyTypegetBody () const
virtual rwsf::XmlName getDefaultElementName () const
const rwsf::SoapHeaderTypegetHeader () const
bool isHeaderSet () const
void setBody (const rwsf::SoapBodyType &Body)
void setHeader (const rwsf::SoapHeaderType &Header)
void setHeaderSet (bool setValue)
- 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

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

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 ( )


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.

readerrwsf::XmlReader instance that contains the SOAP envelope to parse.
infoThe rwsf::CallInfo instance associated with this envelope.
typeEither a request or a response.
isDocLitTypeBool 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

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.

Copyright © 2020 Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is registered trademark of Rogue Wave Software, Inc. in the United States and other countries, and HydraExpress is a trademark of Rogue Wave Software. All other trademarks are the property of their respective owners.
Provide feedback to Rogue Wave about its documentation.