Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgServer

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgStructure
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgServer
All Implemented Interfaces:
ICfgBase, ICfgStructure

public class CfgServer
extends CfgStructure

A server.

When an application is designated as a backup server for another server, values of the following parameters of this application will be automatically changed to match the values of the same parameters of the primary server:

As long as this application is associated with the primary server, these parameters will be treated as read-only, and their values will be changed only when changes are applied to the corresponding parameters of the primary server.


Constructor Summary
CfgServer(IConfService confService, ConfStructure objData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
CfgServer(IConfService confService, ICfgObject parent)
          This constructor is intended for creation of detached objects.
CfgServer(IConfService confService, org.w3c.dom.Node xmlData, ICfgObject parent)
          This constructor is intended for creation of structures from external or imported XML data.
 
Method Summary
 java.lang.Integer getAttempts()
          Number of attempts to connect to this server before trying to connect to the backup server.
 CfgApplication getBackupServer()
          An identifier of the Server which is to be contacted if connection to this server fails.
 java.lang.Integer getBackupServerDBID()
          Retrieves the dbid of the object that is being linked to by the BackupServer property.
 CfgHost getHost()
          A unique identifier of the CfgHost where this server resides.
 java.lang.Integer getHostDBID()
          Retrieves the dbid of the object that is being linked to by the Host property.
 java.lang.String getPort()
          A pointer to the name of the port which client applications should use to open communication sessions to this server.
 java.lang.Integer getTimeout()
          Time-out in seconds that the application should run before making a re-connect attempt after a communication session with this server has failed.
 void setAttempts(java.lang.Integer value)
          Number of attempts to connect to this server before trying to connect to the backup server.
 void setBackupServer(CfgApplication value)
          An identifier of the Server which is to be contacted if connection to this server fails.
 void setBackupServerDBID(int dbid)
          An identifier of the Server which is to be contacted if connection to this server fails.
 void setHost(CfgHost value)
          A unique identifier of the CfgHost where this server resides.
 void setHostDBID(int dbid)
          A unique identifier of the CfgHost where this server resides.
 void setPort(java.lang.String value)
          A pointer to the name of the port which client applications should use to open communication sessions to this server.
 void setTimeout(java.lang.Integer value)
          Time-out in seconds that the application should run before making a re-connect attempt after a communication session with this server has failed.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgStructure
getParent, updateChildrenSavedState
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
clone, ensureDataBackup, equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, reloadObjectWithNewData, resolveLink, setProperty, toString, toStringProperties, toXml
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase
getEndpoint, getProperty, getRawObjectData, setProperty, toXml
 

Constructor Detail

CfgServer

public CfgServer(IConfService confService,
                 ConfStructure objData,
                 ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol structure data
parent - instance of configuration object as a parent for this structure instance

CfgServer

public CfgServer(IConfService confService,
                 org.w3c.dom.Node xmlData,
                 ICfgObject parent)
This constructor is intended for creation of structures from external or imported XML data. It is internally used by COM AB for objects and structures deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing structure data
parent - instance of configuration object as a parent for this structure instance

CfgServer

public CfgServer(IConfService confService,
                 ICfgObject parent)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
parent - instance of configuration object as a parent for this structure instance
Method Detail

getHost

public final CfgHost getHost()
A unique identifier of the CfgHost where this server resides. Cannot be changed as long as the server is associated with at least one client application or a primary server.

Returns:
instance of referred object or null

setHost

public final void setHost(CfgHost value)
A unique identifier of the CfgHost where this server resides. Cannot be changed as long as the server is associated with at least one client application or a primary server.

Parameters:
value - new property value
See Also:
getHost()

setHostDBID

public final void setHostDBID(int dbid)
A unique identifier of the CfgHost where this server resides. Cannot be changed as long as the server is associated with at least one client application or a primary server.

Parameters:
dbid - DBID identifier of referred object
See Also:
getHost()

getHostDBID

public final java.lang.Integer getHostDBID()
Retrieves the dbid of the object that is being linked to by the Host property.

Returns:
DBID identifier of referred object or null

getPort

public final java.lang.String getPort()
A pointer to the name of the port which client applications should use to open communication sessions to this server. Populated for backward compatibility purpose from portInfos list.

Returns:
property value or null

setPort

public final void setPort(java.lang.String value)
A pointer to the name of the port which client applications should use to open communication sessions to this server. Populated for backward compatibility purpose from portInfos list.

Parameters:
value - new property value
See Also:
getPort()

getBackupServer

public final CfgApplication getBackupServer()
An identifier of the Server which is to be contacted if connection to this server fails. The backup server must be associated with the same account (see ConfSetAccount) and have the same application type(CfgAppType). One backup server cannot be associated with more than one primary server. See comments.

Returns:
instance of referred object or null

setBackupServer

public final void setBackupServer(CfgApplication value)
An identifier of the Server which is to be contacted if connection to this server fails. The backup server must be associated with the same account (see ConfSetAccount) and have the same application type(CfgAppType). One backup server cannot be associated with more than one primary server. See comments.

Parameters:
value - new property value
See Also:
getBackupServer()

setBackupServerDBID

public final void setBackupServerDBID(int dbid)
An identifier of the Server which is to be contacted if connection to this server fails. The backup server must be associated with the same account (see ConfSetAccount) and have the same application type(CfgAppType). One backup server cannot be associated with more than one primary server. See comments.

Parameters:
dbid - DBID identifier of referred object
See Also:
getBackupServer()

getBackupServerDBID

public final java.lang.Integer getBackupServerDBID()
Retrieves the dbid of the object that is being linked to by the BackupServer property.

Returns:
DBID identifier of referred object or null

getTimeout

public final java.lang.Integer getTimeout()
Time-out in seconds that the application should run before making a re-connect attempt after a communication session with this server has failed. May not be set to a negative value. Recommended to be set to 10 by default.

Returns:
property value or null

setTimeout

public final void setTimeout(java.lang.Integer value)
Time-out in seconds that the application should run before making a re-connect attempt after a communication session with this server has failed. May not be set to a negative value. Recommended to be set to 10 by default.

Parameters:
value - new property value
See Also:
getTimeout()

getAttempts

public final java.lang.Integer getAttempts()
Number of attempts to connect to this server before trying to connect to the backup server. Makes sense only if backupServerDBID is specified. May not be set to a negative value. Recommended to be set to 1 by default.

Returns:
property value or null

setAttempts

public final void setAttempts(java.lang.Integer value)
Number of attempts to connect to this server before trying to connect to the backup server. Makes sense only if backupServerDBID is specified. May not be set to a negative value. Recommended to be set to 1 by default.

Parameters:
value - new property value
See Also:
getAttempts()

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.