CAuthenticationFilterInterface Class Reference

#include <mw/http/cauthenticationfilterinterface.h>

class CAuthenticationFilterInterface : public CBase

Inherits from

  • CAuthenticationFilterInterface

Detailed Description

The ECOM interface definition for an HTTP authentication filter. Implementations of an authentication filter must inherit this class.

Constructor & Destructor Documentation

~CAuthenticationFilterInterface ( )

~CAuthenticationFilterInterface()[inline]
Intended Usage: Virtual destructor
Pre-condition
The object identified by the destructor key in iEcomDtorID exists
Post-condition
The object is destroyed

Member Function Documentation

InstallFilterL ( RHTTPSession &, MHTTPAuthenticationCallback * )

voidInstallFilterL(RHTTPSession &aSession,
MHTTPAuthenticationCallback *aCallback
)[static, inline]
Intended Usage: This method is used to install the authentication filter to the filter queue. The returned pointer is not owned as the filters must be self-destroying when they are unloaded.
Pre-condition
The session had already been setup
Post-condition
The filter(s) have been installed
Parameters
aSessionA handle to the transport session
aCallbackA pointer to the object implementing the callback function
Return Value
Pointer to the newly installed plugin