Servers Class Reference

Superservers defined for the system. More...

Inheritance diagram for Servers:

Collaboration diagram for Servers:

Static Public Member Functions
_.Library.Status	Create (_.Library.Integer Port, _.Library.String BindAddress, _.Library.String Properties)
	Create a superserver. More...
_.Library.Status	Delete (_.Library.String Port, _.Library.String BindAddress)
	Delete a Server. More...
_.Library.Boolean	Exists (_.Library.String Port, _.Library.String BindAddress, _.Library.ObjectHandle Server, _.Library.Status Status)
	Server exists. More...
_.Library.Status	Export (_.Library.String FileName, _.Library.Integer NumExported, _.Library.String Ports, _.Library.String BindAddresses)
	This method exports Server records to a file in xml format. More...
_.Library.Status	Get (_.Library.String Port, _.Library.String BindAddress, _.Library.String Properties)
	Get a Server's properties. More...
_.Library.Status	Import (_.Library.String FileName, _.Library.Integer NumImported, _.Library.Integer Flags)
	Import Server records from an xml file. More...
_.Library.Status	Modify (_.Library.Integer Port, _.Library.String BindAddress, _.Library.String Properties)
	Modify a Server's properties. More...

Public Attributes
	BindAddress
	More...
	Description
	Description `of the Server. More...
	EnableCSP
	More...
	EnableCacheDirect
	More...
	EnableClients
	More...
	EnableDataCheck
	More...
	EnableECP
	More...
	EnableMirror
	More...
	EnableNodeJS
	More...
	EnableSNMP
	More...
	EnableShadows
	More...
	EnableSharding
	More...
	EnableWebLink
	More...
	Enabled
	Server enabled. More...
	Port
	More...
	SSLConfig
	SSL configuration used for client connections. More...
	SSLSupportLevel
	Use SSL/TLS for Client connections. More...
	SystemDefault
	More...

Private Attributes
	__DoNotStart
	Used only by Initialize() More...

Detailed Description

Superservers defined for the system.

The table for this class should be manipulated only through object access, the published API's or through the System Management Portal. It should not be updated through direct SQL access.

Member Function Documentation

Create()

_.Library.Status Create ( _.Library.Integer  Port, _.Library.String  BindAddress, _.Library.String  Properties  )

static

Create a superserver.

Port - Port of the Server to modify.
BindAddress - BindAddress of the Server to modify.

Delete()

_.Library.Status Delete ( _.Library.String  Port, _.Library.String  BindAddress  )

static

Delete a Server.

This method will delete an Server from the security database.
Parameters:
Port - Port of the Server to delete.
BindAddress - BindAddress of the Server to delete.

Exists()

_.Library.Boolean Exists ( _.Library.String  Port, _.Library.String  BindAddress, _.Library.ObjectHandle  Server, _.Library.Status  Status  )

static

Server exists.

This method checks for the existence of a Server in the security database.
Parameters:
Port - Port of the Server.
BindAddress - BindAddress of the Server.
Return values:
If Value of the method = 0 (Server does not exist, or some error occured)
Server = Null
Status = Server "x" does not exist, or other error message<br>
If Value of the method = 1 (Server exists)
Server = Object handle to Server
Status = $$$OK

Export()

_.Library.Status Export ( _.Library.String  FileName, _.Library.Integer  NumExported, _.Library.String  Ports, _.Library.String  BindAddresses  )

static

This method exports Server records to a file in xml format.

Parameters:
Filename - Output file name
NumExported (byref) - Returns number of records exported.
Servers - Comma separated list of Servers to export, "*" = All

Get()

_.Library.Status Get ( _.Library.String  Port, _.Library.String  BindAddress, _.Library.String  Properties  )

static

Get a Server's properties.

Gets a Server's properties from the security database.
Parameters:
Port - Port of the Server.
BindAddress - BindAddress of the Server.
Return values:
Properties - Array of properties

Import()

_.Library.Status Import ( _.Library.String  FileName, _.Library.Integer  NumImported, _.Library.Integer  Flags  )

static

Import Server records from an xml file.

Parameters:
FileName - Filename to import Server records from
NumImported (byref) - Returns number of records imported
Flags - Control import
Bit 0 - Do not import records, just return count
Note: On failure, no records will be imported

Modify()

_.Library.Status Modify ( _.Library.Integer  Port, _.Library.String  BindAddress, _.Library.String  Properties  )

static

Modify a Server's properties.

Modifies a Server's properties from the security database.
Parameters:
Port - Port of the Server.
BindAddress - BindAddress of the Server.
Properties - Array of properties to modify.
See the Get() method for a description of the Properties parameter.
If a specific property is not passed in the properties array, the value is not modified. Note that some system defined properties are not changeable.

Member Data Documentation

BindAddress

BindAddress

 

 

Description

Description

Description `of the Server.

 

__DoNotStart

__DoNotStart

private

Used only by Initialize()

 

EnableCSP

EnableCSP

 

 

EnableCacheDirect

EnableCacheDirect

 

 

EnableClients

EnableClients

 

 

EnableDataCheck

EnableDataCheck

 

 

EnableECP

EnableECP

 

 

EnableMirror

EnableMirror

 

 

EnableNodeJS

EnableNodeJS

 

 

EnableSNMP

EnableSNMP

 

 

EnableShadows

EnableShadows

 

 

EnableSharding

EnableSharding

 

 

EnableWebLink

EnableWebLink

 

 

Enabled

Enabled

Server enabled.

 

Port

Port

 

 

SSLConfig

SSLConfig

SSL configuration used for client connections.

 

SSLSupportLevel

SSLSupportLevel

Use SSL/TLS for Client connections.

0 = None
1 = Accept
2 = Require
 

SystemDefault

SystemDefault