PTLib
Version 2.10.11
|
This class describes the simplest authorisation mechanism for a Universal Resource Locator, a fixed realm, username and password. More...
#include <http.h>
Public Member Functions | |
PHTTPSimpleAuth (const PString &realm, const PString &username, const PString &password) | |
virtual PObject * | Clone () const |
Create a copy of the class on the heap. More... | |
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. More... | |
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. More... | |
virtual PBoolean | IsActive () const |
Determine if the authorisation is to be applied. More... | |
const PString & | GetUserName () const |
Get the user name allocated to this simple authorisation. More... | |
const PString & | GetPassword () const |
Get the password allocated to this simple authorisation. More... | |
![]() | |
virtual | ~PObject () |
virtual PINDEX | HashFunction () const |
This function yields a hash value required by the PDictionary class. More... | |
virtual Comparison | Compare (const PObject &obj) const |
Compare the two objects and return their relative rank. More... | |
virtual Comparison | CompareObjectMemoryDirect (const PObject &obj) const |
Determine the byte wise comparison of two objects. More... | |
bool | operator== (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator!= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator< (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator> (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator<= (const PObject &obj) const |
Compare the two objects. More... | |
bool | operator>= (const PObject &obj) const |
Compare the two objects. More... | |
virtual const char * | GetClass (unsigned ancestor=0) const |
Get the current dynamic type of the object instance. More... | |
PBoolean | IsClass (const char *cls) const |
virtual PBoolean | InternalIsDescendant (const char *clsName) const |
Determine if the dynamic type of the current instance is a descendent of the specified class. More... | |
virtual void | PrintOn (ostream &strm) const |
Output the contents of the object to the stream. More... | |
virtual void | ReadFrom (istream &strm) |
Input the contents of the object from the stream. More... | |
Protected Attributes | |
PString | realm |
PString | username |
PString | password |
Additional Inherited Members | |
![]() | |
enum | Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 } |
Result of the comparison operation performed by the Compare() function. More... | |
![]() | |
static Comparison | InternalCompareObjectMemoryDirect (const PObject *obj1, const PObject *obj2, PINDEX size) |
Internal function caled from CompareObjectMemoryDirect() More... | |
static const char * | Class () |
Get the name of the class as a C string. More... | |
![]() | |
PObject () | |
Constructor for PObject, made protected so cannot ever create one on its own. More... | |
![]() | |
static void | DecodeBasicAuthority (const PString &authInfo, PString &username, PString &password) |
This class describes the simplest authorisation mechanism for a Universal Resource Locator, a fixed realm, username and password.
PHTTPSimpleAuth::PHTTPSimpleAuth | ( | const PString & | realm, |
const PString & | username, | ||
const PString & | password | ||
) |
realm | Name space for the username and password. |
username | Username that this object wiull authorise. |
password | Password for the above username. |
|
virtual |
Create a copy of the class on the heap.
This is used by the PHTTPResource
classes for maintaining authorisation to resources.
Reimplemented from PObject.
|
inline |
Get the password allocated to this simple authorisation.
References password.
|
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.
request | Request information. |
Implements PHTTPAuthority.
|
inline |
Get the user name allocated to this simple authorisation.
References username.
|
virtual |
Determine if the authorisation 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.
Reimplemented from PHTTPAuthority.
|
virtual |
Validate the user and password provided by the remote HTTP client for the realm specified by the class instance.
request | Request information. |
authInfo | Authority information string. |
Implements PHTTPAuthority.
|
protected |
Referenced by GetPassword().
|
protected |
|
protected |
Referenced by GetUserName().