epoc32/include/siphttpdigestchallengeobserver2.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 /*
     2 * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * 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
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 * Name        : siphttpdigestchallengeobserver2.h
    16 * Part of     : SIP Client
    17 * Interface   : SDK API, SIP Client API
    18 * Version     : 1.0
    19 *
    20 */
    21 
    22 
    23 
    24 #ifndef MSIPHTTPDIGESTCHALLENGEOBSERVER2_H
    25 #define MSIPHTTPDIGESTCHALLENGEOBSERVER2_H
    26 
    27 // INCLUDES
    28 #include <e32std.h>
    29 
    30 // FORWARD DECLARATIONS
    31 class CSIPClientTransaction;
    32 class CSIPRefresh;
    33 
    34 // CLASS DECLARATION
    35 /**
    36 * @publishedAll
    37 * @released
    38 *
    39 * The user should implement this interface if it intends to
    40 * provide HTTP Digest credentials upon received challenges
    41 * from the SIP servers on the signaling path.
    42 * The user should provide credentials or ignore the challenge
    43 * using functions defined in CSIPHttpDigest class.
    44 *
    45 *  @lib n/a
    46 */
    47 class MSIPHttpDigestChallengeObserver2
    48 	{
    49     public: // New functions
    50 		/**
    51 		* A SIP request resulted in 401/407 response that contains
    52 		* 1..n challenges. 
    53 		* The challenges can be obtained from Proxy-Authenticate- and/or
    54 		* WWW-Authenticate-headers in the CSIPResponseElements
    55 		* attached to the CSIPClientTransaction.
    56 		* The user must call CSIPHttpDigest::SetCredentialsL or
    57 		* CSIPHttpDigest::IgnoreChallenge for each challenge.
    58 		*
    59 		* @param aTransaction transaction which was completed with 
    60 		*        a response containing HTTP Digest challenge.
    61 		*/
    62 		virtual void ChallengeReceived(
    63 		    const CSIPClientTransaction& aTransaction) = 0;
    64 
    65 		/**
    66 		* A refreshed SIP request resulted in 401/407 response that contains
    67 		* 1..n challenges.
    68 		* The challenges can be obtained from Proxy-Authenticate- and/or
    69 		* WWW-Authenticate-headers in the CSIPResponseElements
    70 		* attached to the CSIPClientTransaction attached to the CSIPRefresh.
    71 		* The user must call CSIPHttpDigest::SetCredentialsL or
    72 		* CSIPHttpDigest::IgnoreChallenge for each challenge.		 
    73 		*
    74 		* @param aRefresh the refresh for which a transaction completed with 
    75 		*        a response containing HTTP Digest challenge.
    76 		*/		    
    77 		virtual void ChallengeReceived(
    78 		    const CSIPRefresh& aRefresh) = 0;		    
    79 	};
    80 
    81 #endif // MSIPHTTPDIGESTCHALLENGEOBSERVER2_H