CSenSoapMessage Class Reference

API published in: S60 3rd Ed

Link against: senutils.lib

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData

#include <sensoapmessage.h>

Inherits CSenSoapEnvelope.

Detailed Description

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

Public Member Functions
virtual IMPORT_C  ~CSenSoapMessage ()
  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.

Static Public Member Functions
static IMPORT_C CSenSoapMessage *  NewL ()
  Two-phase constructor.

Protected Member Functions
IMPORT_C  CSenSoapMessage ()
  C++ default constructor.
virtual IMPORT_C CSenWsSecurityHeader *  NewSecurityHeaderLC (const TDesC8 *aData=NULL)
  Helper function to make a new security header.
virtual IMPORT_C void  ParseHeaderL (const TDesC8 &aNsUri, const TDesC8 &aLocalName, const TDesC8 &aQName, const RAttributeArray &aAttributes)
  Implements functionality to parse SOAP header if one is found during parsing the envelope.
IMPORT_C void  BaseConstructL ()
  This method should be called from the deriving classes ConstructL() methods.

Protected Attributes
CSenWsSecurityHeader *  ipSecurityHeader

Constructor & Destructor Documentation

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

Destructor.

IMPORT_C CSenSoapMessage::CSenSoapMessage (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C TInt CSenSoapMessage::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.

Parameters:
aNewToken  Token to be inserted.
Returns:
KErrNone or some system-wide Symbian error codes.
IMPORT_C void CSenSoapMessage::BaseConstructL (   )  [protected]
 

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

Reimplemented from CSenSoapEnvelope.

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

Two-phase constructor.

Reimplemented from CSenSoapEnvelope.

virtual IMPORT_C CSenWsSecurityHeader* CSenSoapMessage::NewSecurityHeaderLC (  const TDesC8 *  aData = NULL  )  [protected, virtual]
 

Helper function to make a new security header.

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 CSenSoapMessage::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.

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 CSenSoapEnvelope.

IMPORT_C void CSenSoapMessage::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.

Parameters:
aData  Data to be used in the security header.

Field Documentation

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