Symbian^3 Application Developer Library >

CSenSoapMessage2 Class Reference

class CSenSoapMessage2 : public CSenSoapEnvelope2
CSenSoapMessage extends basic SOAP envelope functionality by offering methods to set the security header and security token. SenUtils.lib
Since
Series60 4.0

Inherits from

Public Member Functions
~CSenSoapMessage2 ()
IMPORT_C TInt AddSecurityTokenL (const TDesC8 &)
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 void SetSecurityHeaderL (const TDesC8 &)
IMPORT_C TClass Type ()
Protected Member Functions
CSenSoapMessage2 ()
IMPORT_C void BaseConstructL ()
IMPORT_C void BaseConstructL ( TSOAPVersion )
IMPORT_C void BaseConstructL ( TSOAPVersion , const TDesC8 &)
IMPORT_C void BaseConstructL ( MSenMessageContext &)
IMPORT_C void BaseConstructL ( MSenMessageContext &, TSOAPVersion )
IMPORT_C void BaseConstructL ( MSenMessageContext &, TSOAPVersion , const TDesC8 &)
IMPORT_C void BaseConstructL ( CSenSoapMessage2 &)
IMPORT_C CSenWsSecurityHeader2 * NewSecurityHeaderLC (const TDesC8 *, RSenDocument , TXmlEngElement )
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()
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()
Protected Attributes
CSenWsSecurityHeader2 * ipSecurityHeader
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

Constructor & Destructor Documentation

CSenSoapMessage2()

IMPORT_C CSenSoapMessage2 ( ) [protected]

C++ default constructor.

~CSenSoapMessage2()

IMPORT_C ~CSenSoapMessage2 ( ) [virtual]

Destructor.

Member Functions Documentation

AddSecurityTokenL(const TDesC8 &)

IMPORT_C TInt AddSecurityTokenL ( 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

Parameters

const TDesC8 & aNewToken Token to be inserted.

BaseConstructL()

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

BaseConstructL(TSOAPVersion)

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

Parameters

TSOAPVersion aVersion

BaseConstructL(TSOAPVersion, const TDesC8 &)

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

Parameters

TSOAPVersion aVersion
const TDesC8 & aSecurityNs

BaseConstructL(MSenMessageContext &)

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

Parameters

MSenMessageContext & aContext

BaseConstructL(MSenMessageContext &, TSOAPVersion)

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

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion

BaseConstructL(MSenMessageContext &, TSOAPVersion, const TDesC8 &)

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

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion
const TDesC8 & aSecurityNs

BaseConstructL(CSenSoapMessage2 &)

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

Parameters

CSenSoapMessage2 & aMessage

CloneL()

IMPORT_C MSenMessage * CloneL ( ) [virtual]

NewL()

IMPORT_C CSenSoapMessage2 * NewL ( ) [static]

Two-phase constructor.

NewL(TSOAPVersion)

IMPORT_C CSenSoapMessage2 * NewL ( TSOAPVersion aVersion ) [static]

Two-phase constructor.

Parameters

TSOAPVersion aVersion

NewL(TSOAPVersion, const TDesC8 &)

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

Two-phase constructor.

Parameters

TSOAPVersion aVersion
const TDesC8 & aSecurityNs

NewL(MSenMessageContext &)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext

NewL(MSenMessageContext &, TSOAPVersion)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion

NewL(MSenMessageContext &, TSOAPVersion, const TDesC8 &)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion
const TDesC8 & aSecurityNs

NewL(CSenSoapMessage2 &)

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

Two-phased copy constructor.

Parameters

CSenSoapMessage2 & aMessage

NewLC()

IMPORT_C CSenSoapMessage2 * NewLC ( ) [static]

Two-phase constructor.

NewLC(TSOAPVersion)

IMPORT_C CSenSoapMessage2 * NewLC ( TSOAPVersion aVersion ) [static]

Two-phase constructor.

Parameters

TSOAPVersion aVersion

NewLC(TSOAPVersion, const TDesC8 &)

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

Two-phase constructor.

Parameters

TSOAPVersion aVersion
const TDesC8 & aSecurityNs

NewLC(MSenMessageContext &)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext

NewLC(MSenMessageContext &, TSOAPVersion)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion

NewLC(MSenMessageContext &, TSOAPVersion, const TDesC8 &)

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

Two-phase constructor.

Parameters

MSenMessageContext & aContext
TSOAPVersion aVersion
const TDesC8 & aSecurityNs

NewLC(CSenSoapMessage2 &)

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

Two-phased copy constructor.

Parameters

CSenSoapMessage2 & aMessage

NewSecurityHeaderLC(const TDesC8 *, RSenDocument, TXmlEngElement)

IMPORT_C CSenWsSecurityHeader2 * NewSecurityHeaderLC ( const TDesC8 * aData,
RSenDocument aDocument,
TXmlEngElement element
) [protected, virtual]
Helper function to make a new security header.
Since
Series60 4.0

Parameters

const TDesC8 * aData Default=NULL. Data to be set in the security header.
RSenDocument aDocument
TXmlEngElement element

ParseHeaderL(const RTagInfo &, const RAttributeArray &)

IMPORT_C void ParseHeaderL ( 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

Parameters

const RTagInfo & aElement
const RAttributeArray & aAttributes The attributes of the new element

SetSecurityHeaderL(const TDesC8 &)

IMPORT_C void SetSecurityHeaderL ( 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

Parameters

const TDesC8 & aData Data to be used in the security header.

Type()

IMPORT_C TClass Type ( ) [virtual]

Member Data Documentation

CSenWsSecurityHeader2 * ipSecurityHeader

CSenWsSecurityHeader2 * ipSecurityHeader [protected]

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.