CSenSoapMessage2 Class Reference

#include <mw/SenSoapMessage2.h>

Link against: SenUtils.lib

class CSenSoapMessage2 : public CSenSoapEnvelope2

Inherits from

Protected Attributes
CSenWsSecurityHeader2 *ipSecurityHeader
Public Member Functions
virtual ~CSenSoapMessage2()
IMPORT_C TIntAddSecurityTokenL(const TDesC8 &)
virtual IMPORT_C MSenMessage *CloneL()
IMPORT_C CSenSoapMessage2 *NewL()
IMPORT_C CSenSoapMessage2 *NewL(TSOAPVersion)
IMPORT_C CSenSoapMessage2 *NewL(TSOAPVersion, const TDesC8 &)
IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &)
IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &, TSOAPVersion)
IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &, TSOAPVersion, const TDesC8 &)
IMPORT_C CSenSoapMessage2 *NewL(CSenSoapMessage2 &)
IMPORT_C CSenSoapMessage2 *NewLC()
IMPORT_C CSenSoapMessage2 *NewLC(TSOAPVersion)
IMPORT_C CSenSoapMessage2 *NewLC(TSOAPVersion, const TDesC8 &)
IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &)
IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &, TSOAPVersion)
IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &, TSOAPVersion, const TDesC8 &)
IMPORT_C CSenSoapMessage2 *NewLC(CSenSoapMessage2 &)
IMPORT_C voidSetSecurityHeaderL(const TDesC8 &)
virtual IMPORT_C TClassType()
Protected Member Functions
CSenSoapMessage2()
IMPORT_C voidBaseConstructL()
IMPORT_C voidBaseConstructL(TSOAPVersion)
IMPORT_C voidBaseConstructL(TSOAPVersion, const TDesC8 &)
IMPORT_C voidBaseConstructL(MSenMessageContext &)
IMPORT_C voidBaseConstructL(MSenMessageContext &, TSOAPVersion)
IMPORT_C voidBaseConstructL(MSenMessageContext &, TSOAPVersion, const TDesC8 &)
IMPORT_C voidBaseConstructL(CSenSoapMessage2 &)
virtual IMPORT_C CSenWsSecurityHeader2 *NewSecurityHeaderLC(const TDesC8 *, RSenDocument, TXmlEngElement)
virtual IMPORT_C voidParseHeaderL(const RTagInfo &, const RAttributeArray &)
Inherited Attributes
CSenFragmentBase::iDocument
CSenFragmentBase::iElement
CSenFragmentBase::iState
CSenFragmentBase::ipContentBuf
CSenFragmentBase::ipContentWriteStream
CSenFragmentBase::ipDelegate
CSenFragmentBase::ipNamespaceArray
CSenFragmentBase::ipOwner
CSenFragmentBase::ipParser
CSenSoapEnvelope2::iDirection
CSenSoapEnvelope2::iFault
CSenSoapEnvelope2::iTransactionId
CSenSoapEnvelope2::ipBodyFragment
CSenSoapEnvelope2::ipHeaderFragment
CSenSoapEnvelope2::ipNotOwnedContext
CSenSoapEnvelope2::ipProperties
CSenSoapEnvelope2::ipReserved
CSenSoapEnvelope2::ipSoapAction
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()
CSenSoapEnvelope2::AddHeaderL(TXmlEngElement)
CSenSoapEnvelope2::BaseConstructL(CSenSoapEnvelope2 &)
CSenSoapEnvelope2::BodyAsStringL()
CSenSoapEnvelope2::BodyL()
CSenSoapEnvelope2::CSenSoapEnvelope2()
CSenSoapEnvelope2::Context()
CSenSoapEnvelope2::CreateBodyFragmentL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &,TXmlEngElement &,RSenDocument &)
CSenSoapEnvelope2::DetachFaultL()
CSenSoapEnvelope2::Direction()
CSenSoapEnvelope2::FaultL()
CSenSoapEnvelope2::HasBody()
CSenSoapEnvelope2::HasHeader()
CSenSoapEnvelope2::HeaderL()
CSenSoapEnvelope2::IsFault()
CSenSoapEnvelope2::IsSafeToCast(TClass)
CSenSoapEnvelope2::NewL(CSenSoapEnvelope2 &)
CSenSoapEnvelope2::NewLC(CSenSoapEnvelope2 &)
CSenSoapEnvelope2::OnEndElementL(const RTagInfo &,TInt)
CSenSoapEnvelope2::OnStartElementL(const RTagInfo &,const RAttributeArray &,TInt)
CSenSoapEnvelope2::Properties()
CSenSoapEnvelope2::SetBodyL(TXmlEngElement)
CSenSoapEnvelope2::SetBodyL(const TDesC8 &)
CSenSoapEnvelope2::SetContext(MSenMessageContext *)
CSenSoapEnvelope2::SetProperties(MSenProperties *)
CSenSoapEnvelope2::SetSoapActionL(const TDesC8 &)
CSenSoapEnvelope2::SoapAction()
CSenSoapEnvelope2::SoapVersion()
CSenSoapEnvelope2::TxnId()
CSenSoapEnvelope2::~CSenSoapEnvelope2()

Detailed Description

CSenSoapMessage extends basic SOAP envelope functionality by offering methods to set the security header and security token.
Since
Series60 4.0

Member Attribute Documentation

ipSecurityHeader

CSenWsSecurityHeader2 *ipSecurityHeader[protected]

Constructor & Destructor Documentation

CSenSoapMessage2 ( )

IMPORT_CCSenSoapMessage2()[protected]

C++ default constructor.

~CSenSoapMessage2 ( )

IMPORT_C~CSenSoapMessage2()[virtual]

Destructor.

Member Function Documentation

AddSecurityTokenL ( const TDesC8 & )

IMPORT_C TIntAddSecurityTokenL(const TDesC8 &aNewToken)
Adds new token (content) to current security header, appending to existing. The token is appended after the current content of security token. Method instantiates and adds default security header (without data), if such was not set in beforehand.
Since
Series60 4.0
ParameterDescription
aNewTokenToken to be inserted.

Returns: KErrNone or some system-wide Symbian error codes.

BaseConstructL ( )

IMPORT_C voidBaseConstructL()[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( TSOAPVersion )

IMPORT_C voidBaseConstructL(TSOAPVersionaVersion)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( TSOAPVersion, const TDesC8 & )

IMPORT_C voidBaseConstructL(TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( MSenMessageContext & )

IMPORT_C voidBaseConstructL(MSenMessageContext &aContext)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( MSenMessageContext &, TSOAPVersion )

IMPORT_C voidBaseConstructL(MSenMessageContext &aContext,
TSOAPVersionaVersion
)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( MSenMessageContext &, TSOAPVersion, const TDesC8 & )

IMPORT_C voidBaseConstructL(MSenMessageContext &aContext,
TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

BaseConstructL ( CSenSoapMessage2 & )

IMPORT_C voidBaseConstructL(CSenSoapMessage2 &aMessage)[protected]
This method should be called from the deriving classes ConstructL() methods.
Since
Series60 4.0

CloneL ( )

IMPORT_C MSenMessage *CloneL()[virtual]

Reimplemented from CSenSoapEnvelope2::CloneL()

NewL ( )

IMPORT_C CSenSoapMessage2 *NewL()[static]

Reimplemented from CSenSoapEnvelope2::NewL()

Two-phase constructor.

NewL ( TSOAPVersion )

IMPORT_C CSenSoapMessage2 *NewL(TSOAPVersionaVersion)[static]

Two-phase constructor.

NewL ( TSOAPVersion, const TDesC8 & )

IMPORT_C CSenSoapMessage2 *NewL(TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[static]

Two-phase constructor.

NewL ( MSenMessageContext & )

IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &aContext)[static]

Two-phase constructor.

NewL ( MSenMessageContext &, TSOAPVersion )

IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &aContext,
TSOAPVersionaVersion
)[static]

Two-phase constructor.

NewL ( MSenMessageContext &, TSOAPVersion, const TDesC8 & )

IMPORT_C CSenSoapMessage2 *NewL(MSenMessageContext &aContext,
TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[static]

Two-phase constructor.

NewL ( CSenSoapMessage2 & )

IMPORT_C CSenSoapMessage2 *NewL(CSenSoapMessage2 &aMessage)[static]

Two-phased copy constructor.

NewLC ( )

IMPORT_C CSenSoapMessage2 *NewLC()[static]

Reimplemented from CSenSoapEnvelope2::NewLC()

Two-phase constructor.

NewLC ( TSOAPVersion )

IMPORT_C CSenSoapMessage2 *NewLC(TSOAPVersionaVersion)[static]

Two-phase constructor.

NewLC ( TSOAPVersion, const TDesC8 & )

IMPORT_C CSenSoapMessage2 *NewLC(TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[static]

Two-phase constructor.

NewLC ( MSenMessageContext & )

IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &aContext)[static]

Two-phase constructor.

NewLC ( MSenMessageContext &, TSOAPVersion )

IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &aContext,
TSOAPVersionaVersion
)[static]

Two-phase constructor.

NewLC ( MSenMessageContext &, TSOAPVersion, const TDesC8 & )

IMPORT_C CSenSoapMessage2 *NewLC(MSenMessageContext &aContext,
TSOAPVersionaVersion,
const TDesC8 &aSecurityNs
)[static]

Two-phase constructor.

NewLC ( CSenSoapMessage2 & )

IMPORT_C CSenSoapMessage2 *NewLC(CSenSoapMessage2 &aMessage)[static]

Two-phased copy constructor.

NewSecurityHeaderLC ( const TDesC8 *, RSenDocument, TXmlEngElement )

IMPORT_C CSenWsSecurityHeader2 *NewSecurityHeaderLC(const TDesC8 *aData,
RSenDocumentaDocument,
TXmlEngElementelement
)[protected, virtual]
Helper function to make a new security header.
Since
Series60 4.0
ParameterDescription
aDataDefault=NULL. Data to be set in the security header.

Returns: new security header, which is located in the cleanup stack. Caller takes ownership.

ParseHeaderL ( const RTagInfo &, const RAttributeArray & )

IMPORT_C voidParseHeaderL(const RTagInfo &aElement,
const RAttributeArray &aAttributes
)[protected, virtual]
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
ParameterDescription
aAttributesThe attributes of the new element

SetSecurityHeaderL ( const TDesC8 & )

IMPORT_C voidSetSecurityHeaderL(const TDesC8 &aData)
Sets a new security header for the soap message. If existant, the old security header is deleted and new one with given data is added.
Since
Series60 4.0
ParameterDescription
aDataData to be used in the security header.

Type ( )

IMPORT_C TClassType()[virtual]

Reimplemented from CSenSoapEnvelope2::Type()