epoc32/include/mw/siphttpdigestchallengeobserver2.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/siphttpdigestchallengeobserver2.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,81 @@
     1.4 +/*
     1.5 +* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.6 +* All rights reserved.
     1.7 +* This component and the accompanying materials are made available
     1.8 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.9 +* which accompanies this distribution, and is available
    1.10 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.11 +*
    1.12 +* Initial Contributors:
    1.13 +* Nokia Corporation - initial contribution.
    1.14 +*
    1.15 +* Contributors:
    1.16 +*
    1.17 +* Description:
    1.18 +* Name        : siphttpdigestchallengeobserver2.h
    1.19 +* Part of     : SIP Client
    1.20 +* Interface   : SDK API, SIP Client API
    1.21 +* Version     : 1.0
    1.22 +*
    1.23 +*/
    1.24 +
    1.25 +
    1.26 +
    1.27 +#ifndef MSIPHTTPDIGESTCHALLENGEOBSERVER2_H
    1.28 +#define MSIPHTTPDIGESTCHALLENGEOBSERVER2_H
    1.29 +
    1.30 +// INCLUDES
    1.31 +#include <e32std.h>
    1.32 +
    1.33 +// FORWARD DECLARATIONS
    1.34 +class CSIPClientTransaction;
    1.35 +class CSIPRefresh;
    1.36 +
    1.37 +// CLASS DECLARATION
    1.38 +/**
    1.39 +* @publishedAll
    1.40 +* @released
    1.41 +*
    1.42 +* The user should implement this interface if it intends to
    1.43 +* provide HTTP Digest credentials upon received challenges
    1.44 +* from the SIP servers on the signaling path.
    1.45 +* The user should provide credentials or ignore the challenge
    1.46 +* using functions defined in CSIPHttpDigest class.
    1.47 +*
    1.48 +*  @lib n/a
    1.49 +*/
    1.50 +class MSIPHttpDigestChallengeObserver2
    1.51 +	{
    1.52 +    public: // New functions
    1.53 +		/**
    1.54 +		* A SIP request resulted in 401/407 response that contains
    1.55 +		* 1..n challenges. 
    1.56 +		* The challenges can be obtained from Proxy-Authenticate- and/or
    1.57 +		* WWW-Authenticate-headers in the CSIPResponseElements
    1.58 +		* attached to the CSIPClientTransaction.
    1.59 +		* The user must call CSIPHttpDigest::SetCredentialsL or
    1.60 +		* CSIPHttpDigest::IgnoreChallenge for each challenge.
    1.61 +		*
    1.62 +		* @param aTransaction transaction which was completed with 
    1.63 +		*        a response containing HTTP Digest challenge.
    1.64 +		*/
    1.65 +		virtual void ChallengeReceived(
    1.66 +		    const CSIPClientTransaction& aTransaction) = 0;
    1.67 +
    1.68 +		/**
    1.69 +		* A refreshed SIP request resulted in 401/407 response that contains
    1.70 +		* 1..n challenges.
    1.71 +		* The challenges can be obtained from Proxy-Authenticate- and/or
    1.72 +		* WWW-Authenticate-headers in the CSIPResponseElements
    1.73 +		* attached to the CSIPClientTransaction attached to the CSIPRefresh.
    1.74 +		* The user must call CSIPHttpDigest::SetCredentialsL or
    1.75 +		* CSIPHttpDigest::IgnoreChallenge for each challenge.		 
    1.76 +		*
    1.77 +		* @param aRefresh the refresh for which a transaction completed with 
    1.78 +		*        a response containing HTTP Digest challenge.
    1.79 +		*/		    
    1.80 +		virtual void ChallengeReceived(
    1.81 +		    const CSIPRefresh& aRefresh) = 0;		    
    1.82 +	};
    1.83 +
    1.84 +#endif // MSIPHTTPDIGESTCHALLENGEOBSERVER2_H