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

PHTTPMultiSimpAuth Class Reference

#include <http.h>

Inheritance diagram for PHTTPMultiSimpAuth:

PHTTPAuthority PObject List of all members.

Public Member Functions

 PHTTPMultiSimpAuth (const PString &realm)
 PHTTPMultiSimpAuth (const PString &realm, const PStringToString &userList)
virtual PObjectClone () const
virtual PString GetRealm (const PHTTPRequest &request) const
virtual BOOL Validate (const PHTTPRequest &request, const PString &authInfo) const
virtual BOOL IsActive () const
void AddUser (const PString &username, const PString &password)

Protected Attributes

PString realm
PStringToString users

Detailed Description

This class describes the simple authorisation mechanism for a Universal Resource Locator, a fixed realm, multiple usernames and passwords.


Constructor & Destructor Documentation

PHTTPMultiSimpAuth::PHTTPMultiSimpAuth const PString realm  ) 
 

PHTTPMultiSimpAuth::PHTTPMultiSimpAuth const PString realm,
const PStringToString userList
 


Member Function Documentation

void PHTTPMultiSimpAuth::AddUser const PString username,
const PString password
 

Get the user name allocated to this simple authorisation.

Returns:
String for the authorisation user name.

virtual PObject* PHTTPMultiSimpAuth::Clone  )  const [virtual]
 

Create a copy of the class on the heap. This is used by the PHTTPResource# classes for maintaining authorisation to resources.

Returns:
pointer to new copy of the class instance.

Reimplemented from PObject.

virtual PString PHTTPMultiSimpAuth::GetRealm const PHTTPRequest request  )  const [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.

Implements PHTTPAuthority.

virtual BOOL PHTTPMultiSimpAuth::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 from PHTTPAuthority.

virtual BOOL PHTTPMultiSimpAuth::Validate const PHTTPRequest request,
const PString authInfo
const [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.

Implements PHTTPAuthority.


Member Data Documentation

PString PHTTPMultiSimpAuth::realm [protected]
 

PStringToString PHTTPMultiSimpAuth::users [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:35:58 2004 for PWLib by doxygen 1.3.7