CSenSoapMessage2 Class Reference

Link against: senmessages.lib

#include <SenSoapMessage2.h>

Inherits CSenSoapEnvelope2.

Detailed Description

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

Public Member Functions
virtual IMPORT_C  ~CSenSoapMessage2 ()
  Destructor.
IMPORT_C void  SetSecurityHeaderL (const TDesC8 &aData)
  Sets a new security header for the soap message.
IMPORT_C TInt  AddSecurityTokenL (const TDesC8 &aNewToken)
  Adds new token (content) to current security header, appending to existing.
virtual IMPORT_C TClass  Type ()
  Gets the Message Type.
virtual IMPORT_C MSenMessage *  CloneL ()
  Clone method that duplicates this message -- including all member data in the message.

Static Public Member Functions
static IMPORT_C CSenSoapMessage2 *  NewL ()
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC ()
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (TSOAPVersion aVersion)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (TSOAPVersion aVersion)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (MSenMessageContext &aContext)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (MSenMessageContext &aContext)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (MSenMessageContext &aContext, TSOAPVersion aVersion)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (MSenMessageContext &aContext, TSOAPVersion aVersion)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (MSenMessageContext &aContext, TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (MSenMessageContext &aContext, TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  Two-phase constructor.
static IMPORT_C CSenSoapMessage2 *  NewL (CSenSoapMessage2 &aMessage)
  Two-phased copy constructor.
static IMPORT_C CSenSoapMessage2 *  NewLC (CSenSoapMessage2 &aMessage)
  Two-phased copy constructor.

Protected Member Functions
IMPORT_C  CSenSoapMessage2 ()
  C++ default constructor.
virtual IMPORT_C CSenWsSecurityHeader2 *  NewSecurityHeaderLC (const TDesC8 *aData, RSenDocument aDocument, TXmlEngElement element)
  Helper function to make a new security header.
virtual IMPORT_C void  ParseHeaderL (const RTagInfo &aElement, const RAttributeArray &aAttributes)
  This method should be overridden by subclasses.
IMPORT_C void  BaseConstructL ()
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (TSOAPVersion aVersion)
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (MSenMessageContext &aContext)
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (MSenMessageContext &aContext, TSOAPVersion aVersion)
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (MSenMessageContext &aContext, TSOAPVersion aVersion, const TDesC8 &aSecurityNs)
  This method should be called from the deriving classes ConstructL() methods.
IMPORT_C void  BaseConstructL (CSenSoapMessage2 &aMessage)
  This method should be called from the deriving classes ConstructL() methods.

Protected Attributes
CSenWsSecurityHeader2 *  ipSecurityHeader

Constructor & Destructor Documentation

virtual IMPORT_C CSenSoapMessage2::~CSenSoapMessage2 (   )  [virtual]
 

Destructor.

IMPORT_C CSenSoapMessage2::CSenSoapMessage2 (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C TInt CSenSoapMessage2::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:
aNewToken  Token to be inserted.
Returns:
KErrNone or some system-wide Symbian error codes.
IMPORT_C void CSenSoapMessage2::BaseConstructL (  CSenSoapMessage2 &  aMessage  )  [protected]
 

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

Since:
Series60 4.0
IMPORT_C void CSenSoapMessage2::BaseConstructL (  MSenMessageContext &  aContext,
TSOAPVersion  aVersion,
const TDesC8 &  aSecurityNs
)  [protected]
 

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

Since:
Series60 4.0
IMPORT_C void CSenSoapMessage2::BaseConstructL (  MSenMessageContext &  aContext,
TSOAPVersion  aVersion
)  [protected]
 

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

Since:
Series60 4.0

Reimplemented from CSenSoapEnvelope2.

IMPORT_C void CSenSoapMessage2::BaseConstructL (  MSenMessageContext &  aContext  )  [protected]
 

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

Since:
Series60 4.0

Reimplemented from CSenSoapEnvelope2.

IMPORT_C void CSenSoapMessage2::BaseConstructL (  TSOAPVersion  aVersion,
const TDesC8 &  aSecurityNs
)  [protected]
 

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

Since:
Series60 4.0
IMPORT_C void CSenSoapMessage2::BaseConstructL (  TSOAPVersion  aVersion  )  [protected]
 

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

Since:
Series60 4.0

Reimplemented from CSenSoapEnvelope2.

IMPORT_C void CSenSoapMessage2::BaseConstructL (   )  [protected]
 

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

Since:
Series60 4.0

Reimplemented from CSenSoapEnvelope2.

virtual IMPORT_C MSenMessage* CSenSoapMessage2::CloneL (   )  [virtual]
 

Clone method that duplicates this message -- including all member data in the message.

For the service consumers, a typical use case for cloning the message is when there is need to preserve the received response beyond the life time of a transaction. Normally, the response messages, that are owned by service connection are de-allocated after execution returns from MSenServiceConsumer interface's HandleMessageL or HandleErrorL method, back to the service connection.

Returns:
a pointer to a new message class instance, which ownership IS transferred to a caller. Note that caller is expected to cast this pointer to a proper subclass via the use of IsSafeToCast method. In case of responses, the message type is normally equal with the type of the request message that was sent by the consumer.

Reimplemented from CSenSoapEnvelope2.

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

Two-phased copy constructor.

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

Two-phase constructor.

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

Two-phase constructor.

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

Two-phase constructor.

Reimplemented from CSenSoapEnvelope2.

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

Two-phase constructor.

static IMPORT_C CSenSoapMessage2* CSenSoapMessage2::NewL (  TSOAPVersion  aVersion  )  [static]
 

Two-phase constructor.

static IMPORT_C CSenSoapMessage2* CSenSoapMessage2::NewL (   )  [static]
 

Two-phase constructor.

Reimplemented from CSenSoapEnvelope2.

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

Two-phased copy constructor.

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

Two-phase constructor.

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

Two-phase constructor.

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

Two-phase constructor.

Reimplemented from CSenSoapEnvelope2.

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

Two-phase constructor.

static IMPORT_C CSenSoapMessage2* CSenSoapMessage2::NewLC (  TSOAPVersion  aVersion  )  [static]
 

Two-phase constructor.

static IMPORT_C CSenSoapMessage2* CSenSoapMessage2::NewLC (   )  [static]
 

Two-phase constructor.

Reimplemented from CSenSoapEnvelope2.

virtual IMPORT_C CSenWsSecurityHeader2* CSenSoapMessage2::NewSecurityHeaderLC (  const TDesC8 *  aData,
RSenDocument  aDocument,
TXmlEngElement  element
)  [protected, virtual]
 

Helper function to make a new security header.

Since:
Series60 4.0
Parameters:
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.
virtual IMPORT_C void CSenSoapMessage2::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:
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

Reimplemented from CSenSoapEnvelope2.

IMPORT_C void CSenSoapMessage2::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:
aData  Data to be used in the security header.
virtual IMPORT_C TClass CSenSoapMessage2::Type (   )  [virtual]
 

Gets the Message Type.

Reimplemented from CSenSoapEnvelope2.

Field Documentation

CSenWsSecurityHeader2* CSenSoapMessage2::ipSecurityHeader [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top