Skip to end of metadata
Go to start of metadata
You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 4
Next »
Unknown macro: {sub-section}
Unknown macro: {table} Unknown macro: {tr} Unknown macro: {th} Return Types
Unknown macro: {table}
{column:width=80px}{column}{column}{column}
Unknown macro: {tr} Unknown macro: {th} Method Summary
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getConnectedClients()
Returns an array of JSClientInformation elements describing the clients connected to the server.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getDataModelClonesFrom(serverName)
Retrieves a list with names of all database servers that have property DataModelCloneFrom equal to the parameter.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getServer(serverName, mustBeEnabled, mustBeValid)
Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getServerNames(mustBeEnabled, mustBeValid, sort, includeDuplicates)
Retrieves a list with the names of all available database servers.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} isInMaintenanceMode()
Returns true if the server is in maintenance mode, false otherwise.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendMessageToClient(clientId, message)
Sends a message to a specific client, identified by its clientId.
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setMaintenanceMode(maintenanceMode)
Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} shutDownClient(clientId)
Shuts down a specific client, identified by its clientId.
Unknown macro: {table}
{column:width=100%}{column}
Unknown macro: {tr} Unknown macro: {th} Method Details
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getConnectedClients
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getConnectedClients
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns an array of JSClientInformation elements describing the clients connected to the server.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var clients = plugins.maintenance.getConnectedClients();
application.output("There are " + clients.length + " connected clients.");
for (var i = 0; i < clients.length; i++)
application.output("Client has clientId '" + clients[i].getClientId() + "' and has connected from host '" + clients[i].getHostAddress() + "'.");
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getDataModelClonesFrom
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} String[]
Unknown macro: {span} getDataModelClonesFrom
Unknown macro: {span} (serverName)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Retrieves a list with names of all database servers that have property DataModelCloneFrom equal to the parameter.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} serverName
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String[]
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var serverNames = plugins.maintenance.getDataModelClonesFrom('my_server');
for (var i=0; i<serverNames.length; i++)
application.output("Process server " + i + ": " + serverNames[i]);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getServer
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} getServer
Unknown macro: {span} (serverName, mustBeEnabled, mustBeValid)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Retrieves an instance of JSServer corresponding to the server with the name specified through the "serverName" argument.
If the optional argument "mustBeEnabled" is set to true, then the JSServer instance is returned only if the server is active.
Similarly, if the "mustBeValid" optional argument is set to true, then the JSServer instance is returned only if the server is valid.
If the specified server is not found, or if it does not meet the requirements imposed by the optional arguments, then null is returned.
By default both optional arguments have the value false.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} serverName
[mustBeEnabled]
[mustBeValid]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var server = plugins.maintenance.getServer("example_data");
if (server) {
var tableNames = server.getTableNames();
application.output("There are " + tableNames.length + " tables.");
for (var i=0; i<tableNames.length; i++)
application.output("Table " + i + ": " + tableNames[i]);
}
else {
plugins.dialogs.showInfoDialog("Attention","Server 'example_data' cannot be found.","OK");
}
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} getServerNames
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} String[]
Unknown macro: {span} getServerNames
Unknown macro: {span} (mustBeEnabled, mustBeValid, sort, includeDuplicates)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Retrieves a list with the names of all available database servers. The returned list will contain only enabled servers if the "mustBeEnabled"
optional argument is set to true. The list will contain only valid servers if the "mustBeValid" argument is set to true. If the "sort" optional
argument is set to true, then the list will be sorted alphabetically. If the "includeDuplicates" optional argument is set to false, then duplicate
servers will appear only once in the list. By default, the "mustBeEnabled" and the "mustBeValid" arguments have the value false, while the "sort"
and "includeDuplicates" arguments have the value true.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} [mustBeEnabled]
[mustBeValid]
[sort]
[includeDuplicates]
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} String[]
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var serverNames = plugins.maintenance.getServerNames();
application.output("There are " + serverNames.length + " servers.");
for (var i=0; i<serverNames.length; i++)
application.output("Server " + i + ": " + serverNames[i]);
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} isInMaintenanceMode
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} isInMaintenanceMode
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Returns true if the server is in maintenance mode, false otherwise.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} Boolean
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
if (plugins.maintenance.isInMaintenanceMode())
application.output("Server is in maintenance mode.");
else
application.output("Server is not in maintenance mode.");
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendMessageToAllClients
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} sendMessageToAllClients
Unknown macro: {span} (message)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Sends a message to all connected clients.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} message
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
plugins.maintenance.sendMessageToAllClients("Hello, all clients!");
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} sendMessageToClient
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} sendMessageToClient
Unknown macro: {span} (clientId, message)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Sends a message to a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} clientId
message
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var clients = plugins.maintenance.getConnectedClients();
for (var i=0; i<clients.length; i++)
plugins.maintenance.sendMessageToClient(clients[i].getClientId(), "Hello, client " + clients[i].getClientId() + "!");
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} setMaintenanceMode
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} setMaintenanceMode
Unknown macro: {span} (maintenanceMode)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Puts the server into/out of maintenance mode, depending on the boolean parameter that is specified (if the parameter is true, then the server will be put into maintenance mode; if the parameter is false, then the server will be put out of maintenance mode).
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} maintenanceMode
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
plugins.maintenance.setMaintenanceMode(!plugins.maintenance.isInMaintenanceMode());
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} shutDownAllClients
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} shutDownAllClients
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Shuts down all connected clients.
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
plugins.maintenance.shutDownAllClients();
Unknown macro: {tr} Unknown macro: {td}
Unknown macro: {tbody} Unknown macro: {tr} Unknown macro: {td} shutDownClient
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {span} void
Unknown macro: {span} shutDownClient
Unknown macro: {span} (clientId)
Unknown macro: {tr} Unknown macro: {td} Unknown macro: {sub-section}
Unknown macro: {sub-section} Shuts down a specific client, identified by its clientId. The clientIds are retrieved by calling the getConnectedClients method.
Unknown macro: {tr} Unknown macro: {td} Parameters
Unknown macro: {sub-section}
Unknown macro: {div} Unknown macro: {sub-section} clientId
Unknown macro: {tr} Unknown macro: {td} Returns
Unknown macro: {sub-section}
Unknown macro: {sub-section} void
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} Also see
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {builder-show} Unknown macro: {tr} Unknown macro: {td} External links
Unknown macro: {sub-section}
Unknown macro: {sub-section}
Unknown macro: {tr} Unknown macro: {td} Sample
Unknown macro: {sub-section}
Unknown macro: {sub-section}
var clients = plugins.maintenance.getConnectedClients();
for (var i=0; i<clients.length; i++)
plugins.maintenance.shutDownClient(clients[i].getClientId());
Unknown macro: {tr} Unknown macro: {td}