CSenSoapEnvelope Class Reference
#include
<mw/SenSoapEnvelope.h>
Link against: SenUtils.lib
| class CSenSoapEnvelope : public CSenBaseFragment |
| Inherited Functions |
|---|
| | CBase::CBase() |
| | CBase::Delete(CBase *) |
| | CBase::Extension_(TUint,TAny *&,TAny *) |
| | CBase::operator new(TUint) |
| | CBase::operator new(TUint,TAny *) |
| | CBase::operator new(TUint,TLeave) |
| | CBase::operator new(TUint,TLeave,TUint) |
| | CBase::operator new(TUint,TUint) |
| | CBase::~CBase() |
| | CSenBaseFragment::AllocContentSaverL() |
| | CSenBaseFragment::AsElement() |
| | CSenBaseFragment::AsXmlL() |
| | CSenBaseFragment::AsXmlUnicodeL() |
| | CSenBaseFragment::BaseConstructL(CSenXmlReader &) |
| | CSenBaseFragment::BaseConstructL(const CSenElement &) |
| | CSenBaseFragment::BaseConstructL(const TDesC8 &) |
| | CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenBaseFragment::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &) |
| | CSenBaseFragment::BuildFrom(const TDesC8 &) |
| | CSenBaseFragment::CSenBaseFragment() |
| | CSenBaseFragment::CharactersL(const TDesC8 &,TInt,TInt) |
| | CSenBaseFragment::ConsistsOfL(MSenFragment &) |
| | CSenBaseFragment::Content() |
| | CSenBaseFragment::ContentOf(const TDesC8 &) |
| | CSenBaseFragment::DelegateParsingL(MSenFragment &) |
| | CSenBaseFragment::DelegateParsingL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenBaseFragment::DetachL() |
| | CSenBaseFragment::EnsureNamespace(const TDesC8 &) |
| | CSenBaseFragment::ExtractElement() |
| | CSenBaseFragment::LocalName()const |
| | CSenBaseFragment::Namespace(const TDesC8 &) |
| | CSenBaseFragment::NewL(const CSenElement &) |
| | CSenBaseFragment::NewL(const TDesC8 &) |
| | CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenBaseFragment::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,CSenElement &) |
| | CSenBaseFragment::NsPrefix()const |
| | CSenBaseFragment::NsUri()const |
| | CSenBaseFragment::ParseWithL(CSenXmlReader &) |
| | CSenBaseFragment::Reader() |
| | CSenBaseFragment::ResetContentL() |
| | CSenBaseFragment::ResumeParsingFromL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::SaveNamespacesL(const RAttributeArray &,TBool) |
| | CSenBaseFragment::SetAttributesL(const RAttributeArray &) |
| | CSenBaseFragment::SetContentOfL(const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::SetOwner(MSenFragment &) |
| | CSenBaseFragment::SetReader(CSenXmlReader &) |
| | CSenBaseFragment::StartEntity(TDesC8 &) |
| | CSenBaseFragment::WriteAsXMLToL(RWriteStream &) |
| | CSenBaseFragment::WriteEndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenBaseFragment::WriteStartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenBaseFragment::~CSenBaseFragment() |
Detailed Description
CSenSoapEnvelope is an utility class offering capability to parse XML SOAP envelope and manipulation methods to alter its contents. Typically WSC uses this class to parse messages received through WSF HandleMessageL() and HandleErrorL() callbacks. Class has convenience methods for checking if a SOAP envelope body contains a fault and functionality to detach SOAP Fault object out from it. Also possibility to set SOAPAction HTTP header is supported.
- Since
- Series60 3.0
Member Attribute Documentation
ipSoapAction
|
HBufC8 * | ipSoapAction | [protected] |
Constructor & Destructor Documentation
CSenSoapEnvelope ( )
| CSenSoapEnvelope | ( | ) | [protected] |
~CSenSoapEnvelope ( )
| IMPORT_C | ~CSenSoapEnvelope | ( | ) | [virtual] |
Member Function Documentation
AddHeaderL ( CSenElement & )
Adds an element to the header.
- Since
- Series60 3.0
| Parameter | Description | | aHeaderElement | new child element to be added inside Header element. Ownership is always transferred to CSenSoapEnvelope. |
Returns: added CSenElement
BaseConstructL ( TSOAPVersion )
| IMPORT_C void | BaseConstructL | ( | TSOAPVersion | aVersion | ) | [protected] |
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 3.0
BaseConstructL ( )
| IMPORT_C void | BaseConstructL | ( | ) | [protected] |
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 3.0
BodyAsStringL ( )
| IMPORT_C HBufC8 * | BodyAsStringL | ( | ) | [virtual] |
Getter for the envelope body as a UTF-8 form XML string.
- Since
- Series60 3.0
Returns: body as a HBufC8 pointer. Ownership is transferred to caller.
BodyL ( )
Getter for envelopes body
- Since
- Series60 3.0
Returns: body as CSenElement
DetachFaultL ( )
Detaches the <Fault> element from the envelope, removing the element from the envelope.
- Since
- Series60 3.0
Returns: pointer to the soap fault. Caller takes the ownership. NULL if <Fault> element is non-existent.
EndElementL ( const TDesC8 &, const TDesC8 &, const TDesC8 & )
| IMPORT_C void | EndElementL | ( | const TDesC8 & | aNsUri, |
| | const TDesC8 & | aLocalName, |
| | const TDesC8 & | aQName |
| | ) | [protected, virtual] |
Callback function which implement the XML content handler interface. This callback will occur on each end element tag found in the XML document.
- Since
- Series60 3.0
| Parameter | Description | | aNsUri | The namespace URI of the new element |
| aLocalName | The local name of the new element |
| aQName | The qualified name of the new element |
FaultL ( )
Gets the <Fault> element. Ownership is not transferred. NULL if not a fault.
- Since
- Series60 3.0
Returns: reference to SOAP fault object owned by this SOAP envelope
HasHeader ( )
| IMPORT_C TBool | HasHeader | ( | ) | |
HeaderL ( )
Getter for envelopes header
- Since
- Series60 3.0
Returns: header as CSenElement
IsFault ( )
| IMPORT_C TBool | IsFault | ( | ) | [virtual] |
Checks if this SOAP envelope body contains SOAP fault or not.
- Since
- Series60 3.0
Returns: TBool ETrue if there is a fault, EFalse if not.
ParseHeaderL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )
This method should be overridden by subclasses. Implements functionality to parse SOAP header if one is found during parsing the envelope. Parses all elements found under top <Header> element by using DOM fragment.
- Since
- Series60 3.0
| Parameter | Description | | aNsUri | The namespace URI of the new element |
| aLocalName | The local name of the new element |
| aQName | The qualified name of the new element |
| aAttributes | The attributes of the new element |
ParseL ( const TDesC8 & )
| IMPORT_C void | ParseL | ( | const TDesC8 & | aXml | ) | [virtual] |
Method parses given piece of XML into this SOAP envelope
SetBodyL ( const TDesC8 & )
Sets body of the envelope.
- Since
- Series60 3.0
| Parameter | Description | | aBody | Body (content) to be set. |
Returns: SOAP body (content) which was just set
SetSoapActionL ( const TDesC8 & )
| IMPORT_C TPtrC8 | SetSoapActionL | ( | const TDesC8 & | aSoapAction | ) | [virtual] |
Sets the SOAP action HTTP header. WSF will use this value while submitting this SOAP envelope request over HTTP/S transport.
- Since
- Series60 3.0
| Parameter | Description | | aSoapAction | the SOAP Action HTTP header to be set. The default value is KSenSoapActionHeaderValueEmpty, which is two double quotation marks - "" - without any character in between. SOAP specification requires double quotation marks, even if action is empty. If a string without double quotation marks is passed, it will be wrapped inside double quotation marks, added in the beginning and at the end of the actual SOAP Action string. |
Returns: newly set SOAP action header. String might have been extended to include double quotation marks, if those were missing from the argument.
SoapAction ( )
| IMPORT_C TPtrC8 | SoapAction | ( | ) | [virtual] |
Gets the soap action header.
- Since
- Series60 3.0
Returns: current SOAP action header, which is always wrapped inside double quotation marks. If SOAPAction has not been set for this SOAP envelope, function will return zero-length descriptor (KNullDesC8)
SoapAction2 ( )
Gets the soap action header.
- Since
- Series60 5.0
Returns: current SOAP action header, which is always wrapped inside double quotation marks. If SOAPAction has not been set for this SOAP envelope, function will return zero-length descriptor (KNullDesC8)
SoapVersion ( )
Getter for currently effecitve SOAP version.
Returns: enumeration which dictates SOAP version.
StartElementL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )
Callback function which implement the XML content handler interface. This callback will occur on each start element tag found in the XML document. The SOAP envelope recognizes and parses the following elements and their corresponding attributes inside namespace defined in KSenSoapEnvelopeXmlns: KSenSoapEnvelopeName, "Envelope" KSenSoapHeaderName, "Header" KSenSoapBodyName, "Body" KSenSoapFault, "Fault" (only if found inside Body element)
| Parameter | Description | | aNsUri | The namespace URI of the new element |
| aLocalName | The local name of the new element |
| aQName | The qualified name of the new element |
| aAttributes | The attributes of the new element |