%External.Server

Method Inventory

Methods

classmethod createServer(serverDef As %DynamicObject) as %DynamicObject [ Language = objectscript ]
Create a new server. This function requires the "%Admin_Manage" resource.
classmethod deleteServer(serverName As %String) as %DynamicObject [ Language = objectscript ]
Delete an existing server. This function requires the "%Admin_Manage" resource.
classmethod getActivity(serverName As %String, entryCount As %Integer = 10, verbose As %Boolean = 0) as %Library.DynamicArray [ Language = objectscript ]
Return a dynamic array containing the specified number of ActivityLog entries for the specified External Language Server. If verbose is true then those rows will also be displayed on the current device.
classmethod getServer(serverName As %RawString) as %Library.DynamicObject [ Language = objectscript ]
Return a dynamic object containing the configuraton for the specified External Language Server
classmethod getServerLanguageVersion(serverName As %RawString) as %String [ Language = objectscript ]
Return the configured external language version string for an External Language Server configuration. This function does not establish a connection to the external language server in most cases. It simply returns the language version from the configuration. This function may execute an external command but it does not start the external language server.
classmethod getServers() as %Library.DynamicArray [ Language = objectscript ]
Return a %DynamicArray containing the names of all defined External Language Servers
classmethod isServerRunning(arg As %RawString) as %Boolean [ Language = objectscript ]
Return true if the requested server is running, false otherwise.
classmethod modifyServer(serverDef As %DynamicObject) as %DynamicObject [ Language = objectscript ]
Modify an existing server. This function requires the "%Admin_Manage" resource.
classmethod serverExists(serverName As %RawString) as %Boolean [ Language = objectscript ]
return 1 if the server exists, 0 otherwise
classmethod startServer(serverName As %String) as %Boolean [ Language = objectscript ]
Start the External Language Server
classmethod stopServer(serverName As %String, verbose As %Boolean = 0) as %Boolean [ Language = objectscript ]
Stop the External Language Server

Subclasses

Feedback