|
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.apptemplate.configuration.GApplicationConfiguration
public class GApplicationConfiguration
This class 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.
GCOMApplicationConfiguration
,
Serialized FormNested Class Summary | |
---|---|
static class |
GApplicationConfiguration.GAppConnConfiguration
The application connection configuration structure reflects COM AB CfgConnInfo information.It contains reference to connected server with related connection properties. |
static class |
GApplicationConfiguration.GHost
Structure describing host where server is configured to run. It reflects detached information from COM AB CfgHost . |
static class |
GApplicationConfiguration.GPortInfo
This structure contains properties for listening port of server type application. |
static class |
GApplicationConfiguration.GServerInfo
This structure represents group of server type specific application properties. |
Nested classes/interfaces inherited from interface com.genesyslab.platform.apptemplate.configuration.IGApplicationConfiguration |
---|
IGApplicationConfiguration.IGAppConnConfiguration, IGApplicationConfiguration.IGHost, IGApplicationConfiguration.IGPortInfo, IGApplicationConfiguration.IGServerInfo |
Constructor Summary | |
---|---|
GApplicationConfiguration()
Default empty constructor. |
|
GApplicationConfiguration(IGApplicationConfiguration appConfig)
Coping constructor. Note: it does not clone referred structures like ServerInfo ,
Options , etc. |
Method Summary | |
---|---|
GApplicationConfiguration |
clone()
|
protected java.lang.String |
contentToString()
This method is used from toString() to build
string representation of the internal content (configuration properties names and values). |
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. |
IGApplicationConfiguration.IGAppConnConfiguration |
getAppServer(CfgAppType type)
Overloaded method to select single connected application with specific application type. It searches for value in getAppServers() . |
java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> |
getAppServers()
Returns list of structures describing connected server applications. |
java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> |
getAppServers(CfgAppType type)
Overloaded method to select subset of connected applications with specific application type. It searches for values in getAppServers() . |
static java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> |
getAppServers(java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> allConnections,
CfgAppType type)
Utility method to select subset of connected applications with specific application type. |
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. |
static IGApplicationConfiguration.IGPortInfo |
getPortInfo(java.util.List<IGApplicationConfiguration.IGPortInfo> allPorts,
java.lang.String portId)
Utility method to select listening port configuration by specified port name (id). |
IGApplicationConfiguration.IGPortInfo |
getPortInfo(java.lang.String portId)
Overloaded method to select listening port configuration by specified port name (id). It searches for value in 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. |
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. |
void |
setApplicationName(java.lang.String appName)
Sets the application name. It represents the correspondent name in Genesys Configuration framework. |
void |
setApplicationType(CfgAppType appType)
Sets type of the application in terms of Genesys Configuration framework. |
void |
setAppServers(java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> appServers)
Sets list of structures describing connected server applications. |
void |
setDbid(java.lang.Integer dbid)
Sets unique application object identifier in terms of Genesys Configuration Database. |
void |
setFlexibleProperties(KeyValueCollection flexibleProperties)
Sets pointer to the list of additional properties. |
void |
setIsPrimary(java.lang.Boolean isPrimary)
Sets value meaning role of application within HA/redundancy group. |
void |
setIsServer(java.lang.Boolean isServer)
Sets indicator of whether this application can be a server to some other applications. |
void |
setObjectState(CfgObjectState objectState)
Sets actual object state in terms of Genesys Configuration Database. |
void |
setOptions(KeyValueCollection options)
Sets pointer to the list of application-specific configuration options. |
void |
setPortInfos(java.util.List<IGApplicationConfiguration.IGPortInfo> portInfos)
Sets pointer to the list of structures of type IGApplicationConfiguration.IGPortInfo containing information about listening ports for this server application. |
void |
setRedundancyType(CfgHAType redundancyType)
Sets the HA type if this application is considered as server. |
void |
setServerInfo(IGApplicationConfiguration.IGServerInfo serverInfo)
Sets structure with server type application specific properties. |
void |
setUserProperties(KeyValueCollection userProperties)
Sets pointer to the list of user-defined properties. It represents the "Annex" tab of the application object in CME. |
void |
setVersion(java.lang.String version)
Sets the application version. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public GApplicationConfiguration()
public GApplicationConfiguration(IGApplicationConfiguration appConfig)
ServerInfo
,
Options
, etc.
appConfig
- original configurationMethod Detail |
---|
public java.lang.String getApplicationName()
getApplicationName
in interface IGApplicationConfiguration
CfgApplication.getName()
public void setApplicationName(java.lang.String appName)
appName
- application nameCfgApplication.getName()
public CfgAppType getApplicationType()
getApplicationType
in interface IGApplicationConfiguration
CfgApplication.getType()
public void setApplicationType(CfgAppType appType)
appType
- application typeCfgApplication.getType()
public java.lang.Integer getDbid()
getDbid
in interface IGApplicationConfiguration
CfgApplication.getDBID()
public void setDbid(java.lang.Integer dbid)
dbid
- application DBIDCfgApplication.getDBID()
public CfgObjectState getObjectState()
getObjectState
in interface IGApplicationConfiguration
CfgApplication.getState()
public void setObjectState(CfgObjectState objectState)
objectState
- actual object stateCfgApplication.getState()
public java.lang.Boolean isServer()
getApplicationType()
.
isServer
in interface IGApplicationConfiguration
CfgApplication.getIsServer()
public void setIsServer(java.lang.Boolean isServer)
isServer
- the property valueCfgApplication.getIsServer()
public java.lang.Boolean isPrimary()
isPrimary
in interface IGApplicationConfiguration
CfgApplication.getIsPrimary()
public void setIsPrimary(java.lang.Boolean isPrimary)
isPrimary
- property value or nullCfgApplication.getIsPrimary()
public java.lang.String getVersion()
getVersion
in interface IGApplicationConfiguration
CfgApplication.getVersion()
public void setVersion(java.lang.String version)
version
- application versionCfgApplication.getVersion()
public IGApplicationConfiguration.IGServerInfo getServerInfo()
getServerInfo
in interface IGApplicationConfiguration
CfgApplication.getServerInfo()
,
CfgServer
public void setServerInfo(IGApplicationConfiguration.IGServerInfo serverInfo)
serverInfo
- server type specific application properties or nullCfgApplication.getServerInfo()
,
CfgServer
public java.util.List<IGApplicationConfiguration.IGPortInfo> getPortInfos()
IGApplicationConfiguration.IGPortInfo
containing information about listening ports for this server application.
getPortInfos
in interface IGApplicationConfiguration
CfgApplication.getPortInfos()
public IGApplicationConfiguration.IGPortInfo getPortInfo(java.lang.String portId)
getPortInfos()
.
portId
- listening port name (id) to look for
getPortInfos()
,
getPortInfo(List, String)
public static IGApplicationConfiguration.IGPortInfo getPortInfo(java.util.List<IGApplicationConfiguration.IGPortInfo> allPorts, java.lang.String portId)
allPorts
- list of port descriptions to select fromportId
- listening port name (id) to look for
public void setPortInfos(java.util.List<IGApplicationConfiguration.IGPortInfo> portInfos)
IGApplicationConfiguration.IGPortInfo
containing information about listening ports for this server application.
portInfos
- list of structures or nullCfgApplication.getPortInfos()
public CfgHAType getRedundancyType()
getRedundancyType
in interface IGApplicationConfiguration
CfgApplication.getRedundancyType()
public void setRedundancyType(CfgHAType redundancyType)
redundancyType
- application HA type or nullCfgApplication.getRedundancyType()
public java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> getAppServers()
getAppServers
in interface IGApplicationConfiguration
IGApplicationConfiguration.IGAppConnConfiguration
,
CfgApplication.getAppServers()
,
CfgConnInfo
public java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> getAppServers(CfgAppType type)
getAppServers()
.
type
- application type to look for
getAppServers()
public IGApplicationConfiguration.IGAppConnConfiguration getAppServer(CfgAppType type)
getAppServers()
.
type
- application type to look for
getAppServers()
public static java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> getAppServers(java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> allConnections, CfgAppType type)
allConnections
- list of applications connections to select fromtype
- application type to look for
public void setAppServers(java.util.List<IGApplicationConfiguration.IGAppConnConfiguration> appServers)
appServers
- list of structures or nullIGApplicationConfiguration.IGAppConnConfiguration
,
CfgApplication.getAppServers()
,
CfgConnInfo
public KeyValueCollection getOptions()
getOptions
in interface IGApplicationConfiguration
CfgApplication.getOptions()
public void setOptions(KeyValueCollection options)
options
- collection of options' sections or nullCfgApplication.getOptions()
public KeyValueCollection getUserProperties()
getUserProperties
in interface IGApplicationConfiguration
CfgApplication.getUserProperties()
public void setUserProperties(KeyValueCollection userProperties)
userProperties
- collection of properties sections or nullCfgApplication.getUserProperties()
public KeyValueCollection getFlexibleProperties()
getFlexibleProperties
in interface IGApplicationConfiguration
CfgApplication.getFlexibleProperties()
public void setFlexibleProperties(KeyValueCollection flexibleProperties)
flexibleProperties
- collection of additional properties or nullCfgApplication.getFlexibleProperties()
public GApplicationConfiguration clone()
clone
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
protected java.lang.String contentToString()
toString()
to build
string representation of the internal content (configuration properties names and values).
toString()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |