Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Class Members | File Members

PHTTPAuthority Class Reference

#include <http.h>

Inheritance diagram for PHTTPAuthority:

PObject PHTTPMultiSimpAuth PHTTPSimpleAuth List of all members.

Public Member Functions

virtual PString GetRealm (const PHTTPRequest &request) const =0
virtual BOOL Validate (const PHTTPRequest &request, const PString &authInfo) const =0
virtual BOOL IsActive () const

Static Protected Member Functions

static void DecodeBasicAuthority (const PString &authInfo, PString &username, PString &password)

Detailed Description

This abstract class describes the authorisation mechanism for a Universal Resource Locator.


Member Function Documentation

static void PHTTPAuthority::DecodeBasicAuthority const PString authInfo,
PString username,
PString password
[static, protected]
 

virtual PString PHTTPAuthority::GetRealm const PHTTPRequest request  )  const [pure virtual]
 

Get the realm or name space for the user authorisation name and password as required by the basic authorisation system of HTTP/1.0.

Returns:
String for the authorisation realm name.

Implemented in PHTTPSimpleAuth, and PHTTPMultiSimpAuth.

virtual BOOL PHTTPAuthority::IsActive  )  const [virtual]
 

Determine if the authirisation is to be applied. This could be used to distinguish between net requiring authorisation and requiring autorisation but having no password.

The default behaviour is to return TRUE.

Returns:
TRUE if the authorisation in the realm is to be applied.

Reimplemented in PHTTPSimpleAuth, and PHTTPMultiSimpAuth.

virtual BOOL PHTTPAuthority::Validate const PHTTPRequest request,
const PString authInfo
const [pure virtual]
 

Validate the user and password provided by the remote HTTP client for the realm specified by the class instance.

Returns:
TRUE if the user and password are authorised in the realm.

Implemented in PHTTPSimpleAuth, and PHTTPMultiSimpAuth.


The documentation for this class was generated from the following file:
Generated on Wed Sep 28 10:27:35 2005 for PWLib by  doxygen 1.4.4