manager

.

Methods

activateDrainMode

activateDrainMode(pServerIds, pReason): void

Switches the specified servers into drain mode if not allready done. Applies the reason why to each server. If drain mode is activated, the reason why is shown on the client login screen.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId(). Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

pReason

string | number | boolean

Must not be null. Describes the reason why drain mode is activated.

Returns

void

---

clearCache

clearCache(pServerIds): void

Clears the caches for all server.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId(). Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

void

---

extractServerIDs

extractServerIDs(pServerInfos): string[]

Extracts the serverId values from the ServerData Array passed in.

Parameters

pServerInfos

ServerData[]

if null passed in, an empty array is returned.

Returns

string[]

always an String Array, eventually with length 0.

---

getDatabaseInfo

getDatabaseInfo(pDatabaseId): DatabaseConnectionData

Returns a database connection data object for the specified UID.

Each database object represents one database for a specific alias.

Parameters

pDatabaseId

string | number | boolean

the UID of the database.

Returns

DatabaseConnectionData

a DatabaseConnectionData objects representing the requested database, or null if the database does not exit.

Throws

May throw an exception.

---

getDatabaseInfos

getDatabaseInfos(pDatabaseIds?): DatabaseConnectionData[]

Returns a list database connection data objects for the specified UIDs.

Each database object represents one database for a specific alias.

Parameters

pDatabaseIds?

string[]

the UIDs of the databases.

Returns

DatabaseConnectionData[]

a list of DatabaseConnectionData objects.

Throws

May throw an exception.

---

getPeers

getPeers(pServerIds): PeerData[]

Loads the Peers to a given array of server ids.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId(). Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

PeerData[]

An array with Peer Objects, or an array of length zero if no server found.

---

getServerInfos

getServerInfos(pServerIds): ServerData[]

Loads the infos to a given array of server ids.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId(). Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

ServerData[]

An array with ServerData Objects, or an array of length zero if no server found.

---

getServerServiceData

getServerServiceData(serverId): Map<any, any>

Get data of all implemented Services.

Can be accessed by their service names.

Parameters

serverId

string | number | boolean

Server-ID of the wanted services.

Returns

Map<any, any>

Map (String, ServerService) with ServiceName

Example

var services = manager.getServerServiceData();
// Alle Services
logging.log("ANGEMELDETE SERVICES:");
for(var key in services){
logging.log(services[key].getServiceName());
}
//Spezieller Service
logging.log("Status von ServerManager: "+services["ServerManager"].getLastEvent().getState())

---

getServerServiceDataHistory

getServerServiceDataHistory(amountOfEntriesPerService): ServerService[]

Liefert den Verlauf der aktuellen Daten zu allen ServerServices.

Parameters

amountOfEntriesPerService

number

die maximale Anzahl der Einträge pro ServerService

Returns

ServerService[]

---

getServerServiceDataHistorySpan

getServerServiceDataHistorySpan(startOfHistory, endOfHistory): ServerService[]

Liefert den Verlauf der aktuellen Daten zu allen ServerServices.

Parameters

startOfHistory

Date

the Date from which the data is to be returned until the endOfHistory Date

endOfHistory

Date

the Date until which the data is to be returned starting with the startOfHistory Date

Returns

ServerService[]

---

getServerServiceHistory

getServerServiceHistory(serverId, serviceId): Map<any, any>

Liefert die Ereignishistorie für einen Server-Service.

Parameters

serverId

string | number | boolean

Der Server, der den Service nutzt.

serviceId

string | number | boolean

Der gesuchte Service.

Returns

Map<any, any>

Map mit (String: Zeitstempel) -> (Event: Ereignis)

---

getServerStatistics

getServerStatistics(pServerId, pStatConstant): Map<any, any>

Returns statistics about the server identified by the first parameter. The second parameter defines the part of statistical informations in the returned map.

Parameters

pServerId

string | number | boolean

identifies the server. You can retrieve the id via getServerInfos() and then ServerData.getUniqueId(). If null applied, the returned map is empty. Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

pStatConstant

string | number | boolean

one of the STAT_XXX constants, or null for all statistical informations. If the String value can not be resolved, an empty map is returned.

Returns

Map<any, any>

never null, the map can be empty.

---

getUserClientInfos

getUserClientInfos(pSessionIds?): ClientData[]

Loads the infos to a given array of session ids

Parameters

pSessionIds?

string[]

Client Session Ids to load

Returns

ClientData[]

List of Client Infos; List is empty if no corresponding data can be found for the given session ids

---

getVMProperties

getVMProperties(pServerId): Map<any, any>

Returns the Virtual Machine Properties for the specified server identified by parameter.

Use the key VMPROPERTIES_CLASS_PATH to access the servers class path directly

Parameters

pServerId

string | number | boolean

You can retrieve the id via getServerInfos() and then ServerData.getUniqueId(). If null applied, the returned map is empty. Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

Map<any, any>

never null, the map can be empty.

---

restartServerService

restartServerService(pServerId, pServiceId, pUserName): boolean

Stoppt einen Server-Service und startet ihn anschließend neu.

Parameters

pServerId

string | number | boolean

Server ID of the service.

pServiceId

string | number | boolean

UID of the service.

pUserName

string | number | boolean

Calling user

Returns

boolean

true, wenn Neustart erfolgreich war.

---

runGarbageCollection

runGarbageCollection(pServerIds): void

Initiates garbage collection for the specified servers.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId() Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

void

---

sendMessageByClientInfos

sendMessageByClientInfos(pMessage, pUserClientData): boolean

Sends a Message to the given User Clients. If backendType is REMOTE the message will be distributed cluster wide

Parameters

pMessage

string | number | boolean

Message to send

pUserClientData

ClientData[]

User Clients to receive the message; null for all Clients

Returns

boolean

False if an error occurred, True if not

---

sendMessageBySessionIds

sendMessageBySessionIds(pMessage, pClientSessionIds): boolean

Sends a Message to the given User Clients. If backendType is REMOTE the message will be distributed cluster wide

Parameters

pMessage

string | number | boolean

Message to send

pClientSessionIds

string[]

User Clients Session Ids to receive the message; null for all Clients

Returns

boolean

False if an error occurred, True if not

---

shutdownPeers

shutdownPeers(pPeerServerIds): void

Shuts down the connection of the peers given by the parameter

Parameters

pPeerServerIds

string[]

The server ids of the peers to be shutdown; null for all peers

Returns

void

---

shutdownUserClients

shutdownUserClients(pUserClientData): boolean

Logs out the given User Clients If backendType is REMOTE the logout command will be distributed cluster wide

Parameters

pUserClientData

ClientData[]

User Clients to be logged out; null for all Clients

Returns

boolean

False if an error occurred, True if not

---

startServerService

startServerService(pServerId, pServiceId, pUserName): boolean

Startet einen Server-Service. Hinweis: Wird eine neue Konfiguration über die Prefences/Alias angelegt, starten der Server-Service evtl. neu, ausser er wurde in der Konfiguration deaktiviert.

Parameters

pServerId

string | number | boolean

Server ID of the service.

pServiceId

string | number | boolean

UID of the service.

pUserName

string | number | boolean

Calling user

Returns

boolean

true, wenn Start erfolgreich war.

---

stopDrainMode

stopDrainMode(pServerIds): void

Deactivates the drain mode for the specified servers.

Parameters

pServerIds

string[]

An array with server id's, or null for all available servers. You can retrieve the id's via getServerInfos() and then ServerData.getUniqueId(). Please see also method: public String[] extractServerIDs(@Nullable ServerData[] pServerInfos).

Returns

void

---

stopServerService

stopServerService(pServerId, pServiceId, pUserName): boolean

Stoppt einen Server Service.

Parameters

pServerId

string | number | boolean

Server ID of the service.

pServiceId

string | number | boolean

UID of the service.

pUserName

string | number | boolean

Calling user

Returns

boolean

true, wenn Stop erfolgreich war.

Properties

STAT_CPU

string

The key for statistical informations about the CPU usage of this server

---

STAT_DEFAULT

string

The key for statistical informations about the server himself

---

STAT_MEMORY

string

The key for statistical informations about the memory usage of this server

---

STAT_PATH

string

The key for informations about the paths used by this server

---

VMPROPERTIES_CLASS_PATH

string

The key to get a servers class path from the manager.getVMProperties() map