Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.connection.tls
Class TLSConfigurationParser

java.lang.Object
  extended by com.genesyslab.platform.commons.connection.tls.TLSConfigurationParser

public class TLSConfigurationParser
extends java.lang.Object

Utility class that helps extract TLS options from configuration objects and prepare TLSConfiguration that can be applied to configure secure connectivity in protocol instances.


Constructor Summary
TLSConfigurationParser()
           
 
Method Summary
static TLSConfiguration parseClientTlsConfiguration(KVList kvl)
          Helper method that extracts client-side TLS options from KVList object and parses them.
static TLSConfiguration parseClientTlsConfiguration(java.util.Map<java.lang.String,java.lang.String> map)
          Helper method that extracts client-side TLS options from Map object and parses them.
static TLSConfiguration parseClientTlsConfiguration(java.util.Properties prop)
          Helper method that extracts client-side TLS options from Properties object and parses them.
static TLSConfiguration parseClientTlsConfiguration(java.lang.String transportParams)
          Helper method that extracts client-side TLS options from String object containing Transport Parameters received from Configuration Server; and parses them.
static TLSConfiguration parseServerTlsConfiguration(KVList kvl)
          Helper method that extracts server-side TLS options from KVList object and parses them.
static TLSConfiguration parseServerTlsConfiguration(java.util.Map<java.lang.String,java.lang.String> map)
          Helper method that extracts server-side TLS options from Map object and parses them.
static TLSConfiguration parseServerTlsConfiguration(java.util.Properties prop)
          Helper method that extracts server-side TLS options from Properties object and parses them.
static TLSConfiguration parseServerTlsConfiguration(java.lang.String transportParams)
          Helper method that extracts server-side TLS options from String object containing Transport Parameters received from Configuration Server; and parses them.
static TLSConfiguration parseTlsConfiguration(PropertyReader prop, boolean clientMode)
          Creates a new instance of TLSConfiguration, searches source of configuration information represented by PropertyReader instance for TLS-related options, fills TLSConfiguration instance fields and returns it.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TLSConfigurationParser

public TLSConfigurationParser()
Method Detail

parseServerTlsConfiguration

public static TLSConfiguration parseServerTlsConfiguration(KVList kvl)
Helper method that extracts server-side TLS options from KVList object and parses them.

Parameters:
kvl - TLS options source
Returns:
Filled TLSConfiguration instance.

parseClientTlsConfiguration

public static TLSConfiguration parseClientTlsConfiguration(KVList kvl)
Helper method that extracts client-side TLS options from KVList object and parses them.

Parameters:
kvl - TLS options source
Returns:
Filled TLSConfiguration instance.

parseServerTlsConfiguration

public static TLSConfiguration parseServerTlsConfiguration(java.util.Map<java.lang.String,java.lang.String> map)
Helper method that extracts server-side TLS options from Map object and parses them.

Parameters:
map - TLS options source
Returns:
Filled TLSConfiguration instance.

parseClientTlsConfiguration

public static TLSConfiguration parseClientTlsConfiguration(java.util.Map<java.lang.String,java.lang.String> map)
Helper method that extracts client-side TLS options from Map object and parses them.

Parameters:
map - TLS options source
Returns:
Filled TLSConfiguration instance.

parseServerTlsConfiguration

public static TLSConfiguration parseServerTlsConfiguration(java.util.Properties prop)
Helper method that extracts server-side TLS options from Properties object and parses them.

Parameters:
prop - TLS options source
Returns:
Filled TLSConfiguration instance.

parseClientTlsConfiguration

public static TLSConfiguration parseClientTlsConfiguration(java.util.Properties prop)
Helper method that extracts client-side TLS options from Properties object and parses them.

Parameters:
prop - TLS options source
Returns:
Filled TLSConfiguration instance.

parseServerTlsConfiguration

public static TLSConfiguration parseServerTlsConfiguration(java.lang.String transportParams)
Helper method that extracts server-side TLS options from String object containing Transport Parameters received from Configuration Server; and parses them.

Parameters:
transportParams - TLS options source
Returns:
Filled TLSConfiguration instance.

parseClientTlsConfiguration

public static TLSConfiguration parseClientTlsConfiguration(java.lang.String transportParams)
Helper method that extracts client-side TLS options from String object containing Transport Parameters received from Configuration Server; and parses them.

Parameters:
transportParams - TLS options source
Returns:
Filled TLSConfiguration instance.

parseTlsConfiguration

public static TLSConfiguration parseTlsConfiguration(PropertyReader prop,
                                                     boolean clientMode)

Creates a new instance of TLSConfiguration, searches source of configuration information represented by PropertyReader instance for TLS-related options, fills TLSConfiguration instance fields and returns it.

Example:

 KVList kvl = new KeyValueCollection();
 kvl.addObject("tls", "1");
 kvl.addObject("tls-mutual", "1");
 PropertyReader reader = new KVListPropertyReader(kvl);

 TLSConnectionConfiguration tlsConfiguration =
         TLSConfigurationParser.parseTlsConfiguration(reader, true);
 

Parameters:
prop - PropertyReader to get TLS parameters from
clientMode - Specify true to parse options for client applications and false for server applications.

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.