PTLib  Version 2.10.4
PHTTPClientAuthentication Class Reference

#include <http.h>

Inheritance diagram for PHTTPClientAuthentication:
PObject PHTTPClientBasicAuthentication PHTTPClientDigestAuthentication

List of all members.

Classes

class  AuthObject

Public Member Functions

 PHTTPClientAuthentication ()
virtual Comparison Compare (const PObject &other) const
 Compare the two objects and return their relative rank.
virtual PBoolean Parse (const PString &auth, PBoolean proxy)=0
virtual PBoolean Authorise (AuthObject &pdu) const =0
virtual PBoolean IsProxy () const
virtual PString GetUsername () const
virtual PString GetPassword () const
virtual PString GetAuthRealm () const
virtual void SetUsername (const PString &user)
virtual void SetPassword (const PString &pass)
virtual void SetAuthRealm (const PString &)
PString GetAuthParam (const PString &auth, const char *name) const
PString AsHex (PMessageDigest5::Code &digest) const
PString AsHex (const PBYTEArray &data) const

Static Public Member Functions

static PHTTPClientAuthenticationParseAuthenticationRequired (bool isProxy, const PMIMEInfo &line, PString &errorMsg)

Protected Attributes

PBoolean isProxy
PString username
PString password

Constructor & Destructor Documentation


Member Function Documentation

virtual Comparison PHTTPClientAuthentication::Compare ( const PObject obj) const [virtual]

Compare the two objects and return their relative rank.

This function is usually overridden by descendent classes to yield the ranking according to the semantics of the object.

The default function is to use the CompareObjectMemoryDirect() function to do a byte wise memory comparison of the two objects.

Returns:
LessThan, EqualTo or GreaterThan according to the relative rank of the objects.

Reimplemented from PObject.

Reimplemented in PHTTPClientDigestAuthentication, and PHTTPClientBasicAuthentication.

PString PHTTPClientAuthentication::GetAuthParam ( const PString auth,
const char *  name 
) const
virtual PString PHTTPClientAuthentication::GetAuthRealm ( ) const [inline, virtual]

Reimplemented in PHTTPClientDigestAuthentication.

References PString::Empty().

virtual PString PHTTPClientAuthentication::GetPassword ( ) const [inline, virtual]

References password.

virtual PString PHTTPClientAuthentication::GetUsername ( ) const [inline, virtual]

References username.

virtual PBoolean PHTTPClientAuthentication::IsProxy ( ) const [inline, virtual]

References isProxy.

virtual PBoolean PHTTPClientAuthentication::Parse ( const PString auth,
PBoolean  proxy 
) [pure virtual]
static PHTTPClientAuthentication* PHTTPClientAuthentication::ParseAuthenticationRequired ( bool  isProxy,
const PMIMEInfo line,
PString errorMsg 
) [static]
virtual void PHTTPClientAuthentication::SetAuthRealm ( const PString ) [inline, virtual]
virtual void PHTTPClientAuthentication::SetPassword ( const PString pass) [inline, virtual]

References password.

virtual void PHTTPClientAuthentication::SetUsername ( const PString user) [inline, virtual]

References username.


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