Collapse all Symbian^3 Product Developer Library

MSIPSecUser Class Reference

class MSIPSecUser

A callback used for identifying a user of SIPSec cache entries and requesting credentials for SIP responses containing challenges.

SipServer.exe

Public Member Functions
TBool	ByPassSIPSec()
TBool	PassOnlyRealmsToUser()
void	RequestCredentialsL(const TDesC8 &)
void	RequestCredentialsL(CSIPResponse &, TTransactionId, TRefreshId)
const MSIPSecUser *	TrustedUser(TRegistrationId)

Member Functions Documentation

ByPassSIPSec()

TBool

ByPassSIPSec

(

)

const [pure virtual]

Checks whether the requests and responses should be passed to SIPSec or should SIPSec be bypassed.

PassOnlyRealmsToUser()

TBool

PassOnlyRealmsToUser

(

)

const [pure virtual]

Checks whether only the realms for each challenge should be passed to the user or the whole responses containing 1..n challenges in WWW-Authenticate or/and Proxy-Authenticate-headers.

RequestCredentialsL(const TDesC8 &)

void

RequestCredentialsL

(

const TDesC8 &

aRealm

)

[pure virtual]

An asynchronous call to get username and password for a realm. CSIPSec::SetCredentialsL will be called when this asyncronous request completes.

Parameters

const TDesC8 & aRealm

the realm for the username and password.

RequestCredentialsL(CSIPResponse &, TTransactionId, TRefreshId)

void	RequestCredentialsL	(	CSIPResponse &	aResponse,
			TTransactionId	aTransactionId,
			TRefreshId	aRefreshId
		)	[pure virtual]

An asynchronous call to get usernames and passwords for the challenges contained in the SIP response. CSIPSec::SetCredentialsL or CSIPSec::IgnoreChallenge will be called for each challenge in the SIP response.

Parameters

CSIPResponse & aResponse	response that contains 1..n challenges.
TTransactionId aTransactionId	transaction ID
TRefreshId aRefreshId	refresh ID, KEmptyRefreshId if not known

TrustedUser(TRegistrationId)

const MSIPSecUser *

TrustedUser

(

TRegistrationId

aRegistrationId

)

[pure virtual]

Returns a user with which the credentials can be shared with. For example if a cache entry for a realm can be found for a challenge for another user, but not this one, this function is used to check if the existing credentials can be used.

Parameters

TRegistrationId aRegistrationId

registration ID associated with the trusted user