CSenIdentityProvider Class Reference

API published in: S60 3rd Ed

Link against: senservdesc.lib

Capability Information

Required Capabilities

NetworkServices ReadUserData WriteUserData

#include <senidentityprovider.h>

Detailed Description

Class describes some IdentityProvider service Class is intented to be used when registrating information about some identity providing service.

I case of ID-WSF framework, the IdentityProvider and Authentication Service are behind same endpoint. Typically, ID-WSF service consumers call both RegisterIdentityProviderL() and RegisterServiceDescriptionL() methods as defined in Service Management API (CSenServiceManager). Basic Web Service consumers use this class to register BASIC-AUTH credentials to certain pre-known service endpoint.


Public Member Functions
virtual IMPORT_C	~CSenIdentityProvider ()
	Destructor.
virtual IMPORT_C TPtrC8	AuthzID ()
	A getter.
virtual IMPORT_C TPtrC8	AdvisoryAuthnID ()
	A getter.
IMPORT_C TPtrC8	ProviderID ()
	A getter.
virtual IMPORT_C TPtrC8	Password ()
	A getter.
IMPORT_C const TDesC8 &	IMEI ()
	A getter.
IMPORT_C TPtrC8	UserName ()
	A getter.
IMPORT_C TInt	SetProviderID (const TDesC8 &aProviderID)
	Setter.
IMPORT_C TInt	SetServiceID (const TDesC8 &aServiceID)
	Setter for ServiceID.
IMPORT_C TBool	IsTrustedByL (MSenServiceDescription &aServiceDescription)
IMPORT_C TBool	IsTrustedByL (const TDesC8 &aProviderID)
IMPORT_C TBool	IsDefault ()
	Checks if this identity provider is set as default .
IMPORT_C TInt	SetUserInfoL (const TDesC8 &aAuthzID, const TDesC8 &aAdvisoryAuthnID, const TDesC8 &aPassword)
	Sets the user information.
IMPORT_C HBufC8 *	HttpCredentialsL (MSenIdentityManager &aIdMgr)
	Creates http-credentials by making password-username pair and encoding it with BASE-64.
IMPORT_C const TDesC8 &	NewElementName ()
Static Public Member Functions
static IMPORT_C CSenIdentityProvider *	NewL (const TDesC8 &aEndpoint)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewLC (const TDesC8 &aEndpoint)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewL (const TDesC8 &aEndpoint, const TDesC8 &aContract)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewLC (const TDesC8 &aEndpoint, const TDesC8 &aContract)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewL (const TDesC8 &aEndpoint, const TDesC8 &aContract, const TDesC8 &aProviderID)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewLC (const TDesC8 &aEndpoint, const TDesC8 &aContract, const TDesC8 &aProviderID)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewL (const TDesC8 &aEndpoint, const TDesC8 &aContract, const TDesC8 &aProviderID, const TDesC8 &aServiceID)
	Two-phased constructor.
static IMPORT_C CSenIdentityProvider *	NewLC (const TDesC8 &aEndpoint, const TDesC8 &aContract, const TDesC8 &aProviderID, const TDesC8 &aServiceID)
	Two-phased constructor.
Protected Member Functions
IMPORT_C	CSenIdentityProvider (TDescriptionClassType aType)
IMPORT_C void	ConstructL (const TDesC8 &aEndPoint)
	Standard 2nd phase constructor.
IMPORT_C void	ConstructL (const TDesC8 &aEndPoint, const TDesC8 &aContract)
IMPORT_C void	ConstructL (const TDesC8 &aEndPoint, const TDesC8 &aContract, const TDesC8 &aProviderID)
IMPORT_C void	ConstructL (const TDesC8 &aEndPoint, const TDesC8 &aContract, const TDesC8 &aProviderID, const TDesC8 &aServiceID)

Constructor & Destructor Documentation

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

Destructor.

IMPORT_C CSenIdentityProvider::CSenIdentityProvider ( TDescriptionClassType aType ) [protected]

Member Function Documentation

virtual IMPORT_C TPtrC8 CSenIdentityProvider::AdvisoryAuthnID ( ) [virtual]

A getter.

Returns:: a pointer to advisory authentication id

virtual IMPORT_C TPtrC8 CSenIdentityProvider::AuthzID ( ) [virtual]

A getter.

Returns:: a pointer to authorization id

IMPORT_C void CSenIdentityProvider::ConstructL	(	const TDesC8 &	aEndPoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID,
		const TDesC8 &	aServiceID
	)	`[protected]`

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service "urn:liberty:as:2004-04".
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework.
	aServiceID	is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows".

IMPORT_C void CSenIdentityProvider::ConstructL	(	const TDesC8 &	aEndPoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID
	)	`[protected]`

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service "urn:liberty:as:2004-04".
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework.

IMPORT_C void CSenIdentityProvider::ConstructL	(	const TDesC8 &	aEndPoint,
		const TDesC8 &	aContract
	)	`[protected]`

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default contract is Liberty ID-WSF Authentication Service "urn:liberty:as:2004-04".

Reimplemented from CSenXmlServiceDescription.

IMPORT_C void CSenIdentityProvider::ConstructL ( const TDesC8 & aEndPoint ) [protected]

Standard 2nd phase constructor.

Parameters:

aEndpoint

the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.

Reimplemented from CSenXmlServiceDescription.

IMPORT_C HBufC8* CSenIdentityProvider::HttpCredentialsL

(

MSenIdentityManager &

aIdMgr

)

Creates http-credentials by making password-username pair and encoding it with BASE-64.

Parameters:

aIdMgr

Identitymanager which is used to obtain a password if no password for this identityprovider was set.

Returns:: a newly allocated credentialbuffer. Ownership is transferred to the caller.

IMPORT_C const TDesC8& CSenIdentityProvider::IMEI

(

)

A getter.

Returns:: a pointer to IMEI

IMPORT_C TBool CSenIdentityProvider::IsDefault

(

)

Checks if this identity provider is set as default .

Returns:: ETrue if default-attribute was set, EFalse otherwise

IMPORT_C TBool CSenIdentityProvider::IsTrustedByL

Parameters:

Returns:: ETrue if the ServiceDescription, i.e. its endpoint or contract, is associated to this IdentityProvider. Or if the ServiceDescription is about this IdentityProvider. EFalse otherwise

IMPORT_C TBool CSenIdentityProvider::IsTrustedByL

(

MSenServiceDescription &

aServiceDescription

)

Parameters:

aServiceDescription

the service description to check

Returns:: ETrue if the ServiceDescription, i.e. its endpoint or contract, is associated to this IdentityProvider. Or if the ServiceDescription is about this IdentityProvider. EFalse otherwise

IMPORT_C const TDesC8& CSenIdentityProvider::NewElementName ( ) [virtual]

Returns:: Descriptor containing service description local name for this service description. This is the localname of the element, when this class is represented as an XML element.

Reimplemented from CSenXmlServiceDescription.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewL	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID,
		const TDesC8 &	aServiceID
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework.
	aServiceID	is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows".

Returns:: a new CSenIdentityProvider

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewL	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint.

Returns:: a new CSenIdentityProvider

Reimplemented from CSenDomFragment.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewL	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04

Returns:: a new CSenIdentityProvider

Reimplemented from CSenXmlServiceDescription.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewL ( const TDesC8 & aEndpoint ) [static]

Two-phased constructor.

Note: contract defaults here to "urn:liberty:as:2004-04"

Parameters:

aEndpoint

Returns:: a new CSenIdentityProvider

Reimplemented from CSenXmlServiceDescription.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewLC	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID,
		const TDesC8 &	aServiceID
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04
	aServiceID	is a unique contract to some invocable service. Typically some URN. If this IDP is registered to ID-WSF framework, this ServiceID will be appended into list of services which trust this IDP, and the actual IDP "knows".

Returns:: a new CSenIdentityProvider, which pointer is left on cleanup stack.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewLC	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract,
		const TDesC8 &	aProviderID
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04
	aProviderID	is identifier of this IdentityProvider. It is a unique key pointing to some known endpoint. Required only for ID-WSF framework.

Returns:: a new CSenIdentityProvider, which pointer is left on cleanup stack.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewLC	(	const TDesC8 &	aEndpoint,
		const TDesC8 &	aContract
	)	`[static]`

Two-phased constructor.

Parameters:

	aEndpoint	the service endpoint. Note that endpoint cannot include characters which are illegal in XML. If endpoint is an URL which contains illegal characters (like '&'-char), those need to be encoded into XML entity form (like &). EncodeHttpCharactersLC() method from XmlUtils can be used for encoding of basic XML entities.
	aContract	identifies the service type. Typically some URN. Default is Liberty ID-WSF Authentication Service contract: -- urn:liberty:as:2004-04

Returns:: a new CSenIdentityProvider, which pointer is left on cleanup stack.

Reimplemented from CSenXmlServiceDescription.

static IMPORT_C CSenIdentityProvider* CSenIdentityProvider::NewLC ( const TDesC8 & aEndpoint ) [static]

Two-phased constructor.

Note: contract defaults here to "urn:liberty:as:2004-04"

Parameters:

aEndpoint

Returns:: a new CSenIdentityProvider, which pointer is left on cleanup stack.

Reimplemented from CSenXmlServiceDescription.

virtual IMPORT_C TPtrC8 CSenIdentityProvider::Password ( ) [virtual]

A getter.

Returns:: a pointer to password

IMPORT_C TPtrC8 CSenIdentityProvider::ProviderID

(

)

A getter.

Returns:: a pointer to provider id

IMPORT_C TInt CSenIdentityProvider::SetProviderID

Setter.

Parameters:

aProviderID

the set id

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

IMPORT_C TInt CSenIdentityProvider::SetServiceID

Setter for ServiceID.

ServiceID is the contract of some invocable service, typically some URN. Note, that when registering an IDP the possibly existing list of ServiceIDs is not cleared, but the ServiceID set via this method is added as new entry into that list, if it was non-existent.

Parameters:

aServiceID

the set id