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

#include <http.h>

Inheritance diagram for PHTTPAuthority:

Collaboration diagram for PHTTPAuthority:

Public Member Functions
virtual PString	GetRealm (const PHTTPRequest &request) const =0
	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 =0
	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...

Public Member Functions inherited from PObject
__inline unsigned	GetTraceContextIdentifier () const
	Get PTRACE context identifier. More...

__inline void	SetTraceContextIdentifier (unsigned id)

__inline void	SetTraceContextIdentifier (const PObject &obj)

__inline void	SetTraceContextIdentifier (const PObject *obj)

__inline void	CopyTraceContextIdentifier (PObject &obj) const

__inline void	CopyTraceContextIdentifier (PObject *obj) const

virtual	~PObject ()

__inline const char *	GetClass () const

__inline bool	IsClass (const char *name) const

__inline const PObject *	PTraceObjectInstance () const

virtual PObject *	Clone () const
	Create a copy of the class on the heap. More...

template<class CLS >
CLS *	CloneAs () const
	As for Clone() but converts to specified type. More...

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 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...

Static Protected Member Functions
static void	DecodeBasicAuthority (const PString &authInfo, PString &username, PString &password)

Additional Inherited Members
Public Types inherited from PObject
enum	Comparison { LessThan = -1, EqualTo = 0, GreaterThan = 1 }
	Result of the comparison operation performed by the `Compare()` function. More...

Static Public Member Functions inherited from PObject
static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject &to, const PObject *from)

static __inline void	CopyTraceContextIdentifier (PObject *to, const PObject &from)

static __inline void	CopyTraceContextIdentifier (PObject to, const PObject from)

static __inline const char *	Class ()

static __inline const PObject *	PTraceObjectInstance (const char *)

static __inline const PObject *	PTraceObjectInstance (const PObject *obj)

template<typename T >
static Comparison	Compare2 (T v1, T v2)
	Compare two types, returning Comparison type. More...

static Comparison	InternalCompareObjectMemoryDirect (const PObject obj1, const PObject obj2, PINDEX size)
	Internal function caled from CompareObjectMemoryDirect() More...

Protected Member Functions inherited from PObject
	PObject ()
	Constructor for PObject, made protected so cannot ever create one on its own. More...

Protected Attributes inherited from PObject
unsigned	m_traceContextIdentifier

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
	)

staticprotected

Parameters

authInfo	Authority information string.
username	User name decoded from authInfo
password	Password decoded from authInfo

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.

Parameters

request Request information.

Implemented in PHTTPMultiSimpAuth, and PHTTPSimpleAuth.

virtual PBoolean PHTTPAuthority::IsActive ( ) const

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.

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

Reimplemented in PHTTPMultiSimpAuth, and PHTTPSimpleAuth.

virtual PBoolean 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.

Parameters

request	Request information.
authInfo	Authority information string.

Implemented in PHTTPMultiSimpAuth, and PHTTPSimpleAuth.

The documentation for this class was generated from the following file:

http.h

Public Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation