|
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.CfgApplication
public class CfgApplication
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:
backupServerDBID
field of the
application that had Application X as a backup server
appServerDBIDs
field of all applications
that had Application X in their connections
statServerDBID
or
dialerDBID
fields set to Application X
IVRServerDBID
field
set to Application X
SCSDBID
field
set to Application X
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.
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:
workDirectory = '.'
commandLine = name
(the value of name property)
autoRestart = CFGFalse
startupTimeout = 90
redundancyType=CFGHTColdStandby
isPrimary=CFGTrue
startupType=
CFGITCUtility
(53)
The name of the application can not be changed if there is,
at least, one active client exist registered under this name
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgApplication(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 CfgApplication(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 CfgApplication(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 getPassword()
public final void setPassword(java.lang.String value)
value
- new property valuegetPassword()
public final CfgAppType getType()
type
of the application prototype specified
in appPrototypeDBID
or explicitly during the creation
time. Once specified, cannot be changed. See
CfgAppType
.
public final void setType(CfgAppType value)
type
of the application prototype specified
in appPrototypeDBID
or explicitly during the creation
time. Once specified, cannot be changed. See
CfgAppType
.
value
- new property valuegetType()
public final java.lang.String getVersion()
version
of the application prototype specified
in appPrototypeDBID
or explicitly.
public final void setVersion(java.lang.String value)
version
of the application prototype specified
in appPrototypeDBID
or explicitly.
value
- new property valuegetVersion()
public final java.util.Collection<CfgConnInfo> getAppServers()
CfgConnInfo
.
public final void setAppServers(java.util.Collection<CfgConnInfo> value)
CfgConnInfo
.
value
- new property valuegetAppServers()
public final java.util.Collection<CfgTenant> getTenants()
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.
public final void setTenants(java.util.Collection<CfgTenant> value)
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.
value
- new property valuegetTenants()
public final java.util.Collection<java.lang.Integer> getTenantDBIDs()
public final void setTenantDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgFlag getIsServer()
type
above). See
CfgFlag
.
public final CfgServer getServerInfo()
type
above, the application is a daemon
and must be set to NULL
otherwise. Once specified,
cannot be set to NULL
. See
CfgServer
.
public final void setServerInfo(CfgServer value)
type
above, the application is a daemon
and must be set to NULL
otherwise. Once specified,
cannot be set to NULL
. See
CfgServer
.
value
- new property valuegetServerInfo()
public final KeyValueCollection getOptions()
CfgDeltaApplication
,
it is a pointer to a list of options added to the existing list.
public final void setOptions(KeyValueCollection value)
CfgDeltaApplication
,
it is a pointer to a list of options added to the existing list.
value
- new property valuegetOptions()
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 CfgAppPrototype getAppPrototype()
CfgAppPrototype
. The association
with application prototype could be specified at moment of creation
of application object only.
public final void setAppPrototype(CfgAppPrototype value)
CfgAppPrototype
. The association
with application prototype could be specified at moment of creation
of application object only.
value
- new property valuegetAppPrototype()
public final void setAppPrototypeDBID(int dbid)
CfgAppPrototype
. The association
with application prototype could be specified at moment of creation
of application object only.
dbid
- DBID identifier of referred objectgetAppPrototype()
public final java.lang.Integer getAppPrototypeDBID()
public final KeyValueCollection getFlexibleProperties()
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
public final void setFlexibleProperties(KeyValueCollection value)
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
value
- new property valuegetFlexibleProperties()
public final java.lang.String getWorkDirectory()
isServer
property, the application is a server and
optional otherwise. See comments.
public final void setWorkDirectory(java.lang.String value)
isServer
property, the application is a server and
optional otherwise. See comments.
value
- new property valuegetWorkDirectory()
public final java.lang.String getCommandLine()
isServer
property, the application
is a server and optional otherwise. See comments.
public final void setCommandLine(java.lang.String value)
isServer
property, the application
is a server and optional otherwise. See comments.
value
- new property valuegetCommandLine()
public final CfgFlag getAutoRestart()
CFGTrue
by
default. See comments. See
CfgFlag
public final void setAutoRestart(CfgFlag value)
CFGTrue
by
default. See comments. See
CfgFlag
value
- new property valuegetAutoRestart()
public final java.lang.Integer getStartupTimeout()
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
public final void setStartupTimeout(java.lang.Integer value)
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
value
- new property valuegetStartupTimeout()
public final java.lang.Integer getShutdownTimeout()
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
public final void setShutdownTimeout(java.lang.Integer value)
isServer
property, the application
is a server and optional otherwise. Default value is 90 seconds.
See comments.
value
- new property valuegetShutdownTimeout()
public final CfgHAType getRedundancyType()
CFGHTColdStandby.
See
comments. See
CfgHAType
public final void setRedundancyType(CfgHAType value)
CFGHTColdStandby.
See
comments. See
CfgHAType
value
- new property valuegetRedundancyType()
public final CfgFlag getIsPrimary()
CFGTrue
. Read-only (set in accordance with
the current role within the HA/redundancy group). See comments. See
CfgFlag
public final void setIsPrimary(CfgFlag value)
CFGTrue
. Read-only (set in accordance with
the current role within the HA/redundancy group). See comments. See
CfgFlag
value
- new property valuegetIsPrimary()
public final CfgStartupType getStartupType()
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.
public final java.lang.String getCommandLineArguments()
public final void setCommandLineArguments(java.lang.String value)
value
- new property valuegetCommandLineArguments()
public final java.util.Collection<CfgPortInfo> getPortInfos()
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.
public final void setPortInfos(java.util.Collection<CfgPortInfo> value)
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.
value
- new property valuegetPortInfos()
public final java.util.Collection<CfgObjectResource> getResources()
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
public final void setResources(java.util.Collection<CfgObjectResource> value)
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
value
- new property valuegetResources()
public final CfgAppComponentType getComponentType()
public final void setComponentType(CfgAppComponentType value)
value
- new property valuegetComponentType()
public CfgACEID retrieveLogonAs() throws ConfigException
ConfigException
- if logon account can't be read from serverpublic void updateLogonAs(CfgObjectType accountType, int accountDbid) throws ConfigException
application.updateLogonAs(CfgObjectType.CFGAccessGroup, WellKnownDBIDs.SystemDBID);
accountType
- type of the account object: CFGPerson or CFGAccessGroupaccountDbid
- account object's DBID
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 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |