S60 3rd Edition API Reference: CSIPHttpDigest Class Reference

CSIPHttpDigest Class Reference

API published in: S60 2nd Ed

Link against: sipclient.lib

Capability Information

Required Capabilities

Location NetworkControl NetworkServices ReadDeviceData WriteDeviceData

#include <siphttpdigest.h>

Detailed Description

PublishedAll
Released
Class for managing SIP HTTP Digest security settings. Class provides functions for setting/removing HTTP Digest security mechanism related parameters. If the user does not use the class for the providing credentials for the received challenges, an error will be returned to the original request in case it was challenged.

Note that the user will be asked to provide credentials one realm at the time.


Public Member Functions

IMPORT_C ~CSIPHttpDigest ()
IMPORT_C void SetCredentialsL (const TDesC8 &aOutboundProxy, const TDesC8 &aRealm, const TDesC8 &aUsername, const TDesC8 &aPasswd)
 Sets credentials for the realm of the outbound proxy.
IMPORT_C void SetCredentialsL (const TDesC8 &aRealm, const TDesC8 &aUsername, const TDesC8 &aPasswd)
 Sets parameters for the realm.
IMPORT_C TInt RemoveCredentials (const TDesC8 &aRealm)
 Removes all set credentials for the realm.
IMPORT_C TInt RemoveCredentials ()
 Removes all set credentials by the user.
IMPORT_C void SetObserver (MSIPHttpDigestChallengeObserver &aObserver)
 Sets the observer to listen for the possible received challenges.
IMPORT_C TInt IgnoreChallenge (const TDesC8 &aRealm)
 Ignores the challenge for the realm.
void CSIPDeleted ()
void SetCredentialParamsL (const TDesC8 &aRealm, const TDesC8 &aUsername, const TDesC8 &aPasswd, const TDesC8 &aOutboundProxy) const
TInt RemoveCredentialParams (const TDesC8 &aRealm) const

Static Public Member Functions

static IMPORT_C CSIPHttpDigest * NewL (CSIP &aSIP, MSIPHttpDigestChallengeObserver &aObserver)
 Two-phased constructor.
static IMPORT_C CSIPHttpDigest * NewLC (CSIP &aSIP, MSIPHttpDigestChallengeObserver &aObserver)
 Two-phased constructor.

Constructor & Destructor Documentation

IMPORT_C CSIPHttpDigest::~CSIPHttpDigest (   ) 
 

Member Function Documentation

void CSIPHttpDigest::CSIPDeleted (   ) 
 
IMPORT_C TInt CSIPHttpDigest::IgnoreChallenge ( const TDesC8 &  aRealm  ) 
 

Ignores the challenge for the realm.

As a result the error will be generated to the original request in case

Precondition:
aRealm must not be an empty descriptor
Parameters:
aRealm a realm for which the challenge was ignored
Returns:
KErrNone if no error KErrNotFound if the given realm was not found KErrArgument if aRealm is an empty descriptor
static IMPORT_C CSIPHttpDigest* CSIPHttpDigest::NewL ( CSIP &  aSIP,
MSIPHttpDigestChallengeObserver &  aObserver
)  [static]
 

Two-phased constructor.

Parameters:
aSIP a handle to SIP server
aObserver an observer for the received challenges
Returns:
New object, ownership is transferred.
static IMPORT_C CSIPHttpDigest* CSIPHttpDigest::NewLC ( CSIP &  aSIP,
MSIPHttpDigestChallengeObserver &  aObserver
)  [static]
 

Two-phased constructor.

Parameters:
aSIP a handle to SIP server
aObserver an observer for the received challenges
Returns:
New object, ownership is transferred.
TInt CSIPHttpDigest::RemoveCredentialParams ( const TDesC8 &  aRealm  )  const
 
IMPORT_C TInt CSIPHttpDigest::RemoveCredentials (   ) 
 

Removes all set credentials by the user.

Returns:
KErrNone if succesful; KErrNoMemory if out of memory
IMPORT_C TInt CSIPHttpDigest::RemoveCredentials ( const TDesC8 &  aRealm  ) 
 

Removes all set credentials for the realm.

Precondition:
aRealm must not be an empty descriptor
Parameters:
aRealm servers's realm
Returns:
KErrNone if no error KErrArgument if aRealm is an empty descriptor KErrNoMemory if out of memory KErrNotFound if the given realm was not found
void CSIPHttpDigest::SetCredentialParamsL ( const TDesC8 &  aRealm,
const TDesC8 &  aUsername,
const TDesC8 &  aPasswd,
const TDesC8 &  aOutboundProxy
)  const
 
IMPORT_C void CSIPHttpDigest::SetCredentialsL ( const TDesC8 &  aRealm,
const TDesC8 &  aUsername,
const TDesC8 &  aPasswd
) 
 

Sets parameters for the realm.

The user can set credentials only upon request from the SIP implementation.

Precondition:
aRealm, aUsername and aPasswd must not be empty descriptors.
Parameters:
aRealm servers's realm
aUsername user's name
aPasswd user's password for the given server's realm
Leave:
KErrNoMemory if out of memory
Leave:
KErrArgument if some of the parameters is an empty descriptor
Leave:
KErrSIPResourceNotAvailable if a required object has been deleted
IMPORT_C void CSIPHttpDigest::SetCredentialsL ( const TDesC8 &  aOutboundProxy,
const TDesC8 &  aRealm,
const TDesC8 &  aUsername,
const TDesC8 &  aPasswd
) 
 

Sets credentials for the realm of the outbound proxy.

Must be used in case the realm is the realm of the outbound proxy. The user can set credentials only upon request from the SIP implementation.

Precondition:
aOutboundProxy, aRealm, aUsername and aPasswd must not be empty descriptors.
Parameters:
aOutboundProxy an outbound proxy (FQDN or IP address)
aRealm servers's realm
aUsername user's name
aPasswd user's password for the given server's realm
Leave:
KErrNoMemory if out of memory
Leave:
KErrArgument if some of the parameters is an empty descriptor
Leave:
KErrSIPResourceNotAvailable if a required object has been deleted
IMPORT_C void CSIPHttpDigest::SetObserver ( MSIPHttpDigestChallengeObserver &  aObserver  ) 
 

Sets the observer to listen for the possible received challenges.

Parameters:
aObserver an observer for the received challenges.
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2007
Back to top