This connector provides methods for the server admin console /summary> More...

Static Public Member Functions
static bool	LoginServerAdmin (string AUserID="SYSADMIN")
	login the server admin console without a password More...

static int	GetClientsConnectedTotal ()
	get the number of clients that have connected to this server since the last restart More...

static int	GetClientsConnected ()
	get number of currently connected clients More...

static Int64	GetSiteKey ()
	get the site key More...

static ArrayList	GetClientList ()
	get list of clients More...

static String	GetServerInfoVersion ()
	version of the server More...

static String	GetServerInfoState ()
	state of the server More...

static System.Int64	GetServerInfoMemory ()
	how much memory is used by the server More...

static bool	StopServerControlled (bool AForceAutomaticClosing)
	command to stop the server in a more controlled way than StopServer (gets all connected clients to disconnect) More...

static void	StopServer ()
	command to stop the server unconditionally (forces 'hard' disconnection of all Clients!) More...

static System.Int64	PerformGC ()
	perform garbage collection on the server More...

static String	FormatClientList (Boolean AListDisconnectedClients)
	get a formatted list of clients More...

static String	FormatClientListSysadm (Boolean AListDisconnectedClients)
	get a formatted list for sysadm (also useful for webmin???) More...

static bool	QueueClientTask (System.Int16 AClientID, String ATaskGroup, String ATaskCode, object ATaskParameter1, object ATaskParameter2, object ATaskParameter3, object ATaskParameter4, System.Int16 ATaskPriority)
	put a task into a queue on the server More...

static bool	DisconnectClient (System.Int16 AClientID, out String ACantDisconnectReason)
	disconnect a client More...

static bool	UpgradeDatabase ()
	upgrades the database More...

static string	BackupDatabaseToYmlGZ ()
	returns a string with yml.gz data More...

static bool	RestoreDatabaseFromYmlGZ (string AYmlGzData)
	restore the database from a string with yml.gz data More...

static void	RefreshAllCachedTables ()
	Marks all DataTables in the Cache to be no longer up-to-date (=out of sync with the data that was originally placed in the DataTable). More...

static int	ClearConnectionPoolAndGetNumberOfDBConnections ()
	Clears (flushes) all RDMBS Connection Pools and returns the new number of DB Connections after clearing all RDMBS Connection Pools. More...

static bool	SetPassword (string AUserID, string APassword)
	set the password of a user More...

static bool	LockSysadmin ()
	lock the sysadmin user. creating an instance that is not intended for use yet. More...

static bool	AddUser (string AUserID)
	add a new user More...

static bool	AddUser (string AUserID, string APassword="")
	add a new user More...

static void	PerformTimedProcessingNow (string AProcessName)
	Allows the admin console to run a timed job now. More...

Detailed Description

This connector provides methods for the server admin console /summary>

Member Function Documentation

◆ AddUser() [1/2]

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.AddUser ( string AUserID )

inlinestatic

add a new user

Returns

◆ AddUser() [2/2]

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.AddUser	(	string	AUserID,
		string	APassword = `""`
	)

inlinestatic

add a new user

Returns

◆ BackupDatabaseToYmlGZ()

static string Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.BackupDatabaseToYmlGZ ( )

inlinestatic

returns a string with yml.gz data

Returns

◆ ClearConnectionPoolAndGetNumberOfDBConnections()

static int Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.ClearConnectionPoolAndGetNumberOfDBConnections ( )

inlinestatic

Clears (flushes) all RDMBS Connection Pools and returns the new number of DB Connections after clearing all RDMBS Connection Pools.

◆ DisconnectClient()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.DisconnectClient	(	System.Int16	AClientID,
		out String	ACantDisconnectReason
	)

inlinestatic

disconnect a client

Parameters

AClientID
ACantDisconnectReason

Returns

◆ FormatClientList()

static String Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.FormatClientList ( Boolean AListDisconnectedClients )

inlinestatic

get a formatted list of clients

Parameters

AListDisconnectedClients

Returns

◆ FormatClientListSysadm()

static String Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.FormatClientListSysadm ( Boolean AListDisconnectedClients )

inlinestatic

get a formatted list for sysadm (also useful for webmin???)

Parameters

AListDisconnectedClients

Returns

◆ GetClientList()

static ArrayList Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetClientList ( )

inlinestatic

get list of clients

◆ GetClientsConnected()

static int Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetClientsConnected ( )

inlinestatic

get number of currently connected clients

◆ GetClientsConnectedTotal()

static int Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetClientsConnectedTotal ( )

inlinestatic

get the number of clients that have connected to this server since the last restart

◆ GetServerInfoMemory()

static System.Int64 Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetServerInfoMemory ( )

inlinestatic

how much memory is used by the server

◆ GetServerInfoState()

static String Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetServerInfoState ( )

inlinestatic

state of the server

◆ GetServerInfoVersion()

static String Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetServerInfoVersion ( )

inlinestatic

version of the server

◆ GetSiteKey()

static Int64 Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.GetSiteKey ( )

inlinestatic

get the site key

◆ LockSysadmin()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.LockSysadmin ( )

inlinestatic

lock the sysadmin user. creating an instance that is not intended for use yet.

◆ LoginServerAdmin()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.LoginServerAdmin ( string AUserID = "SYSADMIN" )

inlinestatic

login the server admin console without a password

◆ PerformGC()

static System.Int64 Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.PerformGC ( )

inlinestatic

perform garbage collection on the server

Returns

◆ PerformTimedProcessingNow()

static void Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.PerformTimedProcessingNow ( string AProcessName )

inlinestatic

Allows the admin console to run a timed job now.

◆ QueueClientTask()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.QueueClientTask	(	System.Int16	AClientID,
		String	ATaskGroup,
		String	ATaskCode,
		object	ATaskParameter1,
		object	ATaskParameter2,
		object	ATaskParameter3,
		object	ATaskParameter4,
		System.Int16	ATaskPriority
	)

inlinestatic

put a task into a queue on the server

Parameters

AClientID
ATaskGroup
ATaskCode
ATaskPriority
ATaskParameter1	Parameter #1 for the Task (depending on the TaskGroup this can be left empty)
ATaskParameter2	Parameter #2 for the Task (depending on the TaskGroup this can be left empty)
ATaskParameter3	Parameter #3 for the Task (depending on the TaskGroup this can be left empty)
ATaskParameter4	Parameter #4 for the Task (depending on the TaskGroup this can be left empty)

Returns

◆ RefreshAllCachedTables()

static void Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.RefreshAllCachedTables ( )

inlinestatic

Marks all DataTables in the Cache to be no longer up-to-date (=out of sync with the data that was originally placed in the DataTable).

◆ RestoreDatabaseFromYmlGZ()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.RestoreDatabaseFromYmlGZ ( string AYmlGzData )

inlinestatic

restore the database from a string with yml.gz data

Returns

◆ SetPassword()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.SetPassword	(	string	AUserID,
		string	APassword
	)

inlinestatic

set the password of a user

◆ StopServer()

static void Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.StopServer ( )

inlinestatic

command to stop the server unconditionally (forces 'hard' disconnection of all Clients!)

◆ StopServerControlled()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.StopServerControlled ( bool AForceAutomaticClosing )

inlinestatic

command to stop the server in a more controlled way than StopServer (gets all connected clients to disconnect)

◆ UpgradeDatabase()

static bool Ict.Petra.Server.App.Core.ServerAdmin.WebConnectors.TServerAdminWebConnector.UpgradeDatabase ( )

inlinestatic

upgrades the database

Returns: true if there has been an update

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

csharp/ICT/Petra/Server/app/Core/ServerAdminWebConnector.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddUser() [1/2]

◆ AddUser() [2/2]

◆ BackupDatabaseToYmlGZ()

◆ ClearConnectionPoolAndGetNumberOfDBConnections()

◆ DisconnectClient()

◆ FormatClientList()

◆ FormatClientListSysadm()

◆ GetClientList()

◆ GetClientsConnected()

◆ GetClientsConnectedTotal()

◆ GetServerInfoMemory()

◆ GetServerInfoState()

◆ GetServerInfoVersion()

◆ GetSiteKey()

◆ LockSysadmin()

◆ LoginServerAdmin()

◆ PerformGC()

◆ PerformTimedProcessingNow()

◆ QueueClientTask()

◆ RefreshAllCachedTables()

◆ RestoreDatabaseFromYmlGZ()

◆ SetPassword()

◆ StopServer()

◆ StopServerControlled()

◆ UpgradeDatabase()