ERUCES::TECookieAuthenticationContext
#include <teauthcookiectx.h>
The TECookieAuthenticationContext class is used to manage Token authentication.
The TECookieAuthenticationContext represents Token authentication context in which user is authenticated by presented Token. A Token can be obtained through other type of authentications such as Native authentication, Kerberos authentication, LDAP authentication, etc.This class is derived from TEAuthenticationContext class.
Inheritance
- Inherits ERUCES::TEAuthenticationContext
Private Func
| Member | Description |
|---|---|
TECookieAuthenticationContext() | The TECookieAuthenticationContext constructor is the default class constructor. |
TECookieAuthenticationContext(const TECookieAuthenticationContext &) | The TECookieAuthenticationContext constructor copies a TECookieAuthenticationContext object. |
Public Member Functions
| Member | Description |
|---|---|
~TECookieAuthenticationContext() | The TECookieAuthenticationContext destructor is the class destructor. |
void setCookie(const _TESTD string &cookie, bool decode=true) | The setCookie method sets a Token. |
te_oid authenticate() | The authenticate method performs authentication. |
TEObject * clone() const | The clone method clones the TEUserAuthenticationContext object. |
Static Public Member Functions
| Member | Description |
|---|---|
_TESTD auto_ptr< TECookieAuthenticationContext > getInstance() | The getInstance method creates a new TEUserAuthenticationContext object. |
Member Function Documentation
TECookieAuthenticationContext()
The TECookieAuthenticationContext constructor is the default class constructor.
TECookieAuthenticationContext(const TECookieAuthenticationContext &)
The TECookieAuthenticationContext constructor copies a TECookieAuthenticationContext object.
~TECookieAuthenticationContext()
The TECookieAuthenticationContext destructor is the class destructor.
void setCookie(const _TESTD string &cookie, bool decode=true)
The setCookie method sets a Token.
Parameters
| Parameter | Description |
|---|---|
cookie | A string representing a Token. |
decode | A boolean true means the Token needs Base64 Decode. |
te_oid authenticate()
The authenticate method performs authentication.
Returns: A long integer representing the principal ID of authenticated principal.
TEObject * clone() const
The clone method clones the TEUserAuthenticationContext object.
Returns: Returns a cloned TEUserAuthenticationContext object.
_TESTD auto_ptr< TECookieAuthenticationContext > getInstance()
The getInstance method creates a new TEUserAuthenticationContext object.
Returns: Returns a smart pointer to a TEUserAuthenticationContext object.