CSenSoapEnvelope2 Class Reference
#include
<mw/SenSoapEnvelope2.h>
Link against: SenUtils.lib
| class CSenSoapEnvelope2 : public CSenFragmentBase |
| Protected Member Functions |
|---|
| CSenSoapEnvelope2() |
| IMPORT_C void | BaseConstructL(TSOAPVersion) |
| IMPORT_C void | BaseConstructL() |
| IMPORT_C void | BaseConstructL(MSenMessageContext &) |
| IMPORT_C void | BaseConstructL(MSenMessageContext &, TSOAPVersion) |
| IMPORT_C void | BaseConstructL(CSenSoapEnvelope2 &) |
| virtual IMPORT_C CSenFragmentBase * | CreateBodyFragmentL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument &) |
| virtual IMPORT_C void | OnEndElementL(const RTagInfo &, TInt) |
| virtual IMPORT_C void | OnStartElementL(const RTagInfo &, const RAttributeArray &, TInt) |
| virtual IMPORT_C void | ParseHeaderL(const RTagInfo &, const RAttributeArray &) |
| 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() |
| | CSenFragmentBase::AddAttributesL(const RAttributeArray &) |
| | CSenFragmentBase::AddAttributesToElementL(TXmlEngElement,const RAttributeArray &) |
| | CSenFragmentBase::AddContentL(const TDesC8 &) |
| | CSenFragmentBase::AddNamespacesL() |
| | CSenFragmentBase::AsDocumentL() |
| | CSenFragmentBase::AsElementL() |
| | CSenFragmentBase::AsXmlL() |
| | CSenFragmentBase::AsXmlUnicodeL() |
| | CSenFragmentBase::BaseConstructL(TXmlEngElement &,RSenDocument &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &) |
| | CSenFragmentBase::BaseConstructL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &) |
| | CSenFragmentBase::BaseConstructL(const TXmlEngElement &) |
| | CSenFragmentBase::CSenFragmentBase() |
| | CSenFragmentBase::ConsistsOfL(CSenFragmentBase &) |
| | CSenFragmentBase::ConsistsOfL(TXmlEngElement &,TXmlEngElement &) |
| | CSenFragmentBase::ContentL() |
| | CSenFragmentBase::ContentOf(const TDesC8 &) |
| | CSenFragmentBase::ExtractElement() |
| | CSenFragmentBase::GetExtendedInterface(const TInt32) |
| | CSenFragmentBase::LocalName()const |
| | CSenFragmentBase::Namespace(const TDesC8 &) |
| | CSenFragmentBase::NewL(TXmlEngElement &,RSenDocument &) |
| | CSenFragmentBase::NewL(const TDesC8 &) |
| | CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &) |
| | CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &) |
| | CSenFragmentBase::NewL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &) |
| | CSenFragmentBase::NewL(const TXmlEngElement &) |
| | CSenFragmentBase::NsPrefix()const |
| | CSenFragmentBase::NsUri()const |
| | CSenFragmentBase::OnContentL(const TDesC8 &,TInt) |
| | CSenFragmentBase::OnDelegateParsingL(CSenFragmentBase &) |
| | CSenFragmentBase::OnDelegateParsingL(const RTagInfo &,const RAttributeArray &,TInt) |
| | CSenFragmentBase::OnEndDocumentL(TInt) |
| | CSenFragmentBase::OnEndPrefixMappingL(const RString &,TInt) |
| | CSenFragmentBase::OnError(TInt) |
| | CSenFragmentBase::OnIgnorableWhiteSpaceL(const TDesC8 &,TInt) |
| | CSenFragmentBase::OnProcessingInstructionL(const TDesC8 &,const TDesC8 &,TInt) |
| | CSenFragmentBase::OnResumeParsingFromL(const RTagInfo &,TInt) |
| | CSenFragmentBase::OnSkippedEntityL(const RString &,TInt) |
| | CSenFragmentBase::OnStartDocumentL(const RDocumentParameters &,TInt) |
| | CSenFragmentBase::OnStartPrefixMappingL(const RString &,const RString &,TInt) |
| | CSenFragmentBase::OnWriteEndElementL(const RTagInfo &) |
| | CSenFragmentBase::OnWriteStartElementL(const RTagInfo &,const RAttributeArray &) |
| | CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::RenameL(const TDesC8 &,const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::RenameLocalNameL(const TDesC8 &) |
| | CSenFragmentBase::RenameNamespaceL(const TDesC8 &) |
| | CSenFragmentBase::RenameNamespaceL(const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::RenamePrefixL(const TDesC8 &) |
| | CSenFragmentBase::ResetContentL() |
| | CSenFragmentBase::SetContentHandler(CSenFragmentBase &) |
| | CSenFragmentBase::SetContentL(const TDesC8 &) |
| | CSenFragmentBase::SetContentOfL(const TDesC8 &,const TDesC8 &) |
| | CSenFragmentBase::SetDocument(RSenDocument &) |
| | CSenFragmentBase::SetOwner(CSenFragmentBase &) |
| | CSenFragmentBase::StartSavingContent() |
| | CSenFragmentBase::WriteAsXMLToL(RWriteStream &) |
| | CSenFragmentBase::~CSenFragmentBase() |
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 4.0
Member Attribute Documentation
iDirection
| TDirection | iDirection | [protected] |
iTransactionId
|
TInt
| iTransactionId | [protected] |
ipReserved
|
TAny * | ipReserved | [protected] |
ipSoapAction
|
HBufC8 * | ipSoapAction | [protected] |
Constructor & Destructor Documentation
CSenSoapEnvelope2 ( )
| CSenSoapEnvelope2 | ( | ) | [protected] |
~CSenSoapEnvelope2 ( )
| IMPORT_C | ~CSenSoapEnvelope2 | ( | ) | [virtual] |
Member Function Documentation
AddHeaderL ( TXmlEngElement )
Adds an element to the header.
- Since
- Series60 4.0
| Parameter | Description | | aHeaderElement | new child element to be added inside Header element. Ownership is always transferred to CSenSoapEnvelope. |
Returns: added TXmlEngElement
BaseConstructL ( TSOAPVersion )
| IMPORT_C void | BaseConstructL | ( | TSOAPVersion | aVersion | ) | [protected] |
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 4.0
BaseConstructL ( )
| IMPORT_C void | BaseConstructL | ( | ) | [protected] |
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 4.0
BaseConstructL ( MSenMessageContext & )
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 4.0
BaseConstructL ( MSenMessageContext &, TSOAPVersion )
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 4.0
BaseConstructL ( CSenSoapEnvelope2 & )
This method should be called from the deriving classes ConstructL() methods.
- Since
- Series60 4.0
BodyAsStringL ( )
| IMPORT_C HBufC8 * | BodyAsStringL | ( | ) | [virtual] |
Getter for the envelope body as a UTF-8 form XML string.
- Since
- Series60 4.0
Returns: body as a HBufC8 pointer. Ownership is transferred to caller.
BodyL ( )
Getter for envelopes body
- Since
- Series60 4.0
Returns: body as TXmlEngElement
CreateBodyFragmentL ( const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &, TXmlEngElement &, RSenDocument & )
DetachFaultL ( )
| IMPORT_C CSenSoapFault2 * | DetachFaultL | ( | ) | [virtual] |
Detaches the <Fault> element from the envelope, removing the element from the envelope.
- Since
- Series60 4.0
Returns: pointer to the soap fault. Caller takes the ownership. NULL if <Fault> element is non-existent.
Direction ( )
| IMPORT_C TDirection | Direction | ( | ) | [virtual] |
FaultL ( )
| IMPORT_C CSenSoapFault2 * | FaultL | ( | ) | [virtual] |
Gets the <Fault> element. Ownership is not transferred. NULL if not a fault.
- Since
- Series60 4.0
Returns: reference to SOAP fault object owned by this SOAP envelope
HasHeader ( )
| IMPORT_C TBool | HasHeader | ( | ) | |
HeaderL ( )
Getter for envelopes header
- Since
- Series60 4.0
Returns: header as TXmlEngElement
IsFault ( )
| IMPORT_C TBool | IsFault | ( | ) | [virtual] |
Checks if this SOAP envelope body contains SOAP fault or not.
- Since
- Series60 4.0
Returns: TBool ETrue if there is a fault, EFalse if not.
IsSafeToCast ( TClass )
| IMPORT_C TBool | IsSafeToCast | ( | TClass | aType | ) | [virtual] |
NewL ( MSenMessageContext & )
NewL ( CSenSoapEnvelope2 & )
Two-phased copy constructor.
NewLC ( MSenMessageContext & )
NewLC ( CSenSoapEnvelope2 & )
Two-phased copy constructor.
OnEndElementL ( const RTagInfo &, TInt )
| IMPORT_C void | OnEndElementL | ( | const RTagInfo & | aElement, |
| | TInt | aErrorCode |
| | ) | [protected, virtual] |
Callback function implementing the XML content handler interface. Inheriting classes can override these.
- Since
- Series60 3.1
See also: MContentHandler
OnStartElementL ( const RTagInfo &, const RAttributeArray &, TInt )
Callback function implementing the XML content handler interface. Inheriting classes can override these.
- Since
- Series60 3.1
See also: MContentHandler
ParseHeaderL ( const RTagInfo &, 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 4.0
| Parameter | Description | | aAttributes | The attributes of the new element |
SetBodyL ( const TDesC8 & )
Sets body of the envelope.
- Since
- Series60 4.0
| Parameter | Description | | aBody | Body (content) to be set. |
Returns: SOAP body (content) which was just set
SetBodyL ( TXmlEngElement )
Sets body of the envelope.
- Since
- Series60 4.0
Returns: SOAP body (content) which was just set
SetContext ( MSenMessageContext * )
SetProperties ( MSenProperties * )
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 4.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 4.0
Returns: current SOAP action header, which is always wrapped inside double quotation marks. If SOAPAction has not been set to this SOAP envelope instance, function will return zero-length descriptor (KNullDesC8)
SoapVersion ( )
Getter for currently effecitve SOAP version.
Returns: enumeration which dictates SOAP version.
TxnId ( )
| IMPORT_C TInt | TxnId | ( | ) | [virtual] |
Type ( )
| IMPORT_C TClass | Type | ( | ) | [virtual] |