|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.objects.CfgHost
public class CfgHost
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
).
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgHost(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgHost(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgHost(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getIPaddress()
public final void setIPaddress(java.lang.String value)
value
- new property valuegetIPaddress()
public final CfgOS getOSinfo()
NULL
. See structure
CfgOS
.
public final void setOSinfo(CfgOS value)
NULL
. See structure
CfgOS
.
value
- new property valuegetOSinfo()
public final CfgHostType getType()
CfgHostType
.
public final void setType(CfgHostType value)
CfgHostType
.
value
- new property valuegetType()
public final CfgAddress getAddress()
public final void setAddress(CfgAddress value)
value
- new property valuegetAddress()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
public final java.lang.String getLCAPort()
public final void setLCAPort(java.lang.String value)
value
- new property valuegetLCAPort()
public final CfgApplication getSCS()
CfgApplication
of CFGSCS
type which is supposed to monitor/control
this host. This property is valid only if Distributed SCS functionality
is enabled.
public final void setSCS(CfgApplication value)
CfgApplication
of CFGSCS
type which is supposed to monitor/control
this host. This property is valid only if Distributed SCS functionality
is enabled.
value
- new property valuegetSCS()
public final void setSCSDBID(int dbid)
CfgApplication
of CFGSCS
type which is supposed to monitor/control
this host. This property is valid only if Distributed SCS functionality
is enabled.
dbid
- DBID identifier of referred objectgetSCS()
public final java.lang.Integer getSCSDBID()
public final java.util.Collection<CfgObjectResource> getResources()
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
public final void setResources(java.util.Collection<CfgObjectResource> value)
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
value
- new property valuegetResources()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |