Platform SDK Java 8.5 API Reference

com.genesyslab.platform.apptemplate.configuration
Class GConfigTlsPropertyReader

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

public class GConfigTlsPropertyReader
extends GConfigPropertyReader

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

Searches application, host, and port or connection objects for TLS-related options and provides values to TLSConfigurationParser.

Section names, option names and specific values are taken from Genesys 8.0 Security Deployment Guide

Example for server side:

 String appName = "<my-app-name>";
 CfgApplication cfgApplication = confService.retrieveObject(
         CfgApplication.class, new CfgApplicationQuery(appName));
 GCOMApplicationConfiguration appConfiguration =
         new GCOMApplicationConfiguration(cfgApplication);
 IGApplicationConfiguration.IGPortInfo portConfig =
         appConfiguration.getPortInfo("secure");
 TLSConfiguration tlsConfiguration = TLSConfigurationParser.parseTlsConfiguration(
         new GConfigTlsPropertyReader(appConfiguration, portConfig), false);
 

Example for client side:

 String appName = "<my-app-name>";
 CfgApplication cfgApplication = confService.retrieveObject(
         CfgApplication.class, new CfgApplicationQuery(appName));
 GCOMApplicationConfiguration appConfiguration =
         new GCOMApplicationConfiguration(cfgApplication);
 IGApplicationConfiguration.IGAppConnConfiguration connConfig =
         appConfiguration.getAppServer(CfgAppType.CFGTServer);
 TLSConfiguration tlsConfiguration = TLSConfigurationParser.parseTlsConfiguration(
         new GConfigTlsPropertyReader(appConfiguration, connConfig), true);
 

See Also:
TLSConfigurationParser

Field Summary
 
Fields inherited from class com.genesyslab.platform.apptemplate.configuration.GConfigPropertyReader
appConfig, connConfig, hostConfig, portConfig
 
Constructor Summary
GConfigTlsPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGAppConnConfiguration connConfig)
          Creates configuration reader for client application.
GConfigTlsPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGAppConnConfiguration connConfig, IGApplicationConfiguration targetServerConfig)
          Creates configuration reader for client application.
GConfigTlsPropertyReader(IGApplicationConfiguration appConfig, IGApplicationConfiguration.IGPortInfo portConfig)
          Creates configuration reader for server application.
 
Method Summary
 java.lang.String getProperty(java.lang.String optionName)
          Combined code for both client and server cases.
 
Methods inherited from class com.genesyslab.platform.apptemplate.configuration.GConfigPropertyReader
findSectionOption, getAppAnnexOption, getAppOption, getConnOption, getHostAnnexOption, getPortOption, getProperty
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GConfigTlsPropertyReader

public GConfigTlsPropertyReader(IGApplicationConfiguration appConfig,
                                IGApplicationConfiguration.IGPortInfo portConfig)
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

GConfigTlsPropertyReader

public GConfigTlsPropertyReader(IGApplicationConfiguration appConfig,
                                IGApplicationConfiguration.IGAppConnConfiguration connConfig)
Creates configuration reader for client application. Host configuration object, if available, is taken from Application object property.

Parameters:
appConfig - Client Application configuration object
connConfig - Connection configuration object, which connects Client to target Server

GConfigTlsPropertyReader

public GConfigTlsPropertyReader(IGApplicationConfiguration appConfig,
                                IGApplicationConfiguration.IGAppConnConfiguration connConfig,
                                IGApplicationConfiguration targetServerConfig)
Creates configuration reader for client application. Host configuration object, if available, is taken from Application object property.

Parameters:
appConfig - Client Application configuration object
connConfig - Connection configuration object, which connects Client to target Server
targetServerConfig - Target server configuration.
Method Detail

getProperty

public java.lang.String getProperty(java.lang.String optionName)
Description copied from class: GConfigPropertyReader
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
Overrides:
getProperty in class GConfigPropertyReader
Parameters:
optionName - Name of option to find in the specified configuration objects
Returns:
Option value

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.