epoc32/include/mw/siphttpdigestchallengeobserver.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@2
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : siphttpdigestchallengeobserver.h
williamr@2
    16
* Part of     : SIP Client
williamr@2
    17
* Interface   : SDK API, SIP Client API
williamr@2
    18
* Version     : 1.0
williamr@2
    19
*
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
williamr@2
    23
williamr@2
    24
#ifndef MSIPHTTPDIGESTCHALLENGEOBSERVER_H
williamr@2
    25
#define MSIPHTTPDIGESTCHALLENGEOBSERVER_H
williamr@2
    26
williamr@2
    27
// FORWARD DECLARATIONS
williamr@2
    28
williamr@2
    29
// CLASS DECLARATION
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
* @publishedAll
williamr@2
    33
* @released
williamr@2
    34
*
williamr@2
    35
* The user must implement this interface if it intends to
williamr@2
    36
* provide HTTP Digest credentials upon received challenges
williamr@2
    37
* from the SIP servers on the signaling path.
williamr@2
    38
* The user should provide credentials or ignore the challenge
williamr@2
    39
* using functions defined in TSIPHttpDigest class.
williamr@2
    40
*
williamr@4
    41
* MSIPHttpDigestChallengeObserver class is compliant with RFC 2543
williamr@4
    42
* where Proxy use to forward only one challenge when it receives 
williamr@4
    43
* multiple challenges on forking the request. Applications are 
williamr@4
    44
* encouraged to use MSIPHttpDigestChallengeObserver2 class which
williamr@4
    45
* provides interface to extract multiple challenges.
williamr@4
    46
* MSIPHttpDigestChallengeObserver2 class is compliant to RFC 3261
williamr@2
    47
*  @lib n/a
williamr@2
    48
*/
williamr@2
    49
class MSIPHttpDigestChallengeObserver
williamr@2
    50
	{
williamr@2
    51
    public: // New functions
williamr@2
    52
		/**
williamr@2
    53
		* SIP request resulted in 401/407 response that contains
williamr@2
    54
		* a challenge.
williamr@2
    55
		*
williamr@2
    56
		* @param aRealm a realm for which the challenge was received
williamr@2
    57
		*/
williamr@2
    58
		virtual void ChallengeReceived(const TDesC8& aRealm) = 0;
williamr@2
    59
	};
williamr@2
    60
williamr@2
    61
#endif