Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgHost

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.objects.CfgHost
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgHost
extends CfgObject

Hosts are the computers that run the various CTI server applications in an environment.

A host cannot be deleted as long as there is at least one server associated with it (see CfgServer and CfgApplication ).

See also:

CfgDeltaHost

CfgApplication


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgHost(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgHost(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgHost(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 CfgAddress getAddress()
          Not in use.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 java.lang.String getIPaddress()
          A pointer to the IP address of the host.
 java.lang.String getLCAPort()
          A port on which the Local Control Agent for this host is supposed to be running.
 java.lang.String getName()
          A pointer to name of the host.
 CfgOS getOSinfo()
          A pointer to the structure containing information about the operating system of this host.
 java.util.Collection<CfgObjectResource> getResources()
          A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ).
 CfgApplication getSCS()
          A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host.
 java.lang.Integer getSCSDBID()
          Retrieves the dbid of the object that is being linked to by the SCS property.
 CfgObjectState getState()
          Current object state.
 CfgHostType getType()
          Type of the host.
 KeyValueCollection getUserProperties()
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAddress(CfgAddress value)
          Not in use.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setIPaddress(java.lang.String value)
          A pointer to the IP address of the host.
 void setLCAPort(java.lang.String value)
          A port on which the Local Control Agent for this host is supposed to be running.
 void setName(java.lang.String value)
          A pointer to name of the host.
 void setOSinfo(CfgOS value)
          A pointer to the structure containing information about the operating system of this host.
 void setResources(java.util.Collection<CfgObjectResource> value)
          A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ).
 void setSCS(CfgApplication value)
          A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host.
 void setSCSDBID(int dbid)
          A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host.
 void setState(CfgObjectState value)
          Current object state.
 void setType(CfgHostType value)
          Type of the host.
 void setUserProperties(KeyValueCollection value)
          A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, updateACL
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toStringProperties, toXml, updateChildrenSavedState
 
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
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgHost

public CfgHost(IConfService confService,
               ConfObject objData,
               boolean isSaved,
               java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgHost

public CfgHost(IConfService confService,
               org.w3c.dom.Node xmlData,
               java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgHost

public CfgHost(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

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

getName

public final java.lang.String getName()
A pointer to name of the host. Mandatory. Must be unique within the Configuration Database. Cannot be changed as long as at least one server is assigned to this host.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to name of the host. Mandatory. Must be unique within the Configuration Database. Cannot be changed as long as at least one server is assigned to this host.

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

getIPaddress

public final java.lang.String getIPaddress()
A pointer to the IP address of the host. Optional. Must be unique within the Configuration Database. Max length 64 symbols.

Returns:
property value or null

setIPaddress

public final void setIPaddress(java.lang.String value)
A pointer to the IP address of the host. Optional. Must be unique within the Configuration Database. Max length 64 symbols.

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

getOSinfo

public final CfgOS getOSinfo()
A pointer to the structure containing information about the operating system of this host. Once specified, cannot be set to NULL. See structure CfgOS .

Returns:
property value or null

setOSinfo

public final void setOSinfo(CfgOS value)
A pointer to the structure containing information about the operating system of this host. Once specified, cannot be set to NULL. See structure CfgOS .

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

getType

public final CfgHostType getType()
Type of the host. Mandatory. Once specified, cannot be changed. See type CfgHostType .

Returns:
property value or null

setType

public final void setType(CfgHostType value)
Type of the host. Mandatory. Once specified, cannot be changed. See type CfgHostType .

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

getAddress

public final CfgAddress getAddress()
Not in use.

Returns:
property value or null

setAddress

public final void setAddress(CfgAddress value)
Not in use.

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

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

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

getUserProperties

public final KeyValueCollection getUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

Returns:
property value or null

setUserProperties

public final void setUserProperties(KeyValueCollection value)
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section.

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

getLCAPort

public final java.lang.String getLCAPort()
A port on which the Local Control Agent for this host is supposed to be running. Mandatory. Default value for migration from 5.1.xxx to 5.9.xxx is 4999, for newly created hosts the value must be specified. Allowed value is any positive whole number within 0-9999 range.

Returns:
property value or null

setLCAPort

public final void setLCAPort(java.lang.String value)
A port on which the Local Control Agent for this host is supposed to be running. Mandatory. Default value for migration from 5.1.xxx to 5.9.xxx is 4999, for newly created hosts the value must be specified. Allowed value is any positive whole number within 0-9999 range.

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

getSCS

public final CfgApplication getSCS()
A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host. This property is valid only if Distributed SCS functionality is enabled.

Returns:
instance of referred object or null

setSCS

public final void setSCS(CfgApplication value)
A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host. This property is valid only if Distributed SCS functionality is enabled.

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

setSCSDBID

public final void setSCSDBID(int dbid)
A unique identifier of an CfgApplication of CFGSCS type which is supposed to monitor/control this host. This property is valid only if Distributed SCS functionality is enabled.

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

getSCSDBID

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

Returns:
DBID identifier of referred object or null

getResources

public final java.util.Collection<CfgObjectResource> getResources()
A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaHost , it is a pointer to a list of resources added to the existing list. Only objects of type CfgEnumeratorType , CfgScript and CfgApplication can be associated with Host object through resources

Returns:
list of structures or null

setResources

public final void setResources(java.util.Collection<CfgObjectResource> value)
A pointer to the list of the objects associated with this Host (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaHost , it is a pointer to a list of resources added to the existing list. Only objects of type CfgEnumeratorType , CfgScript and CfgApplication can be associated with Host object through resources

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

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.