Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.connection.configuration
Interface ClientConnectionOptions

All Superinterfaces:
ClientADDPOptions
All Known Implementing Classes:
AbstractConnectionConfiguration, KeyValueConfiguration, ManagedConfiguration, PropertyConfiguration

public interface ClientConnectionOptions
extends ClientADDPOptions

Base interface defining common connection configuration properties for single connection target. It represents set of typified properties which are implemented by and stored inside of AbstractConnectionConfiguration structure.

See Also:
AbstractConnectionConfiguration, PropertyConfiguration, KeyValueConfiguration

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientADDPOptions
ClientADDPOptions.AddpTraceMode
 
Field Summary
static java.lang.String IP_VERSION_4_6
           
static java.lang.String IP_VERSION_6_4
           
 
Method Summary
 java.lang.String getIPVersion()
           
 java.lang.String getLocalBindingHost()
          Returns hostname or network interface to be used for client socket local binding.
 java.lang.Integer getLocalBindingPort()
          Returns TCP/IP port to be used for client socket local binding.
 java.lang.String getStringsEncoding()
          Returns charset encoding name which represents encoding on the other side of the connection.
 boolean isIPv6Enabled()
           
 boolean isTLSEnabled()
          Checks if a security protocol is enabled.
 void setIPv6Enabled(boolean enableIPv6)
           
 void setIPVersion(java.lang.String ipVersion)
          Sets IP version selection order for address resolution.
 void setLocalBindingHost(java.lang.String localBindingHost)
          Sets hostname or network interface to be used for client socket local binding.
 void setLocalBindingPort(java.lang.Integer localBindingPort)
          Sets TCP/IP port to be used for client socket local binding.
 void setStringsEncoding(java.lang.String stringsEncoding)
          Sets charset encoding name which represents encoding on the other side of the connection.
 void setTLSEnabled(boolean enabled)
          Sets "TLS enabled" flag.
 
Methods inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientADDPOptions
getAddpClientTimeout, getAddpServerTimeout, getAddpTrace, getAddpTraceMode, isUseAddp, setAddpClientTimeout, setAddpServerTimeout, setAddpTrace, setAddpTraceMode, setUseAddp
 

Field Detail

IP_VERSION_4_6

static final java.lang.String IP_VERSION_4_6
See Also:
Constant Field Values

IP_VERSION_6_4

static final java.lang.String IP_VERSION_6_4
See Also:
Constant Field Values
Method Detail

setStringsEncoding

void setStringsEncoding(java.lang.String stringsEncoding)
Sets charset encoding name which represents encoding on the other side of the connection.

It should be used in case when client and server side hosts/applications use different encodings or have different regional settings.

Default value null means that client and server use the same encoding.

Parameters:
stringsEncoding - server side charset encoding or null

getStringsEncoding

java.lang.String getStringsEncoding()
Returns charset encoding name which represents encoding on the other side of the connection.

Returns:
server side charset encoding or null

setLocalBindingHost

void setLocalBindingHost(java.lang.String localBindingHost)
Sets hostname or network interface to be used for client socket local binding.

Parameters:
localBindingHost - local binding host for client protocol connection or null

getLocalBindingHost

java.lang.String getLocalBindingHost()
Returns hostname or network interface to be used for client socket local binding.

Returns:
local binding host for client protocol connection or null

setLocalBindingPort

void setLocalBindingPort(java.lang.Integer localBindingPort)
Sets TCP/IP port to be used for client socket local binding.

Parameters:
localBindingPort - local binding port for client protocol connection or null

getLocalBindingPort

java.lang.Integer getLocalBindingPort()
Returns TCP/IP port to be used for client socket local binding.

Returns:
local binding port for client protocol connection or null

setIPv6Enabled

void setIPv6Enabled(boolean enableIPv6)

isIPv6Enabled

boolean isIPv6Enabled()

setIPVersion

void setIPVersion(java.lang.String ipVersion)
Sets IP version selection order for address resolution. Possible values are: "4,6" or "6,4".

Parameters:
ipVersion - IP versions order
See Also:
IP_VERSION_4_6, IP_VERSION_6_4

getIPVersion

java.lang.String getIPVersion()

setTLSEnabled

void setTLSEnabled(boolean enabled)
Sets "TLS enabled" flag. When set to true, this flag will indicate need to start TLS immediately, when set to false, TLS initialization will be performed only by request from protocol.

Parameters:
enabled - "TLS enabled" flag

isTLSEnabled

boolean isTLSEnabled()
Checks if a security protocol is enabled.

Returns:
true if a security protocol is enabled.

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.