epoc32/include/http/cauthenticationfilterinterface.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- a/epoc32/include/http/cauthenticationfilterinterface.h	Tue Mar 16 16:12:26 2010 +0000
     1.2 +++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.3 @@ -1,93 +0,0 @@
     1.4 -// Copyright (c) 2001-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 -// All rights reserved.
     1.6 -// This component and the accompanying materials are made available
     1.7 -// 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.8 -// which accompanies this distribution, and is available
     1.9 -// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 -//
    1.11 -// Initial Contributors:
    1.12 -// Nokia Corporation - initial contribution.
    1.13 -//
    1.14 -// Contributors:
    1.15 -//
    1.16 -// Description:
    1.17 -//
    1.18 -
    1.19 -
    1.20 -
    1.21 -/**
    1.22 - @file CAuthenticationFilterInterface.h
    1.23 - @warning : This file contains Rose Model ID comments - please do not delete
    1.24 -*/
    1.25 -
    1.26 -#ifndef	__CAUTHENTICATIONFILTERINTERFACE_H__
    1.27 -#define	__CAUTHENTICATIONFILTERINTERFACE_H__
    1.28 -
    1.29 -// System includes
    1.30 -#include <e32base.h>
    1.31 -#include <ecom/ecom.h>
    1.32 -#include <http/rhttpsession.h>
    1.33 -
    1.34 -// Forward declarations
    1.35 -class MHTTPAuthenticationCallback;
    1.36 -
    1.37 -
    1.38 -class CAuthenticationFilterInterface : public CBase
    1.39 -/**
    1.40 -The ECOM interface definition for an HTTP authentication filter.  Implementations
    1.41 -of an authentication filter must inherit this class.
    1.42 -@publishedAll
    1.43 -@released
    1.44 -*/
    1.45 -	{
    1.46 -public: // Methods
    1.47 -	/**
    1.48 -	@fn				InstallFilterL(RHTTPSession& aSession, MHTTPAuthenticationCallback* aCallback)
    1.49 -	Intended Usage:	This method is used to install the authentication filter to the filter queue.
    1.50 -					The returned pointer is not owned as the filters must be self-destroying when
    1.51 -					they are unloaded.
    1.52 -	@param			aSession A handle to the transport session
    1.53 -	@param			aCallback A pointer to the object implementing the callback function
    1.54 -	@return			Pointer to the newly installed plugin
    1.55 -	@pre 			The session had already been setup
    1.56 -	@post			The filter(s) have been installed
    1.57 -	*/
    1.58 -	inline static void InstallFilterL(RHTTPSession& aSession, MHTTPAuthenticationCallback* aCallback);
    1.59 -
    1.60 -	/**
    1.61 -	@fn				~CAuthenticationFilterInterface()
    1.62 -	Intended Usage:	Virtual destructor
    1.63 -	@pre 			The object identified by the destructor key in iEcomDtorID exists
    1.64 -	@post			The object is destroyed
    1.65 -	*/
    1.66 -	inline ~CAuthenticationFilterInterface();
    1.67 -
    1.68 -public:
    1.69 -	struct TAuthenticationParams
    1.70 -		{
    1.71 -		RHTTPSession* iSession;
    1.72 -		MHTTPAuthenticationCallback* iCallback;
    1.73 -		};
    1.74 -
    1.75 -private: // Attributes
    1.76 -	/// The ECom destructor key identifier
    1.77 -	TUid iEcomDtorID;
    1.78 -	};
    1.79 -
    1.80 -//----------------------------------------------------------------------------------------
    1.81 -
    1.82 -inline void CAuthenticationFilterInterface::InstallFilterL(RHTTPSession& aSession, MHTTPAuthenticationCallback* aCallback)
    1.83 -	{
    1.84 -	const TUid KUidAuthenticationFilter = {0x101F447C};
    1.85 -	TAuthenticationParams authParams;
    1.86 -	authParams.iSession = &aSession;
    1.87 -	authParams.iCallback = aCallback;
    1.88 -	REComSession::CreateImplementationL(KUidAuthenticationFilter, _FOFF(CAuthenticationFilterInterface,iEcomDtorID), &authParams);
    1.89 -	}
    1.90 -
    1.91 -inline CAuthenticationFilterInterface::~CAuthenticationFilterInterface()
    1.92 -	{
    1.93 -	REComSession::DestroyedImplementation(iEcomDtorID);
    1.94 -	}
    1.95 -
    1.96 -#endif // __CAUTHENTICATIONFILTERINTERFACE_H__