Wittyshare  0.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
WsAbstractAuth Class Referenceabstract

Abstract class for authentification. More...

#include <WsAbstractAuth.h>

Inheritance diagram for WsAbstractAuth:
Inheritance graph
Collaboration diagram for WsAbstractAuth:
Collaboration graph

Public Member Functions

virtual int authentify (const std::string &uid, const std::string &pass="", const std::string &ip="")=0
 authentify user with uid. More...
 
virtual std::string getUid ()=0
 return the user's id More...
 
virtual std::string getFirstName ()
 return the user's name More...
 
virtual std::string getSurname ()
 return the user's surname More...
 
virtual std::string getEmail ()
 return the user's email More...
 
virtual std::set< std::string > getUserGroups ()
 return the groups of the user More...
 
virtual std::set< std::string > getAllGroups ()
 return all the possible groups More...
 

Detailed Description

Abstract class for authentification.

Must be derived and virtual methods redefinied in the authentication module This class is used to load the Authentication Module

Definition at line 26 of file WsAbstractAuth.h.

Member Function Documentation

virtual int WsAbstractAuth::authentify ( const std::string &  uid,
const std::string &  pass = "",
const std::string &  ip = "" 
)
pure virtual

authentify user with uid.

Returns
SUCCESS if authentication succeeded, FAILURE otherwise
Parameters
uidthe user id used to retrieve user's infos
passthe password of the user
theip of the user

Implemented in WsLdapAuth, and WsBasicAuth.

std::set< std::string > WsAbstractAuth::getAllGroups ( )
virtual

return all the possible groups

Reimplemented in WsLdapAuth, and WsBasicAuth.

Definition at line 37 of file WsAbstractAuth.cpp.

std::string WsAbstractAuth::getEmail ( )
virtual

return the user's email

Reimplemented in WsLdapAuth, and WsBasicAuth.

Definition at line 27 of file WsAbstractAuth.cpp.

std::string WsAbstractAuth::getFirstName ( )
virtual

return the user's name

Reimplemented in WsLdapAuth, and WsBasicAuth.

Definition at line 17 of file WsAbstractAuth.cpp.

std::string WsAbstractAuth::getSurname ( )
virtual

return the user's surname

Reimplemented in WsLdapAuth, and WsBasicAuth.

Definition at line 22 of file WsAbstractAuth.cpp.

virtual std::string WsAbstractAuth::getUid ( )
pure virtual

return the user's id

Implemented in WsLdapAuth, and WsBasicAuth.

std::set< std::string > WsAbstractAuth::getUserGroups ( )
virtual

return the groups of the user

Reimplemented in WsLdapAuth, and WsBasicAuth.

Definition at line 32 of file WsAbstractAuth.cpp.


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