PISOFT::TEXAuthPrincipalInfo
#include <texauthprincipal.h>
The TEXAuthPrincipalInfo class represents an Externally Authenticated (XAuth) principal: one authenticated by a system outside the Key Service and mapped into it as a DELEGATION TARGET.
An XAuth principal is a principal in every respect but one: it has its own table, can be a group member and can hold roles – and it CANNOT authenticate. It exists to be impersonated, through TEDelegatedAuthenticationContext::setXAuthTarget(getID()), by a certificate principal carrying the DELEGATION flag, through the Key Service's AM04 module. It is created, found (TEAdmin::getPrincipalByName, by id), listed (TEAdmin::PRINCIPAL_XAUTH, TEAdminQuery with the class name "XAuthPrincipalInfo") and updated through TEAdmin like any other principal. The TEXAuthPrincipalInfo class is derived from the TEPrincipalInfo class.
© Pi Soft, 2018-2026 · Tricryption Engine 8.1
Inheritance
- Inherits PISOFT::TEPrincipalInfo
Static Public Attributes
| Type | Name | Description |
|---|---|---|
| _TESTD string | CLASSNAME |
Public Member Functions
| Member | Description |
|---|---|
TEXAuthPrincipalInfo() | The TEXAuthPrincipalInfo constructor is the default class constructor. |
TEXAuthPrincipalInfo(const TEXAuthPrincipalInfo &) | The TEXAuthPrincipalInfo constructor copies a TEXAuthPrincipalInfo object. |
TEXAuthPrincipalInfo & operator=(const TEXAuthPrincipalInfo &) | The = operator assigns a deep copy of the source's implementation object to this object (self-assignment safe; the previous implementation object is freed). |
~TEXAuthPrincipalInfo() | The TEXAuthPrincipalInfo destructor is the class destructor. |
const _TESTD string getPrincipalName() const | The getPrincipalName method gets the principal name, which for an XAuth principal is its id. |
void setID(const _TESTD string &id) | The setID method sets the external identity this principal maps – the value TEDelegatedAuthenticationContext::setXAuthTarget names it by. Marshalled as "id". |
const _TESTD string getID() const | The getID method retrieves the external identity this principal maps. |
void setMetaInfo(const _TESTD string &info) | The setMetaInfo method sets the free-form metadata carried beside the id. Marshalled as "metainfo". |
const _TESTD string getMetaInfo() const | The getMetaInfo method retrieves the free-form metadata carried beside the id. |
const _TESTD string getClassName() const | The getClassName method gets a TEXAuthPrincipalInfo object's class name. |
TEObject * clone() const | The clone method clones a TEXAuthPrincipalInfo object. |
Member Function Documentation
TEXAuthPrincipalInfo()
The TEXAuthPrincipalInfo constructor is the default class constructor.
TEXAuthPrincipalInfo(const TEXAuthPrincipalInfo &)
The TEXAuthPrincipalInfo constructor copies a TEXAuthPrincipalInfo object.
TEXAuthPrincipalInfo & operator=(const TEXAuthPrincipalInfo &)
The = operator assigns a deep copy of the source's implementation object to this object (self-assignment safe; the previous implementation object is freed).
~TEXAuthPrincipalInfo()
The TEXAuthPrincipalInfo destructor is the class destructor.
const _TESTD string getPrincipalName() const
The getPrincipalName method gets the principal name, which for an XAuth principal is its id.
Returns: Returns a string representing the principal name.
void setID(const _TESTD string &id)
The setID method sets the external identity this principal maps – the value TEDelegatedAuthenticationContext::setXAuthTarget names it by. Marshalled as "id".
Parameters
| Parameter | Description |
|---|---|
id | A string representing the external identity. |
const _TESTD string getID() const
The getID method retrieves the external identity this principal maps.
Returns: Returns a string representing the external identity.
void setMetaInfo(const _TESTD string &info)
The setMetaInfo method sets the free-form metadata carried beside the id. Marshalled as "metainfo".
Parameters
| Parameter | Description |
|---|---|
info | A string carrying the metadata. |
const _TESTD string getMetaInfo() const
The getMetaInfo method retrieves the free-form metadata carried beside the id.
Returns: Returns a string carrying the metadata.
const _TESTD string getClassName() const
The getClassName method gets a TEXAuthPrincipalInfo object's class name.
Returns: Returns a string representing the class name of a TEXAuthPrincipalInfo object.
TEObject * clone() const
The clone method clones a TEXAuthPrincipalInfo object.
Returns: Returns a cloned TEXAuthPrincipalInfo object.