Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaApplication

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.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaApplication
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaApplication
extends CfgDelta

The changes to make to a CfgApplication object.


Constructor Summary
CfgDeltaApplication(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgDeltaApplication(IConfService confService, ConfObjectDelta objData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
CfgDeltaApplication(IConfService confService, org.w3c.dom.Node xmlData)
          This constructor is intended for creation of delta objects from configuration protocol messages.
 
Method Summary
 java.util.Collection<CfgConnInfo> getAddedAppServers()
          A pointer to the list of structures of type CfgConnInfo .
 KeyValueCollection getAddedFlexibleProperties()
          A pointer to the list of additional properties.
 KeyValueCollection getAddedOptions()
          A pointer to the list of application-specific configuration options (see the comments below).
 java.util.Collection<CfgPortInfo> getAddedPortInfos()
          A pointer to the list of structures of type CfgPortInfo containing information about listening ports for this Server application.
 java.util.Collection<CfgObjectResource> getAddedResources()
          A pointer to the list of the objects associated with this Application (every item of this list is structured as CfgObjectResource ).
 java.util.Collection<java.lang.Integer> getAddedTenantDBIDs()
          A pointer to the list of identifiers of the Tenants that are served by this application.
 java.util.Collection<CfgTenant> getAddedTenants()
          A pointer to the list of identifiers of the Tenants that are served by this application.
 KeyValueCollection getAddedUserProperties()
          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.
 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.
 CfgFlag getAutoRestart()
          Indicates whether the application should be automatically restarted by Local Control Agent after its crash.
 java.util.Collection<CfgConnInfo> getChangedAppServers()
          A pointer to the list of structures CfgConnInfo type.
 KeyValueCollection getChangedFlexibleProperties()
          Should not be used.
 KeyValueCollection getChangedOptions()
          A pointer to the list of application-specific options whose values have been changed.
 java.util.Collection<CfgPortInfo> getChangedPortInfos()
          A pointer to the list of structures CfgPortInfo type.
 java.util.Collection<CfgObjectResource> getChangedResources()
          A pointer to the list of structures CfgObjectResource type.
 KeyValueCollection getChangedUserProperties()
          A pointer to the list of user-defined properties whose values have been changed.
 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()
          The DBID of the target CfgApplication configuration object.
 java.util.Collection<java.lang.Integer> getDeletedAppServerDBIDs()
          A pointer to the list of identifiers of the servers this application can no longer be a client to.
 java.util.Collection<CfgConnInfo> getDeletedAppServers()
          A pointer to the list of identifiers of the servers this application can no longer be a client to.
 KeyValueCollection getDeletedFlexibleProperties()
          A pointer to the list of deleted options within flexibleProperties property.
 KeyValueCollection getDeletedOptions()
          A pointer to the list of deleted application-specific options.
 java.util.Collection<CfgPortInfo> getDeletedPortInfos()
          A pointer to the list of deleted resources (every item of this list is a pointer to a string containing identifier (id) of the listening port structure.
 java.util.Collection<CfgResourceID> getDeletedResources()
          A pointer to the list of deleted resources (every item of this list is structured as CfgID ).
 java.util.Collection<java.lang.Integer> getDeletedTenantDBIDs()
          A pointer to the list of identifiers of the tenants that are no longer associated with this application.
 java.util.Collection<CfgTenant> getDeletedTenants()
          A pointer to the list of identifiers of the tenants that are no longer associated with this application.
 KeyValueCollection getDeletedUserProperties()
          A pointer to the list of deleted user-defined 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.
 java.lang.String getPassword()
          A pointer to the application password.
 CfgHAType getRedundancyType()
          Defines the HA type if this application is considered as server.
 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()
          Deprecated.  
 CfgAppType getType()
          Type of the application.
 java.lang.String getVersion()
          A pointer to the application version.
 java.lang.String getWorkDirectory()
          Working directory for the application.
 CfgApplication retrieveCfgApplication()
          Read base CfgApplication configuration object caused this event.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta
ensureDataBackup, retrieveObject, save, toStringProperties, update
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, 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, 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
 

Constructor Detail

CfgDeltaApplication

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

Parameters:
confService - configuration service instance

CfgDeltaApplication

public CfgDeltaApplication(IConfService confService,
                           ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaApplication

public CfgDeltaApplication(IConfService confService,
                           org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgApplication configuration object.

Returns:
target object DBID

retrieveCfgApplication

public final CfgApplication retrieveCfgApplication()
                                            throws ConfigException
Read base CfgApplication configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

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

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

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

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

getAddedAppServers

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

Returns:
list of structures or null

getAddedTenants

public final java.util.Collection<CfgTenant> getAddedTenants()
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

getAddedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getAddedTenantDBIDs()
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:
collection of DBID identifiers of referred objects or null

getTenantDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getTenantDBIDs()
Deprecated. 

See Also:
getAddedTenantDBIDs()

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

getAddedOptions

public final KeyValueCollection getAddedOptions()
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

getState

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

Returns:
property value or null

getAddedUserProperties

public final KeyValueCollection getAddedUserProperties()
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

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

getAppPrototypeDBID

public final java.lang.Integer getAppPrototypeDBID()
Retrieves the dbid of the object that is being linked to by the AppPrototype property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getAddedFlexibleProperties

public final KeyValueCollection getAddedFlexibleProperties()
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

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

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

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

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

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

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

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

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

getAddedPortInfos

public final java.util.Collection<CfgPortInfo> getAddedPortInfos()
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

getAddedResources

public final java.util.Collection<CfgObjectResource> getAddedResources()
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

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

getDeletedAppServers

public final java.util.Collection<CfgConnInfo> getDeletedAppServers()
A pointer to the list of identifiers of the servers this application can no longer be a client to.

Returns:
list of configuration objects or null

getDeletedAppServerDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedAppServerDBIDs()
A pointer to the list of identifiers of the servers this application can no longer be a client to.

Returns:
collection of DBID identifiers of referred objects or null

getDeletedTenants

public final java.util.Collection<CfgTenant> getDeletedTenants()
A pointer to the list of identifiers of the tenants that are no longer associated with this application. For applications of CFGTServer type, cannot be specified as long as the application is associated with a switch (see CfgSwitch ).

Returns:
list of configuration objects or null

getDeletedTenantDBIDs

public final java.util.Collection<java.lang.Integer> getDeletedTenantDBIDs()
A pointer to the list of identifiers of the tenants that are no longer associated with this application. For applications of CFGTServer type, cannot be specified as long as the application is associated with a switch (see CfgSwitch ).

Returns:
collection of DBID identifiers of referred objects or null

getDeletedOptions

public final KeyValueCollection getDeletedOptions()
A pointer to the list of deleted application-specific options. The structure of this parameter is described in the comments to type CfgApplication above. An option is deleted by specifying the name of the section that this option belongs to, and the name of the option itself with any value. A whole section is deleted by specifying the name of that section and an empty secondary list.

Returns:
property value or null

getChangedOptions

public final KeyValueCollection getChangedOptions()
A pointer to the list of application-specific options whose values have been changed. The structure of this parameter is described in the comments to type CfgApplication above. A value of an option is changed by specifying the name of the section that this option belongs to, the name of the option itself, and the new value of that option.

Returns:
property value or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

getDeletedFlexibleProperties

public final KeyValueCollection getDeletedFlexibleProperties()
A pointer to the list of deleted options within flexibleProperties property.

Returns:
property value or null

getChangedFlexibleProperties

public final KeyValueCollection getChangedFlexibleProperties()
Should not be used. The structure of the flexibleProperties implies only add and delete actions.

Returns:
property value or null

getChangedAppServers

public final java.util.Collection<CfgConnInfo> getChangedAppServers()
A pointer to the list of structures CfgConnInfo type. Each structure contains appServerDBID and the information about connection parameters that have been changed.

Returns:
list of structures or null

getDeletedResources

public final java.util.Collection<CfgResourceID> getDeletedResources()
A pointer to the list of deleted resources (every item of this list is structured as CfgID ).

Returns:
list of structures or null

getChangedResources

public final java.util.Collection<CfgObjectResource> getChangedResources()
A pointer to the list of structures CfgObjectResource type. Each structure contains information about the resource parameters that have been changed.

Returns:
list of structures or null

getDeletedPortInfos

public final java.util.Collection<CfgPortInfo> getDeletedPortInfos()
A pointer to the list of deleted resources (every item of this list is a pointer to a string containing identifier (id) of the listening port structure.

Returns:
list of string values or null

getChangedPortInfos

public final java.util.Collection<CfgPortInfo> getChangedPortInfos()
A pointer to the list of structures CfgPortInfo type. Each structure contains information about the listening port parameters that have been changed.

Returns:
list of structures or null

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.