Configuration Platform SDK 7.6 API Reference

com.genesyslab.platform.commons.connection
Interface ConnectionConfiguration

All Known Implementing Classes:
AbstractConnectionConfiguration, FileConfiguration, KeyValueConfiguration

public interface ConnectionConfiguration

ConnectionConfiguration allows you to configure any specific options used in communication with the server. This interface is similar to a collection of String, boolean, and Integer values.


Method Summary
 boolean getBoolean(java.lang.String name)
          Get boolean parameter from the config.
 boolean getBoolean(java.lang.String name, boolean defaultValue)
          Get boolean parameter from the config.
 java.lang.Integer getInteger(java.lang.String name)
          Get integer parameter from the config.
 java.lang.Integer getInteger(java.lang.String name, java.lang.Integer defaultValue)
          Get integer parameter from the config.
 java.lang.String getOption(java.lang.String name)
          Get string parameter from the configuration.
 java.lang.String getOption(java.lang.String name, java.lang.String defaultValue)
          Get string parameter from the configuration.
 void setBoolean(java.lang.String name, boolean value)
          Set boolean parameter into config.
 void setInteger(java.lang.String name, java.lang.Integer value)
          Set integer parameter into config.
 void setOption(java.lang.String name, java.lang.String value)
          Set string parameter into config.
 

Method Detail

getOption

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

Parameters:
name - name (key) of the parameter
Returns:
value of the parameter or null if parameter is not found

getOption

public java.lang.String getOption(java.lang.String name,
                                  java.lang.String defaultValue)
Get string parameter from the configuration.

Parameters:
name - name (key) of the parameter
defaultValue - value to return if parameter is not found
Returns:
value of the parameter

setOption

public void setOption(java.lang.String name,
                      java.lang.String value)
Set string parameter into config.

Parameters:
name - name (key) of the parameter
value - string value to set

getBoolean

public boolean getBoolean(java.lang.String name)
Get boolean parameter from the config. Default value is false.

Parameters:
name - name (key) of the parameter
Returns:
value of the parameter or false if parameter is not found

getBoolean

public boolean getBoolean(java.lang.String name,
                          boolean defaultValue)
Get boolean parameter from the config.

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)
Set boolean parameter into config.

Parameters:
name - name (key) of the parameter
value - bool value to set

getInteger

public java.lang.Integer getInteger(java.lang.String name)
Get integer parameter from the config. Default value is 0.

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)
Get integer parameter from the config.

Parameters:
name - name (key) of the parameter
defaultValue - value to return if parameter is not found
Returns:
value of the parameter

setInteger

public void setInteger(java.lang.String name,
                       java.lang.Integer value)
Set integer parameter into config.

Parameters:
name - name (key) of the parameter
value - int value to set

Configuration Platform SDK 7.6 API Reference

Send comments on this topic.
Copyright © 2006–2008 Genesys Telecommunication Laboratories, Inc. All rights reserved.