Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgApplication

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.CfgApplication
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgApplication
extends CfgObject

Applications are the various Genesys software programs that serve a contact center. There are two types of Applications: GUI-based Applications and daemon Applications.

Deletion of Application(Server) X will cause the following events set out in the order of arrival:

An application/server cannot be deleted as long as it associated with at least one client application i.e., the connection between client and server is specified within configuration object or it is included to at least one non-optional solution component, or it is assigned as DBServer to at least one table access.

Parameter options has the following structure: Each key-value pair of the primary list ( TKVList *options) uses the key for the name of a configuration section, and the value for a secondary list, that also has the TKVList structure and specifies the configuration options defined within that section. Each key-value pair of the secondary list uses the key for the name of a configuration option, and the value for its current setting. Configuration options can be defined as variables of integer, character, or binary type. Names of sections must be unique within the primary list. Names of options must be unique within the secondary list.
Note:
Configuration Server is not concerned with logical meanings of application-specific configuration sections, options, or their values.

Applications of the daemon type are allowed to establish one and only one communication session to Configuration Server.

Access privileges of an application of the daemon type are determined by the access privileges of the account it is associated with. By default, a new application of the daemon type is associated with access group System (see comments to CfgAccessGroup in section Access Control Functions and Data Types). Function ConfSetAccount can be used to change the default account.

Access privileges of an application of the GUI type are determined by the access privileges of the currently logged-on person. See comments to CfgPerson .

An application is allowed to establish a communication session with Configuration Server only if the currently logged-on person (for GUI applications) or the account (for daemon applications) has Execute permission with respect to this Application (see type CfgACE).

An application of CFGConfigServer type with DBID = 99 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application cannot be deleted.

An application of CFGSCE type with DBID = 100 shall be pre-defined (scripted) in the Configuration Database before Configuration Server is started for the first time. The object that represents this application cannot be deleted.

An application can be included into different solutions. Configuration Server does not provide the synchronization property tenantDBID of CfgService and property tenantDBIDs of CfgApplication. The tenantDBIDs list should be updated manually or by wizard every time a solution the application is a part of is assigned to a new tenant (the corresponding tenant's id should be added to the list). Similar (manual or by wizard) update should be made if a solution the application is included into is no longer associated with a tenant (the corresponding tenant's id should be removed from the list).

An application can not be deleted as long as there is at least one solution the application is a part of.

After upgrading from CME 5.1.x to 6.1 the following default values should be set for the application:

An application cannot be deleted if it has a type CFGITCUtility (53)

The name of the application can not be changed if there is, at least, one active client exist registered under this name

See also:

CfgDeltaApplication

CfgHost


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgApplication(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgApplication(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgApplication(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
 CfgAppPrototype getAppPrototype()
          A unique identifier of an application prototype this application is based on.
 java.lang.Integer getAppPrototypeDBID()
          Retrieves the dbid of the object that is being linked to by the AppPrototype property.
 java.util.Collection<CfgConnInfo> getAppServers()
          A pointer to the list of structures of type CfgConnInfo .
 CfgFlag getAutoRestart()
          Indicates whether the application should be automatically restarted by Local Control Agent after its crash.
 java.lang.String getCommandLine()
          The name of executable to be used to start the application.
 java.lang.String getCommandLineArguments()
          A pointer to the additional arguments to be used to start the application.
 CfgAppComponentType getComponentType()
          A type of application object.
 java.lang.Integer getDBID()
          An identifier of this object in the Configuration Database.
 KeyValueCollection getFlexibleProperties()
          A pointer to the list of additional properties.
 CfgFlag getIsPrimary()
          A role of application within HA/redundancy group.
 CfgFlag getIsServer()
          An indicator of whether this application can be a server to some other applications.
 java.lang.String getName()
          A pointer to the name of the application.
 KeyValueCollection getOptions()
          A pointer to the list of application-specific configuration options (see the comments below).
 java.lang.String getPassword()
          A pointer to the application password.
 java.util.Collection<CfgPortInfo> getPortInfos()
          A pointer to the list of structures of type CfgPortInfo containing information about listening ports for this Server application.
 CfgHAType getRedundancyType()
          Defines the HA type if this application is considered as server.
 java.util.Collection<CfgObjectResource> getResources()
          A pointer to the list of the objects associated with this Application (every item of this list is structured as CfgObjectResource ).
 CfgServer getServerInfo()
          A pointer to the structure containing server-specific information.
 java.lang.Integer getShutdownTimeout()
          A period of time within which the application is expected to be completely shut down.
 java.lang.Integer getStartupTimeout()
          A period of time within which the application is expected to be completely started.
 CfgStartupType getStartupType()
          A type of application startup.
 CfgObjectState getState()
          Current object state.
 java.util.Collection<java.lang.Integer> getTenantDBIDs()
          Retrieves dbids of objects that are being linked to by the Tenants property.
 java.util.Collection<CfgTenant> getTenants()
          A pointer to the list of identifiers of the Tenants that are served by this application.
 CfgAppType getType()
          Type of the application.
 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.
 java.lang.String getVersion()
          A pointer to the application version.
 java.lang.String getWorkDirectory()
          Working directory for the application.
 CfgACEID retrieveLogonAs()
          Reads "Logon As" account of this application.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAppPrototype(CfgAppPrototype value)
          A unique identifier of an application prototype this application is based on.
 void setAppPrototypeDBID(int dbid)
          A unique identifier of an application prototype this application is based on.
 void setAppServers(java.util.Collection<CfgConnInfo> value)
          A pointer to the list of structures of type CfgConnInfo .
 void setAutoRestart(CfgFlag value)
          Indicates whether the application should be automatically restarted by Local Control Agent after its crash.
 void setCommandLine(java.lang.String value)
          The name of executable to be used to start the application.
 void setCommandLineArguments(java.lang.String value)
          A pointer to the additional arguments to be used to start the application.
 void setComponentType(CfgAppComponentType value)
          A type of application object.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setFlexibleProperties(KeyValueCollection value)
          A pointer to the list of additional properties.
 void setIsPrimary(CfgFlag value)
          A role of application within HA/redundancy group.
 void setName(java.lang.String value)
          A pointer to the name of the application.
 void setOptions(KeyValueCollection value)
          A pointer to the list of application-specific configuration options (see the comments below).
 void setPassword(java.lang.String value)
          A pointer to the application password.
 void setPortInfos(java.util.Collection<CfgPortInfo> value)
          A pointer to the list of structures of type CfgPortInfo containing information about listening ports for this Server application.
 void setRedundancyType(CfgHAType value)
          Defines the HA type if this application is considered as server.
 void setResources(java.util.Collection<CfgObjectResource> value)
          A pointer to the list of the objects associated with this Application (every item of this list is structured as CfgObjectResource ).
 void setServerInfo(CfgServer value)
          A pointer to the structure containing server-specific information.
 void setShutdownTimeout(java.lang.Integer value)
          A period of time within which the application is expected to be completely shut down.
 void setStartupTimeout(java.lang.Integer value)
          A period of time within which the application is expected to be completely started.
 void setState(CfgObjectState value)
          Current object state.
 void setTenantDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the Tenants property.
 void setTenants(java.util.Collection<CfgTenant> value)
          A pointer to the list of identifiers of the Tenants that are served by this application.
 void setType(CfgAppType value)
          Type of the application.
 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.
 void setVersion(java.lang.String value)
          A pointer to the application version.
 void setWorkDirectory(java.lang.String value)
          Working directory for the application.
 void updateLogonAs(CfgObjectType accountType, int accountDbid)
          Updates "Logon As" account for this application.
 
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

CfgApplication

public CfgApplication(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

CfgApplication

public CfgApplication(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

CfgApplication

public CfgApplication(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 the name of the application. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

setName

public final void setName(java.lang.String value)
A pointer to the name of the application. Mandatory. Must be unique within the Configuration Database.

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

getPassword

public final java.lang.String getPassword()
A pointer to the application password. Max length 64 symbols. Not used in 5.1.

Returns:
property value or null

setPassword

public final void setPassword(java.lang.String value)
A pointer to the application password. Max length 64 symbols. Not used in 5.1.

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

getType

public final CfgAppType getType()
Type of the application. Mandatory. Set automatically according to the value of type of the application prototype specified in appPrototypeDBID or explicitly during the creation time. Once specified, cannot be changed. See CfgAppType .

Returns:
property value or null

setType

public final void setType(CfgAppType value)
Type of the application. Mandatory. Set automatically according to the value of type of the application prototype specified in appPrototypeDBID or explicitly during the creation time. Once specified, cannot be changed. See CfgAppType .

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

getVersion

public final java.lang.String getVersion()
A pointer to the application version. Mandatory. Set automatically according to the value of version of the application prototype specified in appPrototypeDBID or explicitly.

Returns:
property value or null

setVersion

public final void setVersion(java.lang.String value)
A pointer to the application version. Mandatory. Set automatically according to the value of version of the application prototype specified in appPrototypeDBID or explicitly.

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

getAppServers

public final java.util.Collection<CfgConnInfo> getAppServers()
A pointer to the list of structures of type CfgConnInfo .

Returns:
list of structures or null

setAppServers

public final void setAppServers(java.util.Collection<CfgConnInfo> value)
A pointer to the list of structures of type CfgConnInfo .

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

getTenants

public final java.util.Collection<CfgTenant> getTenants()
A pointer to the list of identifiers of the Tenants that are served by this application. Makes sense only for applications of the daemon type. For applications of CFGTServer and CFGHAProxy type, can contain only one tenant. A tenant can be added to this list only if the account that the application is associated with has at least read-only access to this tenant. When used as an entry in CfgDeltaApplication, it is a pointer to a list of identifiers of the tenants added to the existing list.

Returns:
list of configuration objects or null

setTenants

public final void setTenants(java.util.Collection<CfgTenant> value)
A pointer to the list of identifiers of the Tenants that are served by this application. Makes sense only for applications of the daemon type. For applications of CFGTServer and CFGHAProxy type, can contain only one tenant. A tenant can be added to this list only if the account that the application is associated with has at least read-only access to this tenant. When used as an entry in CfgDeltaApplication, it is a pointer to a list of identifiers of the tenants added to the existing list.

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

getTenantDBIDs

public final java.util.Collection<java.lang.Integer> getTenantDBIDs()
Retrieves dbids of objects that are being linked to by the Tenants property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setTenantDBIDs

public final void setTenantDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the Tenants property.

Parameters:
value - collection of DBID identifiers of referred objects

getIsServer

public final CfgFlag getIsServer()
An indicator of whether this application can be a server to some other applications. Read-only (set automatically according to the value of type above). See CfgFlag .

Returns:
property value or null

getServerInfo

public final CfgServer getServerInfo()
A pointer to the structure containing server-specific information. Can be specified if, according to the value specified for the type above, the application is a daemon and must be set to NULL otherwise. Once specified, cannot be set to NULL. See CfgServer .

Returns:
property value or null

setServerInfo

public final void setServerInfo(CfgServer value)
A pointer to the structure containing server-specific information. Can be specified if, according to the value specified for the type above, the application is a daemon and must be set to NULL otherwise. Once specified, cannot be set to NULL. See CfgServer .

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

getOptions

public final KeyValueCollection getOptions()
A pointer to the list of application-specific configuration options (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.

Returns:
property value or null

setOptions

public final void setOptions(KeyValueCollection value)
A pointer to the list of application-specific configuration options (see the comments below). When used as an entry in CfgDeltaApplication, it is a pointer to a list of options added to the existing list.

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

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()

getAppPrototype

public final CfgAppPrototype getAppPrototype()
A unique identifier of an application prototype this application is based on. Optional. See CfgAppPrototype . The association with application prototype could be specified at moment of creation of application object only.

Returns:
instance of referred object or null

setAppPrototype

public final void setAppPrototype(CfgAppPrototype value)
A unique identifier of an application prototype this application is based on. Optional. See CfgAppPrototype . The association with application prototype could be specified at moment of creation of application object only.

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

setAppPrototypeDBID

public final void setAppPrototypeDBID(int dbid)
A unique identifier of an application prototype this application is based on. Optional. See CfgAppPrototype . The association with application prototype could be specified at moment of creation of application object only.

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

getAppPrototypeDBID

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

Returns:
DBID identifier of referred object or null

getFlexibleProperties

public final KeyValueCollection getFlexibleProperties()
A pointer to the list of additional properties. See section Comments at the beginning of this document. Only described below options can be added to this property. This field can not be changed as long as this server remains a backup for some other server (see CfgServer structure) and can only be non-empty for the applications of type CFGTServer and CFGHAProxy

Returns:
property value or null

setFlexibleProperties

public final void setFlexibleProperties(KeyValueCollection value)
A pointer to the list of additional properties. See section Comments at the beginning of this document. Only described below options can be added to this property. This field can not be changed as long as this server remains a backup for some other server (see CfgServer structure) and can only be non-empty for the applications of type CFGTServer and CFGHAProxy

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

getWorkDirectory

public final java.lang.String getWorkDirectory()
Working directory for the application. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. See comments.

Returns:
property value or null

setWorkDirectory

public final void setWorkDirectory(java.lang.String value)
Working directory for the application. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. See comments.

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

getCommandLine

public final java.lang.String getCommandLine()
The name of executable to be used to start the application. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. See comments.

Returns:
property value or null

setCommandLine

public final void setCommandLine(java.lang.String value)
The name of executable to be used to start the application. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. See comments.

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

getAutoRestart

public final CfgFlag getAutoRestart()
Indicates whether the application should be automatically restarted by Local Control Agent after its crash. Mandatory. Recommended to be set to CFGTrue by default. See comments. See CfgFlag

Returns:
property value or null

setAutoRestart

public final void setAutoRestart(CfgFlag value)
Indicates whether the application should be automatically restarted by Local Control Agent after its crash. Mandatory. Recommended to be set to CFGTrue by default. See comments. See CfgFlag

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

getStartupTimeout

public final java.lang.Integer getStartupTimeout()
A period of time within which the application is expected to be completely started. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. Default value is 90 seconds. See comments.

Returns:
property value or null

setStartupTimeout

public final void setStartupTimeout(java.lang.Integer value)
A period of time within which the application is expected to be completely started. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. Default value is 90 seconds. See comments.

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

getShutdownTimeout

public final java.lang.Integer getShutdownTimeout()
A period of time within which the application is expected to be completely shut down. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. Default value is 90 seconds. See comments.

Returns:
property value or null

setShutdownTimeout

public final void setShutdownTimeout(java.lang.Integer value)
A period of time within which the application is expected to be completely shut down. Must be specified if, according to the value specified in isServer property, the application is a server and optional otherwise. Default value is 90 seconds. See comments.

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

getRedundancyType

public final CfgHAType getRedundancyType()
Defines the HA type if this application is considered as server. Mandatory. Default is CFGHTColdStandby. See comments. See CfgHAType

Returns:
property value or null

setRedundancyType

public final void setRedundancyType(CfgHAType value)
Defines the HA type if this application is considered as server. Mandatory. Default is CFGHTColdStandby. See comments. See CfgHAType

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

getIsPrimary

public final CfgFlag getIsPrimary()
A role of application within HA/redundancy group. Must be considered in association with redundancyType property. Default is CFGTrue . Read-only (set in accordance with the current role within the HA/redundancy group). See comments. See CfgFlag

Returns:
property value or null

setIsPrimary

public final void setIsPrimary(CfgFlag value)
A role of application within HA/redundancy group. Must be considered in association with redundancyType property. Default is CFGTrue . Read-only (set in accordance with the current role within the HA/redundancy group). See comments. See CfgFlag

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

getStartupType

public final CfgStartupType getStartupType()
A type of application startup. Indicates whether this application have to be started by Management Layer. See type CfgStartupType Read-only. The property is accessible via API only and not shown by Configuration Manager. Specified during application prototype definition automatically according following: The value is associated with application type CfgAppType. The value for the applications of CFGDBServer and CFGApplicationCluster type is set to CFGSUTDisabled, for other applications of server type is set to CFGSUTAutomatic. For the applications of non-server type is set to CFGSUTDisabled.

Returns:
property value or null

getCommandLineArguments

public final java.lang.String getCommandLineArguments()
A pointer to the additional arguments to be used to start the application. Optional.

Returns:
property value or null

setCommandLineArguments

public final void setCommandLineArguments(java.lang.String value)
A pointer to the additional arguments to be used to start the application. Optional.

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

getPortInfos

public final java.util.Collection<CfgPortInfo> getPortInfos()
A pointer to the list of structures of type CfgPortInfo containing information about listening ports for this Server application. When used as an entry in CfgDeltaApplication , it is a pointer to a list of port infos added to the existing list.

Returns:
list of structures or null

setPortInfos

public final void setPortInfos(java.util.Collection<CfgPortInfo> value)
A pointer to the list of structures of type CfgPortInfo containing information about listening ports for this Server application. When used as an entry in CfgDeltaApplication , it is a pointer to a list of port infos added to the existing list.

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

getResources

public final java.util.Collection<CfgObjectResource> getResources()
A pointer to the list of the objects associated with this Application (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaApplication , it is a pointer to a list of resources added to the existing list. Only objects of type CfgScript can be associated with Application 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 Application (every item of this list is structured as CfgObjectResource ). When used as an entry in CfgDeltaApplication , it is a pointer to a list of resources added to the existing list. Only objects of type CfgScript can be associated with Application object through resources

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

getComponentType

public final CfgAppComponentType getComponentType()
A type of application object. Indicate whenever this is an executable process or it is a service that composed from other services and\or processes.

Returns:
property value or null

setComponentType

public final void setComponentType(CfgAppComponentType value)
A type of application object. Indicate whenever this is an executable process or it is a service that composed from other services and\or processes.

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

retrieveLogonAs

public CfgACEID retrieveLogonAs()
                         throws ConfigException
Reads "Logon As" account of this application. Applicable only for the Server type applications.

Returns:
object that identifies logon account for this application
Throws:
ConfigException - if logon account can't be read from server

updateLogonAs

public void updateLogonAs(CfgObjectType accountType,
                          int accountDbid)
                   throws ConfigException
Updates "Logon As" account for this application. Operation is applicable for the server applications. Account type can be either CfgPerson or CfgAccessGroup. The CfgAccessGroup could be used to set "Logon As" under the SYSTEM account: application.updateLogonAs(CfgObjectType.CFGAccessGroup, WellKnownDBIDs.SystemDBID);

Parameters:
accountType - type of the account object: CFGPerson or CFGAccessGroup
accountDbid - account object's DBID
Throws:
java.lang.IllegalArgumentException - if accountDBID is zero or negative, if accountType null or has unexpected value
ConfigException - if account wasn't updated

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.