OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Server.App.Core.Security.TLoginLog Class Reference

Saves entries in the Login Log table. More...

Inheritance diagram for Ict.Petra.Server.App.Core.Security.TLoginLog:
Ict.Common.Remoting.Server.ILoginLog

Public Member Functions

void RecordUserLogout (String AUserID, int AProcessID, TDBTransaction ATransaction)
 Records the logging-out (=disconnection) of a Client to the s_login DB Table. That DB Table contains a log of all the log-ins/log-in attempts to the system, and of log-outs from the system. More...
 

Static Public Member Functions

static void AddLoginLogEntry (String AUserID, String ALoginType, String ALoginDetails, out Int32 AProcessID, TDBTransaction ATransaction)
 Adds a record to the s_login DB Table. That DB Table contains a log of all the log-ins/log-in attempts to the system, and of log-outs from the system. More...
 

Static Public Attributes

const string LOGIN_STATUS_TYPE_LOGOUT = "LOGOUT"
 User logout. More...
 

Detailed Description

Saves entries in the Login Log table.

Member Function Documentation

◆ AddLoginLogEntry()

static void Ict.Petra.Server.App.Core.Security.TLoginLog.AddLoginLogEntry ( String  AUserID,
String  ALoginType,
String  ALoginDetails,
out Int32  AProcessID,
TDBTransaction  ATransaction 
)
inlinestatic

Adds a record to the s_login DB Table. That DB Table contains a log of all the log-ins/log-in attempts to the system, and of log-outs from the system.

Parameters
AUserIDUserID of the User for which a record should be written.
ALoginTypeType of the login/logout record. This is a hard-coded constant value (there's no 'lookup table' for it); for available values and their meaning please check program code (Ict.Petra.Server.MSysMan.Security.TLoginLog Class).
ALoginDetailsDetails/description of the login/login attempt/logout
AProcessID'Process ID'; this is a unique key and comes from a sequence (seq_login_process_id).
ATransactionInstantiated DB Transaction.

◆ RecordUserLogout()

void Ict.Petra.Server.App.Core.Security.TLoginLog.RecordUserLogout ( String  AUserID,
int  AProcessID,
TDBTransaction  ATransaction 
)
inline

Records the logging-out (=disconnection) of a Client to the s_login DB Table. That DB Table contains a log of all the log-ins/log-in attempts to the system, and of log-outs from the system.

Parameters
AUserIDUserID of the User for which a logout should be recorded.
AProcessIDProcessID of the User for which a logout should be recorded. This will need to be the number that got returned from an earlier call to AddLoginLogEntry(string, string, string, out int, TDBTransaction)!
ATransactionEither an instantiated DB Transaction, or null. In the latter case a separate DB Connection gets opened, a DB Transaction on that separate DB Connection gets started, then committed/rolled back and the separate DB Connection gets closed. This is needed when this Method gets called from Method 'Ict.Common.Remoting.Server.TDisconnectClientThread.StartClientDisconnection()'!

Implements Ict.Common.Remoting.Server.ILoginLog.

Member Data Documentation

◆ LOGIN_STATUS_TYPE_LOGOUT

const string Ict.Petra.Server.App.Core.Security.TLoginLog.LOGIN_STATUS_TYPE_LOGOUT = "LOGOUT"
static

User logout.


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