Inheritance diagram for Ict.Common.Remoting.Shared.IServerAdminInterface:

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

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

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

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

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

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...

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

bool	UpgradeDatabase ()
	upgrade the database More...

string	BackupDatabaseToYmlGZ ()
	Returns a string with yml.gz data. More...

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

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...

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

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

bool	LockSysadmin ()
	lock the user SYSADMIN for unassigned instance More...

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

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

Properties
Int64	SiteKey `[get]`
	SiteKey of the OpenPetra DB that the Server is connected to. More...

int	ClientsConnectedTotal `[get]`
	get number of connected clients including disconnected clients More...

int	ClientsConnected `[get]`
	get number of currently connected clients More...

ArrayList	ClientList `[get]`
	get list of clients More...

int	IPPort `[get]`
	the port the server is running on More...

String	ConfigurationFileName `[get]`
	Name of the Server configuration file More...

String	ServerInfoVersion `[get]`
	version of the server More...

String	ServerInfoState `[get]`
	state of the server More...

System.Int64	ServerInfoMemory `[get]`
	how much memory is used by the server More...

Detailed Description

<comment>IServerAdminInterface is the main interface for Server Admin applications (like PetraServerAdminConsole.exe). Its purpose is to allow execution of certain Server functions, including disconnecting Clients and Server shutdown. </comment>

Comment Clients don't use this interface!

Member Function Documentation

◆ AddUser()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.AddUser	(	string	AUserID,
		string	APassword = `""`
	)

add a new user

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ BackupDatabaseToYmlGZ()

string Ict.Common.Remoting.Shared.IServerAdminInterface.BackupDatabaseToYmlGZ ( )

Returns a string with yml.gz data.

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ ClearConnectionPoolAndGetNumberOfDBConnections()

int Ict.Common.Remoting.Shared.IServerAdminInterface.ClearConnectionPoolAndGetNumberOfDBConnections ( )

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

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ DisconnectClient()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.DisconnectClient	(	System.Int16	AClientID,
		out String	ACantDisconnectReason
	)

disconnect a client

Parameters

AClientID
ACantDisconnectReason

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ FormatClientList()

String Ict.Common.Remoting.Shared.IServerAdminInterface.FormatClientList ( Boolean AListDisconnectedClients )

get a formatted list of clients

Parameters

AListDisconnectedClients

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ FormatClientListSysadm()

String Ict.Common.Remoting.Shared.IServerAdminInterface.FormatClientListSysadm ( Boolean AListDisconnectedClients )

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

Parameters

AListDisconnectedClients

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ LockSysadmin()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.LockSysadmin ( )

lock the user SYSADMIN for unassigned instance

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ PerformGC()

System.Int64 Ict.Common.Remoting.Shared.IServerAdminInterface.PerformGC ( )

perform garbage collection on the server

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ PerformTimedProcessingNow()

void Ict.Common.Remoting.Shared.IServerAdminInterface.PerformTimedProcessingNow ( string AProcessName )

Allows the server or admin console to run a timed job now.

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ QueueClientTask()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.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

Parameters

AClientID
ATaskGroup
ATaskCode
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)
ATaskPriority

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ RefreshAllCachedTables()

void Ict.Common.Remoting.Shared.IServerAdminInterface.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).

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ RestoreDatabaseFromYmlGZ()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.RestoreDatabaseFromYmlGZ ( string AYmlGzData )

Restore the database from a string with yml.gz data.

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ SetPassword()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.SetPassword	(	string	AUserID,
		string	APassword
	)

set the password of a user

Returns

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

◆ StopServer()

void Ict.Common.Remoting.Shared.IServerAdminInterface.StopServer ( )

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

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ StopServerControlled()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.StopServerControlled ( bool AForceAutomaticClosing )

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

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ UpgradeDatabase()

bool Ict.Common.Remoting.Shared.IServerAdminInterface.UpgradeDatabase ( )

upgrade the database

Returns: true if the database was upgraded

Implemented in Ict.Common.Remoting.Server.TServerManagerBase, and Ict.Petra.Server.App.Core.TServerManager.

Property Documentation

◆ ClientList

ArrayList Ict.Common.Remoting.Shared.IServerAdminInterface.ClientList

get

get list of clients

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ClientsConnected

int Ict.Common.Remoting.Shared.IServerAdminInterface.ClientsConnected

get

get number of currently connected clients

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ClientsConnectedTotal

int Ict.Common.Remoting.Shared.IServerAdminInterface.ClientsConnectedTotal

get

get number of connected clients including disconnected clients

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ConfigurationFileName

String Ict.Common.Remoting.Shared.IServerAdminInterface.ConfigurationFileName

get

Name of the Server configuration file

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ IPPort

int Ict.Common.Remoting.Shared.IServerAdminInterface.IPPort

get

the port the server is running on

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ServerInfoMemory

System.Int64 Ict.Common.Remoting.Shared.IServerAdminInterface.ServerInfoMemory

get

how much memory is used by the server

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ServerInfoState

String Ict.Common.Remoting.Shared.IServerAdminInterface.ServerInfoState

get

state of the server

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ ServerInfoVersion

String Ict.Common.Remoting.Shared.IServerAdminInterface.ServerInfoVersion

get

version of the server

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

◆ SiteKey

Int64 Ict.Common.Remoting.Shared.IServerAdminInterface.SiteKey

get

SiteKey of the OpenPetra DB that the Server is connected to.

Implemented in Ict.Common.Remoting.Server.TServerManagerBase.

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

csharp/ICT/Common/Remoting/Shared/ServerAdminInterface.cs

Public Member Functions

Properties

Detailed Description

Member Function Documentation

◆ AddUser()

◆ BackupDatabaseToYmlGZ()

◆ ClearConnectionPoolAndGetNumberOfDBConnections()

◆ DisconnectClient()

◆ FormatClientList()

◆ FormatClientListSysadm()

◆ LockSysadmin()

◆ PerformGC()

◆ PerformTimedProcessingNow()

◆ QueueClientTask()

◆ RefreshAllCachedTables()

◆ RestoreDatabaseFromYmlGZ()

◆ SetPassword()

◆ StopServer()

◆ StopServerControlled()

◆ UpgradeDatabase()

Property Documentation

◆ ClientList

◆ ClientsConnected

◆ ClientsConnectedTotal

◆ ConfigurationFileName

◆ IPPort

◆ ServerInfoMemory

◆ ServerInfoState

◆ ServerInfoVersion

◆ SiteKey