CSenWsSecurityHeader Class Reference

API published in: S60 3rd Ed

Link against: senutils.lib

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData

#include <senwssecurityheader.h>

Inherits CSenBaseFragment.

Detailed Description

CSenWsSecurityHeader represents security header functionality according to oasis web services security (WSS) specifications (2004/01).

Public Member Functions
virtual IMPORT_C  ~CSenWsSecurityHeader ()
  Destructor.
IMPORT_C HBufC8 *  UsernameTokenL (CSenIdentityProvider &aIdentityProvider)
  Constructs a username token.
virtual IMPORT_C TPtrC8  XmlNs ()
  Basic getter for XML namespace of the WS security header.
virtual IMPORT_C TPtrC8  XmlNsPrefix ()
  Basic getter for XML namespace prefix of the WS security header.

Static Public Member Functions
static IMPORT_C CSenWsSecurityHeader *  NewL ()
  Basic constructor.
static IMPORT_C CSenWsSecurityHeader *  NewL (const TDesC8 &aData)
  Basic constructor.
static IMPORT_C TInt  UsernameTokenL (const TDesC8 &aUsername, HBufC8 *&aToken)
  Constructs a username token.

Protected Member Functions
IMPORT_C  CSenWsSecurityHeader ()
  C++ default constructor.
IMPORT_C void  BaseConstructL ()
  Basic BaseConstructL function.
IMPORT_C void  BaseConstructL (const TDesC8 &aData)
  From CSenBaseFragment Basic BaseConstructL function.

Constructor & Destructor Documentation

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

Destructor.

IMPORT_C CSenWsSecurityHeader::CSenWsSecurityHeader (   )  [protected]
 

C++ default constructor.

Member Function Documentation

IMPORT_C void CSenWsSecurityHeader::BaseConstructL (  const TDesC8 &  aData  )  [protected]
 

From CSenBaseFragment Basic BaseConstructL function.

Parameters:
aData  will be used as current token (content) of this security header

Reimplemented from CSenBaseFragment.

IMPORT_C void CSenWsSecurityHeader::BaseConstructL (   )  [protected]
 

Basic BaseConstructL function.

static IMPORT_C CSenWsSecurityHeader* CSenWsSecurityHeader::NewL (  const TDesC8 &  aData  )  [static]
 

Basic constructor.

Parameters:
aData  Data to be set as header's content.

Reimplemented from CSenBaseFragment.

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

Basic constructor.

static IMPORT_C TInt CSenWsSecurityHeader::UsernameTokenL (  const TDesC8 &  aUsername,
HBufC8 *&  aToken
)  [static]
 

Constructs a username token.

Parameters:
aUsername  User name which is used in the username token.
aToken  Ref-to-pointer which will contain the token in return. Shouldn't contain any data when called, or data will be lost.
Returns:
KErrNone or some system-wide Symbian error code.
IMPORT_C HBufC8* CSenWsSecurityHeader::UsernameTokenL (  CSenIdentityProvider &  aIdentityProvider  ) 
 

Constructs a username token.

Parameters:
aIdentityProvider  Identity provider which is used to get the authorization ID used in username token. Method takes the AuthzID out from aIdentityProvider, and uses it as username for this token. Format of the token is as follows:
<wsse:UsernameToken> <wsse:Username> username </wsse:Username> </wsse:UsernameToken>"

The above token assumes, that wsse namespace is declared in top level of the security header.

Returns:
a pointer to buffer containing the username token. Does not return NULL. Ownership is transferred to the caller.
virtual IMPORT_C TPtrC8 CSenWsSecurityHeader::XmlNs (   )  [virtual]
 

Basic getter for XML namespace of the WS security header.

Subclasses should override this to use different namespace

Returns:
the WS security header namespace as string
virtual IMPORT_C TPtrC8 CSenWsSecurityHeader::XmlNsPrefix (   )  [virtual]
 

Basic getter for XML namespace prefix of the WS security header.

Subclasses should override this to use different namespace prefix

Returns:
the WS security header namespace prefix as string
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top