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