Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Interface IGApplicationConfiguration

All Known Implementing Classes:
GApplicationConfiguration, GCOMApplicationConfiguration

public interface IGApplicationConfiguration

This interface represents base Genesys CME application options, which can be loaded from configuration server (with COM AB), or initialized by some other way like custom user code or any beans management mechanisms/frameworks.

It provides detached properties from COM AB CfgApplication and CfgHost objects without COM AB specific internal XML containers and can be created and filled with or without IConfService usage.

See Also:
GApplicationConfiguration, GCOMApplicationConfiguration

Nested Class Summary
static interface IGApplicationConfiguration.IGAppConnConfiguration
          The application connection configuration structure reflects COM AB CfgConnInfo information.
It contains reference to connected server with related connection properties.
static interface IGApplicationConfiguration.IGHost
          Structure describing host where server is configured to run.
It reflects detached information from COM AB CfgHost.
static interface IGApplicationConfiguration.IGPortInfo
          This structure contains properties for listening port of server type application.
static interface IGApplicationConfiguration.IGServerInfo
          This structure represents group of server type specific application properties.
 
Method Summary
 java.lang.String getApplicationName()
          Returns the application name.
It represents the correspondent name in Genesys Configuration framework.
 CfgAppType getApplicationType()
          Returns type of the application in terms of Genesys Configuration framework.
 java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> getAppServers()
          Returns list of structures describing connected server applications.
 java.lang.Integer getDbid()
          Returns unique application object identifier in context of Genesys Configuration Database.
 KeyValueCollection getFlexibleProperties()
          Returns pointer to the list of additional properties.
 CfgObjectState getObjectState()
          Returns actual object state in the Genesys Configuration Database.
 KeyValueCollection getOptions()
          Returns pointer to the list of application-specific configuration options.
 java.util.List<IGApplicationConfiguration.IGPortInfo> getPortInfos()
          Returns pointer to the list of structures of type IGApplicationConfiguration.IGPortInfo containing information about listening ports for this server application.
 CfgHAType getRedundancyType()
          Returns the HA type if this application is considered as server.
 IGApplicationConfiguration.IGServerInfo getServerInfo()
          Returns structure with server type application specific properties.
 KeyValueCollection getUserProperties()
          Returns pointer to the list of user-defined properties.
It represents the "Annex" tab of the application object in CME.
 java.lang.String getVersion()
          Returns the application version.
 java.lang.Boolean isPrimary()
          Returns value meaning role of application within HA/redundancy group.
 java.lang.Boolean isServer()
          Returns indicator of whether this application can be a server to some other applications.
 

Method Detail

getApplicationName

java.lang.String getApplicationName()
Returns the application name.
It represents the correspondent name in Genesys Configuration framework.

Returns:
the application name
See Also:
CfgApplication.getName()

getApplicationType

CfgAppType getApplicationType()
Returns type of the application in terms of Genesys Configuration framework.

Returns:
the application type
See Also:
CfgApplication.getType()

getDbid

java.lang.Integer getDbid()
Returns unique application object identifier in context of Genesys Configuration Database.

Returns:
the application DBID
See Also:
CfgApplication.getDBID()

getObjectState

CfgObjectState getObjectState()
Returns actual object state in the Genesys Configuration Database.

Returns:
actual object state
See Also:
CfgApplication.getState()

isServer

java.lang.Boolean isServer()
Returns indicator of whether this application can be a server to some other applications. This value depends on the application type - getApplicationType().

Returns:
property value or null
See Also:
CfgApplication.getIsServer()

isPrimary

java.lang.Boolean isPrimary()
Returns value meaning role of application within HA/redundancy group.

Returns:
property value or null
See Also:
CfgApplication.getIsPrimary()

getVersion

java.lang.String getVersion()
Returns the application version.

Returns:
the application version
See Also:
CfgApplication.getVersion()

getServerInfo

IGApplicationConfiguration.IGServerInfo getServerInfo()
Returns structure with server type application specific properties. It should be null for client type applications.

Returns:
the server type specific application properties or null
See Also:
CfgApplication.getServerInfo(), CfgServer

getPortInfos

java.util.List<IGApplicationConfiguration.IGPortInfo> getPortInfos()
Returns pointer to the list of structures of type IGApplicationConfiguration.IGPortInfo containing information about listening ports for this server application.

Returns:
list of structures or null
See Also:
CfgApplication.getPortInfos()

getRedundancyType

CfgHAType getRedundancyType()
Returns the HA type if this application is considered as server.

Returns:
the application HA type or null
See Also:
CfgApplication.getRedundancyType()

getAppServers

java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> getAppServers()
Returns list of structures describing connected server applications.

Returns:
list of structures or null
See Also:
IGApplicationConfiguration.IGAppConnConfiguration, CfgApplication.getAppServers(), CfgConnInfo

getOptions

KeyValueCollection getOptions()
Returns pointer to the list of application-specific configuration options.

Returns:
collection of options' sections or null
See Also:
CfgApplication.getOptions()

getUserProperties

KeyValueCollection getUserProperties()
Returns pointer to the list of user-defined properties.
It represents the "Annex" tab of the application object in CME.

Returns:
collection of properties sections or null
See Also:
CfgApplication.getUserProperties()

getFlexibleProperties

KeyValueCollection getFlexibleProperties()
Returns pointer to the list of additional properties.

Returns:
collection of additional properties or null
See Also:
CfgApplication.getFlexibleProperties()

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.