CSenSoapMessage Class Reference

#include <mw/SenSoapMessage.h>

Link against: SenUtils.lib

class CSenSoapMessage : public CSenSoapEnvelope

Inherits from

CSenSoapMessage
- CSenSoapEnvelope

Protected Attributes
CSenWsSecurityHeader *	ipSecurityHeader

Public Member Functions
virtual	~CSenSoapMessage()
IMPORT_C TInt	AddSecurityTokenL(const TDesC8 &)
IMPORT_C CSenSoapMessage *	NewL()
IMPORT_C CSenSoapMessage *	NewL(TSOAPVersion)
IMPORT_C CSenSoapMessage *	NewL(TSOAPVersion, const TDesC8 &)
IMPORT_C void	SetSecurityHeaderL(const TDesC8 &)

Protected Member Functions
	CSenSoapMessage()
IMPORT_C void	BaseConstructL()
IMPORT_C void	BaseConstructL(TSOAPVersion)
IMPORT_C void	BaseConstructL(TSOAPVersion, const TDesC8 &)
virtual IMPORT_C CSenWsSecurityHeader *	NewSecurityHeaderLC(const TDesC8 *)
virtual IMPORT_C void	ParseHeaderL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray &)

Inherited Attributes
	CSenBaseFragment::iState
	CSenBaseFragment::iWs
	CSenBaseFragment::iXmlReader
	CSenBaseFragment::ipElement
	CSenBaseFragment::ipOwner
	CSenSoapEnvelope::ipBodyFragment
	CSenSoapEnvelope::ipHeaderFragment
	CSenSoapEnvelope::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()
	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()
	CSenSoapEnvelope::AddHeaderL(CSenElement &)
	CSenSoapEnvelope::BodyAsStringL()
	CSenSoapEnvelope::BodyL()
	CSenSoapEnvelope::CSenSoapEnvelope()
	CSenSoapEnvelope::DetachFaultL()
	CSenSoapEnvelope::EndElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &)
	CSenSoapEnvelope::FaultL()
	CSenSoapEnvelope::HasBody()
	CSenSoapEnvelope::HasHeader()
	CSenSoapEnvelope::HeaderL()
	CSenSoapEnvelope::IsFault()
	CSenSoapEnvelope::ParseHeaderL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenSoapEnvelope::ParseL(const TDesC8 &)
	CSenSoapEnvelope::SetBodyL(const TDesC8 &)
	CSenSoapEnvelope::SetSoapActionL(const TDesC8 &)
	CSenSoapEnvelope::SoapAction()
	CSenSoapEnvelope::SoapAction2()
	CSenSoapEnvelope::SoapVersion()
	CSenSoapEnvelope::StartElementL(const TDesC8 &,const TDesC8 &,const TDesC8 &,const RAttributeArray &)
	CSenSoapEnvelope::~CSenSoapEnvelope()

Detailed Description

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

Since: Series60 3.0

Member Attribute Documentation

ipSecurityHeader

CSenWsSecurityHeader *

ipSecurityHeader

[protected]

Constructor & Destructor Documentation

CSenSoapMessage ( )

IMPORT_C

CSenSoapMessage

(

)

[protected]

C++ default constructor.

~CSenSoapMessage ( )

IMPORT_C

~CSenSoapMessage

(

)

[virtual]

Destructor.

Member Function 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 3.0

Parameter	Description
aNewToken	Token to be inserted.

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

BaseConstructL ( )

IMPORT_C void

BaseConstructL

(

)

[protected]

Reimplemented from CSenSoapEnvelope::BaseConstructL()

This method should be called from the deriving classes ConstructL() methods.

Since: Series60 3.0

BaseConstructL ( TSOAPVersion )

IMPORT_C void

BaseConstructL

(

TSOAPVersion

aVersion

)

[protected]

Reimplemented from CSenSoapEnvelope::BaseConstructL(TSOAPVersion)

This method should be called from the deriving classes ConstructL() methods.

Since: Series60 4.0

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

Parameter	Description
aVersion	version of SOAP (1.1 or 1.2)
aSecurityNs	seurity namespace version . KSecuritySchemeXmlNs from 2003 , or KSecurityXmlNs from 2004

NewL ( )

IMPORT_C CSenSoapMessage *

NewL

(

)

[static]

Reimplemented from CSenSoapEnvelope::NewL()

Two-phase constructor.

NewL ( TSOAPVersion )

IMPORT_C CSenSoapMessage *

NewL

(

TSOAPVersion

aVersion

)

[static]

Two-phase constructor.

Since: Series60 4.0

Parameter	Description
aVersion	version of SOAP (1.1 or 1.2)

NewL ( TSOAPVersion, const TDesC8 & )

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

Two-phase constructor.

Since: Series60 4.0

Parameter	Description
aVersion	version of SOAP (1.1 or 1.2)
aSecurityNs	seurity namespace version . KSecuritySchemeXmlNs from 2003 , or KSecurityXmlNs from 2004

NewSecurityHeaderLC ( const TDesC8 * )

IMPORT_C CSenWsSecurityHeader *

NewSecurityHeaderLC

(

const TDesC8 *

aData = NULL

)

[protected, virtual]

Helper function to make a new security header.

Since: Series60 3.0

Parameter	Description
aData	Default=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 TDesC8 &, const TDesC8 &, const TDesC8 &, const RAttributeArray & )

IMPORT_C void	ParseHeaderL	(	const TDesC8 &	aNsUri,
			const TDesC8 &	aLocalName,
			const TDesC8 &	aQName,
			const RAttributeArray &	aAttributes
		)	[protected, virtual]

Implements functionality to parse SOAP header if one is found during parsing the envelope. Extends basic functionality from SOAP envelope by recognizing and parsing <Security> element under following namespace: http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd All other headers are parsed using superclass (SOAP envelope) functionality.

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

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 3.0

Parameter	Description
aData	Data to be used in the security header.