Platform SDK Java 8.5 API Reference

com.genesyslab.platform.commons.connection.configuration
Class AbstractConnectionConfiguration

java.lang.Object
  extended by com.genesyslab.platform.commons.connection.configuration.AbstractConnectionConfiguration
All Implemented Interfaces:
ClientADDPOptions, ClientConnectionOptions, ConnectionConfiguration, java.lang.Cloneable
Direct Known Subclasses:
KeyValueConfiguration, ManagedConfiguration, PropertyConfiguration

public abstract class AbstractConnectionConfiguration
extends java.lang.Object
implements ClientConnectionOptions, ConnectionConfiguration

AbstractConnectionConfiguration is an abstract class which implements common methods assuming that real container can hold only string values. It is used in all concrete implementations such as KeyValueConfiguration or PropertyConfiguration.

See Also:
KeyValueConfiguration, PropertyConfiguration

Nested Class Summary
 
Nested classes/interfaces inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientADDPOptions
ClientADDPOptions.AddpTraceMode
 
Field Summary
 
Fields inherited from interface com.genesyslab.platform.commons.connection.configuration.ClientConnectionOptions
IP_VERSION_4_6, IP_VERSION_6_4
 
Constructor Summary
AbstractConnectionConfiguration()
           
 
Method Summary
 ConnectionConfiguration clone()
           
 java.lang.Integer getAddpClientTimeout()
          Returns client side ADDP timeout value in seconds or null.
 java.lang.Integer getAddpServerTimeout()
          Returns server side ADDP timeout value in seconds or null.
 java.lang.String getAddpTrace()
          Deprecated.  
 ClientADDPOptions.AddpTraceMode getAddpTraceMode()
          Configuration option value for ADDP traces enabling in the client and server logs.
 boolean getBoolean(java.lang.String name)
          Returns boolean parameter value.
 boolean getBoolean(java.lang.String name, boolean defaultValue)
          Returns boolean parameter value.
 java.lang.Integer getInteger(java.lang.String name)
          Gets integer parameter value from the configuration.
 java.lang.Integer getInteger(java.lang.String name, java.lang.Integer defaultValue)
          Gets integer parameter value from the configuration.
 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 getOption(java.lang.String name)
          Gets string parameter value from the configuration.
 java.lang.String getStringsEncoding()
          Returns charset encoding name which represents encoding on the other side of the connection.
 java.lang.String getTLSVersion()
          Deprecated. 
 boolean isIPv6Enabled()
           
 boolean isTLSEnabled()
          Checks if a security protocol is enabled.
 boolean isUseAddp()
          Returns ADDP protocol enabling flag.
 void setAddpClientTimeout(java.lang.Integer timeout)
          Sets client side ADDP timeout value (in seconds).
 void setAddpServerTimeout(java.lang.Integer timeout)
          Sets server side ADDP timeout value (in seconds).
 void setAddpTrace(java.lang.String traceMode)
          Deprecated.  
 void setAddpTraceMode(ClientADDPOptions.AddpTraceMode traceMode)
          Configuration option value for ADDP traces enabling in the client and server logs.
 void setBoolean(java.lang.String name, boolean value)
          Sets boolean parameter in the configuration.
 void setInteger(java.lang.String name, java.lang.Integer value)
          Sets integer parameter in the configuration.
 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.
 void setTLSVersion(java.lang.String tlsVersion)
          Deprecated. 
 void setUseAddp(boolean useAddp)
          Sets ADDP protocol enabling flag.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.genesyslab.platform.commons.connection.configuration.ConnectionConfiguration
getOption, setOption
 

Constructor Detail

AbstractConnectionConfiguration

public AbstractConnectionConfiguration()
Method Detail

getOption

public java.lang.String getOption(java.lang.String name)
Gets string parameter value from the configuration. Default value is null.

Specified by:
getOption in interface ConnectionConfiguration
Parameters:
name - name (key) of the parameter
Returns:
value of the parameter or null if parameter is not found

getBoolean

public boolean getBoolean(java.lang.String name)
Returns boolean parameter value. Values that are considered 'true' are case insensitive: Their opposites (false, no, off) are false markers disregarding default value. All other values (incl. absence of value) are considered 'false'.

Specified by:
getBoolean in interface ConnectionConfiguration
Parameters:
name - name of an option
Returns:
boolean value of option

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean defaultValue)
Returns boolean parameter value. Values that are considered 'true' are case insensitive: Their opposites (false, no, off) are false markers disregarding default value. All other values (incl. absence of value) are considered 'false'.

Specified by:
getBoolean in interface ConnectionConfiguration
Parameters:
name - name of an option
defaultValue - value returned when there is no such option or option could not be parsed.
Returns:
boolean value of option

getInteger

public java.lang.Integer getInteger(java.lang.String name)
Gets integer parameter value from the configuration. Default value is null.

Specified by:
getInteger in interface ConnectionConfiguration
Parameters:
name - name (key) of the parameter
Returns:
value of the parameter or 0 if parameter is not found

getInteger

public java.lang.Integer getInteger(java.lang.String name,
                                    java.lang.Integer defaultValue)
Gets integer parameter value from the configuration.

Specified by:
getInteger in interface ConnectionConfiguration
Parameters:
name - name (key) of the parameter
defaultValue - value to return if parameter is not found
Returns:
value of the parameter

setBoolean

public void setBoolean(java.lang.String name,
                       boolean value)
Sets boolean parameter in the configuration.

Specified by:
setBoolean in interface ConnectionConfiguration
Parameters:
name - name (key) of the parameter
value - boolean value to set

setInteger

public void setInteger(java.lang.String name,
                       java.lang.Integer value)
Sets integer parameter in the configuration.

Specified by:
setInteger in interface ConnectionConfiguration
Parameters:
name - name (key) of the parameter
value - integer value to set

clone

public ConnectionConfiguration clone()
                              throws java.lang.CloneNotSupportedException
Specified by:
clone in interface ConnectionConfiguration
Overrides:
clone in class java.lang.Object
Throws:
java.lang.CloneNotSupportedException

setStringsEncoding

public void setStringsEncoding(java.lang.String stringsEncoding)
Description copied from interface: ClientConnectionOptions
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.

Specified by:
setStringsEncoding in interface ClientConnectionOptions
Parameters:
stringsEncoding - server side charset encoding or null

getStringsEncoding

public java.lang.String getStringsEncoding()
Description copied from interface: ClientConnectionOptions
Returns charset encoding name which represents encoding on the other side of the connection.

Specified by:
getStringsEncoding in interface ClientConnectionOptions
Returns:
server side charset encoding or null

setLocalBindingHost

public void setLocalBindingHost(java.lang.String localBindingHost)
Description copied from interface: ClientConnectionOptions
Sets hostname or network interface to be used for client socket local binding.

Specified by:
setLocalBindingHost in interface ClientConnectionOptions
Parameters:
localBindingHost - local binding host for client protocol connection or null

getLocalBindingHost

public java.lang.String getLocalBindingHost()
Description copied from interface: ClientConnectionOptions
Returns hostname or network interface to be used for client socket local binding.

Specified by:
getLocalBindingHost in interface ClientConnectionOptions
Returns:
local binding host for client protocol connection or null

setLocalBindingPort

public void setLocalBindingPort(java.lang.Integer localBindingPort)
Description copied from interface: ClientConnectionOptions
Sets TCP/IP port to be used for client socket local binding.

Specified by:
setLocalBindingPort in interface ClientConnectionOptions
Parameters:
localBindingPort - local binding port for client protocol connection or null

getLocalBindingPort

public java.lang.Integer getLocalBindingPort()
Description copied from interface: ClientConnectionOptions
Returns TCP/IP port to be used for client socket local binding.

Specified by:
getLocalBindingPort in interface ClientConnectionOptions
Returns:
local binding port for client protocol connection or null

setIPv6Enabled

public void setIPv6Enabled(boolean enableIPv6)
Specified by:
setIPv6Enabled in interface ClientConnectionOptions

isIPv6Enabled

public boolean isIPv6Enabled()
Specified by:
isIPv6Enabled in interface ClientConnectionOptions

setIPVersion

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

Specified by:
setIPVersion in interface ClientConnectionOptions
Parameters:
ipVersion - IP versions order
See Also:
ClientConnectionOptions.IP_VERSION_4_6, ClientConnectionOptions.IP_VERSION_6_4

getIPVersion

public java.lang.String getIPVersion()
Specified by:
getIPVersion in interface ClientConnectionOptions

setUseAddp

public void setUseAddp(boolean useAddp)
Description copied from interface: ClientADDPOptions
Sets ADDP protocol enabling flag.

Specified by:
setUseAddp in interface ClientADDPOptions
Parameters:
useAddp - ADDP enabling flag

isUseAddp

public boolean isUseAddp()
Description copied from interface: ClientADDPOptions
Returns ADDP protocol enabling flag.

Specified by:
isUseAddp in interface ClientADDPOptions
Returns:
true if ADDP should be enabled

setAddpClientTimeout

public void setAddpClientTimeout(java.lang.Integer timeout)
Description copied from interface: ClientADDPOptions
Sets client side ADDP timeout value (in seconds).

Specified by:
setAddpClientTimeout in interface ClientADDPOptions
Parameters:
timeout - client side timeout (seconds)
See Also:
ClientADDPOptions.setUseAddp(boolean), ClientADDPOptions.setAddpTraceMode(AddpTraceMode)

getAddpClientTimeout

public java.lang.Integer getAddpClientTimeout()
Description copied from interface: ClientADDPOptions
Returns client side ADDP timeout value in seconds or null.

Specified by:
getAddpClientTimeout in interface ClientADDPOptions
Returns:
client side timeout (seconds)
See Also:
ClientADDPOptions.setUseAddp(boolean)

setAddpServerTimeout

public void setAddpServerTimeout(java.lang.Integer timeout)
Description copied from interface: ClientADDPOptions
Sets server side ADDP timeout value (in seconds).

Specified by:
setAddpServerTimeout in interface ClientADDPOptions
Parameters:
timeout - server side timeout (seconds)
See Also:
ClientADDPOptions.setUseAddp(boolean), ClientADDPOptions.setAddpTraceMode(AddpTraceMode)

getAddpServerTimeout

public java.lang.Integer getAddpServerTimeout()
Description copied from interface: ClientADDPOptions
Returns server side ADDP timeout value in seconds or null.

Specified by:
getAddpServerTimeout in interface ClientADDPOptions
Returns:
server side timeout (seconds) or null
See Also:
ClientADDPOptions.isUseAddp()

setAddpTrace

@Deprecated
public void setAddpTrace(java.lang.String traceMode)
Deprecated. 

Sets configuration option value for ADDP traces enabling in the client and server logs.
Values mean:

Specified by:
setAddpTrace in interface ClientADDPOptions
Parameters:
traceMode - ADDP tracing option value
See Also:
setUseAddp(boolean), ClientADDPOptions.setAddpTraceMode(AddpTraceMode)

getAddpTrace

@Deprecated
public java.lang.String getAddpTrace()
Deprecated. 

Returns configuration option value for ADDP traces enabling in the client and server logs.

Specified by:
getAddpTrace in interface ClientADDPOptions
Returns:
ADDP tracing option value
See Also:
setAddpTrace(String), getAddpTraceMode()

setAddpTraceMode

public void setAddpTraceMode(ClientADDPOptions.AddpTraceMode traceMode)
Configuration option value for ADDP traces enabling in the client and server logs.

Specified by:
setAddpTraceMode in interface ClientADDPOptions
Parameters:
traceMode - ADDP trace mode property value
See Also:
setUseAddp(boolean)

getAddpTraceMode

public ClientADDPOptions.AddpTraceMode getAddpTraceMode()
Configuration option value for ADDP traces enabling in the client and server logs.

Specified by:
getAddpTraceMode in interface ClientADDPOptions
Returns:
ADDP trace mode property value
See Also:
ClientADDPOptions.setAddpTraceMode(AddpTraceMode)

setTLSEnabled

public void setTLSEnabled(boolean enabled)
Description copied from interface: ClientConnectionOptions
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.

Specified by:
setTLSEnabled in interface ClientConnectionOptions
Parameters:
enabled - "TLS enabled" flag

isTLSEnabled

public boolean isTLSEnabled()
Description copied from interface: ClientConnectionOptions
Checks if a security protocol is enabled.

Specified by:
isTLSEnabled in interface ClientConnectionOptions
Returns:
true if a security protocol is enabled.

getTLSVersion

@Deprecated
public java.lang.String getTLSVersion()
Deprecated. 


setTLSVersion

@Deprecated
public void setTLSVersion(java.lang.String tlsVersion)
Deprecated. 


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.