PTLib  Version 2.10.4
PHTTPMultiSimpAuth Class Reference

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

#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
 Create a copy of the class on the heap.
virtual PString GetRealm (const PHTTPRequest &request) const
 Get the realm or name space for the user authorisation name and password as required by the basic authorisation system of HTTP/1.0.
virtual PBoolean Validate (const PHTTPRequest &request, const PString &authInfo) const
 Validate the user and password provided by the remote HTTP client for the realm specified by the class instance.
virtual PBoolean IsActive () const
 Determine if the authirisation is to be applied.
void AddUser (const PString &username, const PString &password)
 Get the user name allocated to this simple authorisation.

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

Parameters:
realmName space for the username and password.
PHTTPMultiSimpAuth::PHTTPMultiSimpAuth ( const PString realm,
const PStringToString userList 
)
Parameters:
realmName space for the usernames.
userListList of usernames and passwords.

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.
Parameters:
usernameUsername that this object wiull authorise.
passwordPassword for the above username.
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.
Parameters:
requestRequest information.

Implements PHTTPAuthority.

virtual PBoolean 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 PBoolean 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.
Parameters:
requestRequest information.
authInfoAuthority information string.

Implements PHTTPAuthority.


Member Data Documentation


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines