ERUCES::TEUserAuthenticationContext
#include <teauthuserctx.h>
The TEUserAuthenticationContext class is used to manage Native users.
The TEUserAuthenticationContext represents a username and password-based user authentication context in which a user is authenticated by a 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 |
|---|---|
TEUserAuthenticationContext() | The TEUserAuthenticationContext constructor is the default class constructor. |
TEUserAuthenticationContext(const TEUserAuthenticationContext &) | The TEUserAuthenticationContext constructor copies a TEUserAuthenticationContext object. |
Public Member Functions
| Member | Description |
|---|---|
~TEUserAuthenticationContext() | The TEUserAuthenticationContext destructor is the class destructor. |
void setUser(_TESTD string user) | The setUser method sets a username. |
_TESTD string getUser() | The getUser method retrieves a username. |
void setPasswd(_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 TEUserAuthenticationContext object. |
Static Public Member Functions
| Member | Description |
|---|---|
_TESTD auto_ptr< TEUserAuthenticationContext > getInstance() | The getInstance method creates a new TEUserAuthenticationContext object. |
Member Function Documentation
TEUserAuthenticationContext()
The TEUserAuthenticationContext constructor is the default class constructor.
TEUserAuthenticationContext(const TEUserAuthenticationContext &)
The TEUserAuthenticationContext constructor copies a TEUserAuthenticationContext object.
~TEUserAuthenticationContext()
The TEUserAuthenticationContext destructor is the class destructor.
void setUser(_TESTD string user)
The setUser method sets a username.
Parameters
| Parameter | Description |
|---|---|
user | A string representing an username. |
_TESTD string getUser()
The getUser method retrieves a username.
Returns: Returns a string representing an username.
void setPasswd(_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 TEUserAuthenticationContext object.
Returns: Returns a cloned TEUserAuthenticationContext object
_TESTD auto_ptr< TEUserAuthenticationContext > getInstance()
The getInstance method creates a new TEUserAuthenticationContext object.
Returns: Returns a smart pointer to a TEUserAuthenticationContext object.