Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Class GCOMApplicationConfiguration

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.GApplicationConfiguration
      extended by com.genesyslab.platform.apptemplate.configuration.GCOMApplicationConfiguration
All Implemented Interfaces:
IGApplicationConfiguration, java.io.Serializable, java.lang.Cloneable

public class GCOMApplicationConfiguration
extends GApplicationConfiguration

This class represents base Genesys CME application options, which can be loaded from initialized COM AB CfgApplication, its' related objects and structures.

It extends base class GApplicationConfiguration with only one feature - constructor, which can initialize the application configuration properties with information retrieved from COM AB application object.

COM AB direct usage example:

     String appName = "<app-name>";
     CfgApplication cfgApplication = confService.retrieveObject(
             CfgApplication.class, new CfgApplicationQuery(appName));

     GCOMApplicationConfiguration appConfiguration =
             new GCOMApplicationConfiguration(cfgApplication);
 

See Also:
Serialized Form

Nested Class Summary
static class GCOMApplicationConfiguration.GCOMAppConnConfiguration
          This class is an extension of base GAppConnConfiguration structure with logic related to COM AB information extraction as detached configuration data.
static class GCOMApplicationConfiguration.GCOMHost
          This class is an extension of base GHost structure with logic related to COM AB information extraction as detached configuration data.
static class GCOMApplicationConfiguration.GCOMPortInfo
          This class is an extension of base GPortInfo structure with logic related to COM AB information extraction as detached configuration data.
static class GCOMApplicationConfiguration.GCOMServerInfo
          This class is an extension of base GServerInfo structure with logic related to COM AB information extraction as detached configuration data.
 
Nested classes/interfaces inherited from class com.genesyslab.platform.apptemplate.configuration.GApplicationConfiguration
GApplicationConfiguration.GAppConnConfiguration, GApplicationConfiguration.GHost, GApplicationConfiguration.GPortInfo, GApplicationConfiguration.GServerInfo
 
Nested classes/interfaces inherited from interface com.genesyslab.platform.apptemplate.configuration.IGApplicationConfiguration
IGApplicationConfiguration.IGAppConnConfiguration, IGApplicationConfiguration.IGHost, IGApplicationConfiguration.IGPortInfo, IGApplicationConfiguration.IGServerInfo
 
Constructor Summary
GCOMApplicationConfiguration(CfgApplication cfgApplication)
          Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.
GCOMApplicationConfiguration(CfgApplication cfgApplication, boolean readConnections)
          Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.
GCOMApplicationConfiguration(CfgApplication cfgApplication, boolean readConnections, boolean readClusterConnections)
          Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.
GCOMApplicationConfiguration(GCOMApplicationConfiguration conf)
          Copying constructor.
Note: It creates new GCOMApplicationConfiguration instance, but does not clone referred structures like getCfgApplication(), GApplicationConfiguration.getAppServers(), GApplicationConfiguration.getPortInfos(), GApplicationConfiguration.getOptions(), etc.
 
Method Summary
protected  java.lang.String contentToString()
          This method is used from GApplicationConfiguration.toString() to build string representation of the internal content (configuration properties names and values).
 CfgApplication getCfgApplication()
          Returns reference to the original CfgApplication object as source of initial configuration properties values.
 
Methods inherited from class com.genesyslab.platform.apptemplate.configuration.GApplicationConfiguration
clone, getApplicationName, getApplicationType, getAppServer, getAppServers, getAppServers, getAppServers, getDbid, getFlexibleProperties, getObjectState, getOptions, getPortInfo, getPortInfo, getPortInfos, getRedundancyType, getServerInfo, getUserProperties, getVersion, isPrimary, isServer, setApplicationName, setApplicationType, setAppServers, setDbid, setFlexibleProperties, setIsPrimary, setIsServer, setObjectState, setOptions, setPortInfos, setRedundancyType, setServerInfo, setUserProperties, setVersion, toString
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

GCOMApplicationConfiguration

public GCOMApplicationConfiguration(CfgApplication cfgApplication)
                             throws ConfigurationException
Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.

Parameters:
cfgApplication - application properties represented as COM AB application object
Throws:
ConfigurationException - in case of configuration problems

GCOMApplicationConfiguration

public GCOMApplicationConfiguration(CfgApplication cfgApplication,
                                    boolean readConnections)
                             throws ConfigurationException
Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.

Parameters:
cfgApplication - application properties represented as COM AB application object
readConnections - flag indicating needs to read connected applications configuration
Throws:
ConfigurationException - in case of configuration problems

GCOMApplicationConfiguration

public GCOMApplicationConfiguration(CfgApplication cfgApplication,
                                    boolean readConnections,
                                    boolean readClusterConnections)
                             throws ConfigurationException
Loads application configuration properties from given COM AB CfgApplication object including configuration of connected CfgApplication's and CfgHost's.

Parameters:
cfgApplication - application properties represented as COM AB application object
readConnections - flag indicating needs to read connected applications configuration
readClusterConnections - flag indicating needs to read connected applications clusters configuration
Throws:
ConfigurationException - in case of configuration problems

GCOMApplicationConfiguration

public GCOMApplicationConfiguration(GCOMApplicationConfiguration conf)
Copying constructor.
Note: It creates new GCOMApplicationConfiguration instance, but does not clone referred structures like getCfgApplication(), GApplicationConfiguration.getAppServers(), GApplicationConfiguration.getPortInfos(), GApplicationConfiguration.getOptions(), etc.

Parameters:
conf - original configuration to copy configuration values from
Method Detail

getCfgApplication

public CfgApplication getCfgApplication()
Returns reference to the original CfgApplication object as source of initial configuration properties values.

Returns:
reference to COM AB application object

contentToString

protected java.lang.String contentToString()
This method is used from GApplicationConfiguration.toString() to build string representation of the internal content (configuration properties names and values).

Overrides:
contentToString in class GApplicationConfiguration
Returns:
string representation of the configuration content
See Also:
GApplicationConfiguration.toString()

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.