ERUCES::TELdapAuthenticationContext
#include <teauthldapctx.h>
The TELdapAuthenticationContext class is used for the management of LDAP users.
The TELdapAuthenticationContext class represents an username and password-based LDAP authentication context in which a LDAP user is authenticated by username and password. This class is derived from the TEAuthenticationContext class.
Inheritance
- Inherits ERUCES::TEAuthenticationContext
Private Attrib
| Type | Name | Description |
|---|---|---|
| _TESTD string * | m_pstrUser | |
| _TESTD string * | m_pstrPasswd |
Private Func
| Member | Description |
|---|---|
TELdapAuthenticationContext() | The TELdapAuthenticationContext constructor is the default class constructor. |
TELdapAuthenticationContext(const TELdapAuthenticationContext &) | The TELdapAuthenticationContext constructor copies a TELdapAuthenticationContext object. |
Public Member Functions
| Member | Description |
|---|---|
~TELdapAuthenticationContext() | The TELdapAuthenticationContext destructor is the class destructor. |
void setUser(const _TESTD string user) | The setUser method sets a username. |
const _TESTD string getUser() const | The getUser method returns a string representing a user name. |
void setPasswd(const _TESTD string passwd) | The setPasswd method sets a password. |
te_oid authenticate() | The authenticate method authenticates a principal. |
TEObject * clone() const | The clone method clones a TELdapAuthenticationContext object. |
Static Public Member Functions
| Member | Description |
|---|---|
_TESTD auto_ptr< TELdapAuthenticationContext > getInstance() | The getInstance method creates a new TELdapAuthenticationContext object. |
Member Function Documentation
TELdapAuthenticationContext()
The TELdapAuthenticationContext constructor is the default class constructor.
TELdapAuthenticationContext(const TELdapAuthenticationContext &)
The TELdapAuthenticationContext constructor copies a TELdapAuthenticationContext object.
~TELdapAuthenticationContext()
The TELdapAuthenticationContext destructor is the class destructor.
void setUser(const _TESTD string user)
The setUser method sets a username.
Parameters
| Parameter | Description |
|---|---|
user | A string representing a username. |
const _TESTD string getUser() const
The getUser method returns a string representing a user name.
Returns: Returns a string representing a username.
void setPasswd(const _TESTD string passwd)
The setPasswd method sets a password.
Parameters
| Parameter | Description |
|---|---|
passwd | A string representing a password. |
te_oid authenticate()
The authenticate method authenticates a principal.
Returns: Returns a long integer representing the principal ID of the authenticated principal.
TEObject * clone() const
The clone method clones a TELdapAuthenticationContext object.
Returns: Returns a cloned TEUserAuthenticationContext object.
_TESTD auto_ptr< TELdapAuthenticationContext > getInstance()
The getInstance method creates a new TELdapAuthenticationContext object.
Returns: Returns a smart pointer to a TEUserAuthenticationContext object.