MSenAuthenticationProvider Class Reference

Link against: SenServConn.LIB SenUtils.LIB

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData


#include <
MSenAuthenticationProvider.h>

Detailed Description

Interface description:.

The applications can register this callback interface, through which they will receive userinfo callbacks (when data like username and password is needed).

Both Service Connection and Service Manager APIs utilize this interface.

In practice, service consumer applications often integrate these callbacks to their UI events, allowing them a control point end-user (login) prompts.

Furthermore, (remote) service management applications can provide identity (user account) spesific "secret", in order to manipulate associated credentials stored in Web Services -stack database(s).


Public Member Functions

virtual const CSenIdentityProviderIdentityProviderL ()
 If (consumer) application needs to access protected information or service (behind some identity / account / sing-in process), it may choose to override this method.
virtual const TPtrC8 UsernameL ()
 Callback type getter for username.
virtual const TPtrC8 PasswordL ()
 Callback type getter for password.
virtual TAny * ExtendedInterface (const TInt32)
 This method obtains the callback interface matching the specified uid.

Member Function Documentation

virtual TAny* MSenAuthenticationProvider::ExtendedInterface const   TInt32  )  [inline, virtual]
 

This method obtains the callback interface matching the specified uid.

Parameters:
aUid the uid identifying the required interface.
Returns:
NULL if no interface matching the uid is found. Otherwise, attempt to dynamically cast this pointer to that interface will be made.
virtual const CSenIdentityProvider* MSenAuthenticationProvider::IdentityProviderL  )  [inline, virtual]
 

If (consumer) application needs to access protected information or service (behind some identity / account / sing-in process), it may choose to override this method.

Returned object represents XML containing all required information that is required to securely authenticate the identity in question. In case that only username & password -pair is needed, application may alternatively implement UsernameL() and PasswordL() callbacks. the identity provider description that contains "credentials", like like username and password of some identity (user's account), or other (binary) secret, like fingerprint.

virtual const TPtrC8 MSenAuthenticationProvider::PasswordL  )  [inline, virtual]
 

Callback type getter for password.

Application may choose to provide the passport of an account through this method. In cases where the "secret" is in simple text format (descriptor), this may be the most convenient method to be overridden. Alternatively, in complex cases, applications may choose to provide identity provider (IDP) description, a piece of XML through IdentityProviderL() callback; that XML could contain extended amount of (binary) information, like fingerprint. Consumer application is supposed to decide, whether or not to show a GUI dialog when this callback is issued: in many cases, that is a common approach to prompt userinfo directly from end-user (unless data is cached elsewhere).

Returns:
Password as string (UTF-8 descriptor)
virtual const TPtrC8 MSenAuthenticationProvider::UsernameL  )  [inline, virtual]
 

Callback type getter for username.

through this method an application may choose to provide the username of an account it wishes to use. In cases where the username (login ID) is in simple text format (descriptor), this may be the most convenient method to be overridden. Alternatively, in complex cases, applications may choose to provide identity provider (IDP) description, a piece of XML through IdentityProviderL() callback; that XML could contain extended amount of (binary) information, like fingerprint. Consumer application is supposed to decide, whether or not to show a GUI dialog when this callback is issued: in many cases, that is a common approach to prompt userinfo directly from end-user (unless data is cached elsewhere).

Returns:
Password as string (UTF-8 descriptor)

The documentation for this class was generated from the following file:

Copyright © Nokia Corporation 2001-2007
Back to top