ECP Class Reference

Enterprise Cache Protocol Notes:
More...

Static Public Member Functions
_.Library.Status	AddAuthorizedCN (_.Library.String SSLComputerName)
	Add an entry to the ECP SSL authorized list. More...
_.Library.Boolean	ChangeToNotConnected (_.Library.String ConnectionName)
	Changes an ECP connection state to not connected. More...
	DisplayDatabases ()
	Display the list of database remote databases this client has "mounted".
_.Library.Integer	GetClientConnState (_.Library.String ConnectionName)
	Returns the state of an ECP Client Connection. More...
_.Library.Integer	GetRemoteDBMountStatus (_.Library.String ServerName, _.Library.String Directory)
	Given the data server connection name and the remote directory name on this client, returns the mount status codes of the remote database. More...
_.Library.Integer	GetServerConnState (_.Library.String ConnectionName)
	Returns the state of an ECP Server Connection. More...
_.Library.Status	RemoveAuthorizedCN (_.Library.String SSLComputerName)
	Remove an entry from the ECP SSL authorized list. More...
_.Library.Status	RemoveFromPendingList (_.Library.String SSLComputerName, _.Library.Integer Authorize)
	Remove an entry from the ECP SSL pending list. More...
_.Library.Status	ServerAction (_.Library.String ConnectionName, _.Library.Integer Action, _.Library.Boolean Wait)
	Performs Action on an ECP Server Connection. More...

Static Public Attributes
	DOMAIN = None
	Default Localization Domain.

Detailed Description

Enterprise Cache Protocol Notes:

• A Server Connection is a connection from this system as a client to a remote server.
• A Client Connection is a connection from a remote client to this system as a server.

Member Function Documentation

AddAuthorizedCN()

_.Library.Status AddAuthorizedCN ( _.Library.String  SSLComputerName )

static

Add an entry to the ECP SSL authorized list.

When users want to pre-authorize a remote ECP client connection, they can use this method to add the remote connection the to authorized list, so when it connects to this data server, it does not need to be authorized.

Input Parameters:

• <parameter>SSLComputerName</parameter> is the Distinguished Name of the certificate on remote client side.
  

This method always returned 'OK' even if the specified <parameter>SSLComputerName</parameter> does not exist.

ChangeToNotConnected()

_.Library.Boolean ChangeToNotConnected ( _.Library.String  ConnectionName )

static

Changes an ECP connection state to not connected.

Connection name is as specified in the network panel. Returns zero if the connection name is invalid

GetClientConnState()

_.Library.Integer GetClientConnState ( _.Library.String  ConnectionName )

static

Returns the state of an ECP Client Connection.

Connection name is as specified in the network panel.
Return value:
-1 - Invalid connection name 0 - Free 1 - Normal 2 - Trouble 3 - Recovering 4 - Restart

GetRemoteDBMountStatus()

_.Library.Integer GetRemoteDBMountStatus ( _.Library.String  ServerName, _.Library.String  Directory  )

static

Given the data server connection name and the remote directory name on this client, returns the mount status codes of the remote database.

The Status Codes are:
0 - Remote database has not been mounted yet.
1 - Remote database is dismounted.
2 - Remote database is mounted read-only.
3 - Remote database is mounted read-write.

GetServerConnState()

_.Library.Integer GetServerConnState ( _.Library.String  ConnectionName )

static

Returns the state of an ECP Server Connection.

Connection name is as specified in the network panel.
Return value:
-2 - Invalid connection name -1 - Invalid 0 - Initializing 1 - Not Connected 2 - Connection in Progress 3 - Connection Failed 4 - Disabled 5 - Normal 6 - Trouble 7 - Recovery

RemoveAuthorizedCN()

_.Library.Status RemoveAuthorizedCN ( _.Library.String  SSLComputerName )

static

Remove an entry from the ECP SSL authorized list.

This is called to reject an authorized ECP connection. So the remote client needs to be re-authorized when it re-connects. But this won't affect the currently connected ECP connection.

Input Parameters:

• <parameter>SSLComputerName</parameter> is the Distinguished Name of the certificate on remote client side.
  

This method always returned 'OK' even if the specified <parameter>SSLComputerName</parameter> does not exist.

RemoveFromPendingList()

_.Library.Status RemoveFromPendingList ( _.Library.String  SSLComputerName, _.Library.Integer  Authorize  )

static

Remove an entry from the ECP SSL pending list.

This is called to authorize or reject an incoming ECP connection pending for authorization, and remove the pending connection from the pending list.

Input Parameters:

• <parameter>SSLComputerName</parameter> is the Distinguished Name of the certificate on remote client side.
  

• <parameter>Authorize</parameter> is non-zero to authorize the connection, otherwise the pending connection is rejected.
  

This method always returned 'OK' even if the specified <parameter>SSLComputerName</parameter> does not exist.

ServerAction()

_.Library.Status ServerAction ( _.Library.String  ConnectionName, _.Library.Integer  Action, _.Library.Boolean  Wait  )

static

Performs Action on an ECP Server Connection.

Connection name is as specified in the network panel.
Action:
1 - Change to Not Connected 2 - Change to Disabled 3 - Change to Normal
Wait: 1=wait for answer, 0=do not wait