Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Class GConfigPropertyReader

java.lang.Object
  extended by com.genesyslab.platform.apptemplate.configuration.GConfigPropertyReader
All Implemented Interfaces:
PropertyReader
Direct Known Subclasses:
GConfigTlsPropertyReader

public class GConfigPropertyReader
extends java.lang.Object
implements PropertyReader

Property reader that extracts option values from configuration objects. It is intended to be used together with TLSConfigurationParser.

See Also:
TLSConfigurationParser

Field Summary
protected  IGApplicationConfiguration appConfig
           
protected  IGApplicationConfiguration.IGAppConnConfiguration connConfig
           
protected  IGApplicationConfiguration.IGHost hostConfig
           
protected  IGApplicationConfiguration.IGPortInfo portConfig
           
 
Constructor Summary
GConfigPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGAppConnConfiguration connConfig, IGApplicationConfiguration targetServerConfig, java.lang.String defaultSectionName)
          Creates configuration reader for client application.
GConfigPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGAppConnConfiguration connConfig, java.lang.String defaultSectionName)
          Creates configuration reader for client application.
GConfigPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGPortInfo portConfig, java.lang.String defaultSectionName)
          Creates configuration reader for server application.
 
Method Summary
static java.lang.String findSectionOption(java.lang.String optionName, java.lang.String sectionName, KeyValueCollection options)
          First, looks into options for an entry with given section name and value of type KeyValueCollection.
static java.lang.String getAppAnnexOption(java.lang.String optionName, java.lang.String sectionName, IGApplicationConfiguration appConfig)
           
static java.lang.String getAppOption(java.lang.String optionName, java.lang.String sectionName, IGApplicationConfiguration appConfig)
           
static java.lang.String getConnOption(java.lang.String optionName, IGApplicationConfiguration.IGAppConnConfiguration connConfig)
           
static java.lang.String getHostAnnexOption(java.lang.String optionName, java.lang.String sectionName, IGApplicationConfiguration.IGHost hostConfig)
           
static java.lang.String getPortOption(java.lang.String optionName, IGApplicationConfiguration.IGPortInfo portConfig)
           
 java.lang.String getProperty(com.genesyslab.platform.apptemplate.configuration.OptionDescription optionDescription)
           
 java.lang.String getProperty(java.lang.String optionName)
          Combined code for both client and server cases.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

appConfig

protected IGApplicationConfiguration appConfig

portConfig

protected IGApplicationConfiguration.IGPortInfo portConfig

connConfig

protected IGApplicationConfiguration.IGAppConnConfiguration connConfig

hostConfig

protected IGApplicationConfiguration.IGHost hostConfig
Constructor Detail

GConfigPropertyReader

public GConfigPropertyReader(IGApplicationConfiguration appConfig,
                             IGApplicationConfiguration.IGPortInfo portConfig,
                             java.lang.String defaultSectionName)
Creates configuration reader for server application. Host configuration object is taken from Application object property.

Parameters:
appConfig - Server Application configuration object
portConfig - Port configuration object
defaultSectionName - Name of section to look into for options, must not be null, can be empty string

GConfigPropertyReader

public GConfigPropertyReader(IGApplicationConfiguration appConfig,
                             IGApplicationConfiguration.IGAppConnConfiguration connConfig,
                             java.lang.String defaultSectionName)
Creates configuration reader for client application.

Parameters:
appConfig - Client Application configuration object
connConfig - Connection configuration object, which connects Client to target Server
defaultSectionName - Name of section to look into for options, must not be null, can be empty string

GConfigPropertyReader

public GConfigPropertyReader(IGApplicationConfiguration appConfig,
                             IGApplicationConfiguration.IGAppConnConfiguration connConfig,
                             IGApplicationConfiguration targetServerConfig,
                             java.lang.String defaultSectionName)
Creates configuration reader for client application.

Parameters:
appConfig - Client Application configuration object
connConfig - Connection configuration object, which connects Client to target Server
targetServerConfig - Target server configuration.
defaultSectionName - Name of section to look into for options, must not be null, can be empty string
Method Detail

getProperty

public java.lang.String getProperty(java.lang.String optionName)
Combined code for both client and server cases. For client, it is expected that only connConfig and appConfig are non-null; for server, only portConfig, appConfig and hostConfig.

Specified by:
getProperty in interface PropertyReader
Parameters:
optionName - Name of option to find in the specified configuration objects
Returns:
Option value

getProperty

public java.lang.String getProperty(com.genesyslab.platform.apptemplate.configuration.OptionDescription optionDescription)

findSectionOption

public static java.lang.String findSectionOption(java.lang.String optionName,
                                                 java.lang.String sectionName,
                                                 KeyValueCollection options)
First, looks into options for an entry with given section name and value of type KeyValueCollection. Then looks in that collection for an entry with name specified in optionName and returns value from the entry.

Parameters:
optionName - Name of option to find
options - KeyValueCollection containing specific section with options
Returns:
Value for the specified option

getPortOption

public static java.lang.String getPortOption(java.lang.String optionName,
                                             IGApplicationConfiguration.IGPortInfo portConfig)

getConnOption

public static java.lang.String getConnOption(java.lang.String optionName,
                                             IGApplicationConfiguration.IGAppConnConfiguration connConfig)

getAppOption

public static java.lang.String getAppOption(java.lang.String optionName,
                                            java.lang.String sectionName,
                                            IGApplicationConfiguration appConfig)

getAppAnnexOption

public static java.lang.String getAppAnnexOption(java.lang.String optionName,
                                                 java.lang.String sectionName,
                                                 IGApplicationConfiguration appConfig)

getHostAnnexOption

public static java.lang.String getHostAnnexOption(java.lang.String optionName,
                                                  java.lang.String sectionName,
                                                  IGApplicationConfiguration.IGHost hostConfig)

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.