quickfix

Class SessionSettings

java.lang.Object

quickfix.SessionSettings

public class SessionSettings
extends Object

Settings for sessions. Settings are grouped by FIX version and target company ID. There is also a default settings section that is inherited by the session-specific sections. Setting constants are declared in the classes using the settings. To find the string constants, navigate to the class constant for the setting, select the link for the setting and then and select the "Constant Field Values" link in the detailed field description.

See Also:

Acceptor, Initiator, FileLogFactory, ScreenLogFactory, FileStoreFactory, JdbcSetting, Session, DefaultSessionFactory

Field Summary

Fields

Modifier and Type	Field and Description
static String	BEGINSTRING
static String	SENDERCOMPID
static String	SENDERLOCID
static String	SENDERSUBID
static String	SESSION_QUALIFIER
static String	TARGETCOMPID
static String	TARGETLOCID
static String	TARGETSUBID

Constructor Summary

Constructors

Constructor and Description
SessionSettings() Creates an empty session settings object.
SessionSettings(InputStream stream) Loads session settings from an input stream.
SessionSettings(InputStream stream, Properties variableValues) Loads session settings from an input stream with custom source of variable values in the settings.
SessionSettings(List<String> listValues) Loads session settings from a list of strings.
SessionSettings(List<String> listValues, Properties variableValues) Loads session settings from a list of strings with custom source of variable values in the settings.
SessionSettings(Properties variableValues) Creates an empty session settings object with custom source of variable values in the settings.
SessionSettings(String filename) Loads session settings from a file.
SessionSettings(String filename, Properties variableValues) Loads session settings from a file with custom source of variable values in the settings.

Method Summary

Modifier and Type	Method and Description
Dictionary	get()
Dictionary	get(SessionID sessionID)
boolean	getBool(SessionID sessionID, String key) Get a settings value as a boolean value.
boolean	getBool(String key) Gets a boolean value from the default section of the settings.
Properties	getDefaultProperties() Returns the defaults for the session-level settings.
double	getDouble(SessionID sessionID, String key) Get a settings value as a double number.
double	getDouble(String key) Gets a double value from the default section of the settings.
int	getInt(SessionID sessionID, String key) Get a settings value as an integer.
int	getInt(String key) Gets an int from the default section of settings.
long	getLong(SessionID sessionID, String key) Get a settings value as a long integer.
long	getLong(String key) Gets a long from the default section of settings.
Properties	getSessionProperties(SessionID sessionID) Return the settings for a session as a Properties object.
Properties	getSessionProperties(SessionID sessionID, boolean includeDefaults) Return the settings for a session as a Properties object.
String	getString(SessionID sessionID, String key) Get a settings string.
String	getString(String key) Gets a string from the default section of the settings.
boolean	isSetting(SessionID sessionID, String key) Predicate for determining if a setting exists.
boolean	isSetting(String key) Predicate for determining if a setting is in the default section.
static Set<InetAddress>	parseRemoteAddresses(String raw)
static int[]	parseSettingReconnectInterval(String raw)
void	removeSetting(SessionID sessionID, String key)
Iterator<SessionID>	sectionIterator()
void	set(Dictionary dictionary)
void	set(Map<Object,Object> defaults) Adds defaults to the settings.
void	set(SessionID sessionID, Dictionary dictionary)
void	setBool(SessionID sessionID, String key, boolean value) Sets a boolean-valued session setting.
void	setBool(String key, boolean value) Set a default boolean parameter.
void	setDouble(SessionID sessionID, String key, double value) Sets a double-valued session setting.
void	setDouble(String key, double value) Set a default double parameter.
void	setLong(SessionID sessionID, String key, long value) Sets a long integer-valued session setting.
void	setLong(String key, long value) Set a default long parameter.
void	setString(SessionID sessionID, String key, String value) Sets a string-valued session setting.
void	setString(String key, String value) Set a default string parameter.
void	setVariableValues(Properties variableValues) Set properties that will be the source of variable values in the settings.
int	size()
void	toStream(OutputStream out)
String	toString()
void	toString(PrintWriter writer)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BEGINSTRING

public static final String BEGINSTRING

See Also:

Constant Field Values

SENDERCOMPID

public static final String SENDERCOMPID

See Also:

Constant Field Values

SENDERSUBID

public static final String SENDERSUBID

See Also:

Constant Field Values

SENDERLOCID

public static final String SENDERLOCID

See Also:

Constant Field Values

TARGETCOMPID

public static final String TARGETCOMPID

See Also:

Constant Field Values

TARGETSUBID

public static final String TARGETSUBID

See Also:

Constant Field Values

TARGETLOCID

public static final String TARGETLOCID

See Also:

Constant Field Values

SESSION_QUALIFIER

public static final String SESSION_QUALIFIER

See Also:

Constant Field Values

Constructor Detail

SessionSettings

public SessionSettings()

Creates an empty session settings object.

SessionSettings

public SessionSettings(Properties variableValues)

Creates an empty session settings object with custom source of variable values in the settings.

Parameters:

variableValues - custom source of variable values in the settings

SessionSettings

public SessionSettings(String filename,
                       Properties variableValues)
                throws ConfigError

Loads session settings from a file with custom source of variable values in the settings.

Parameters:

filename - the path to the file containing the session settings

variableValues - custom source of variable values in the settings

Throws:

ConfigError - when file could not be loaded

SessionSettings

public SessionSettings(String filename)
                throws ConfigError

Loads session settings from a file.

Parameters:

filename - the path to the file containing the session settings

Throws:

ConfigError - when file could not be loaded

SessionSettings

public SessionSettings(InputStream stream)
                throws ConfigError

Loads session settings from an input stream.

Parameters:

stream - the input stream

Throws:

ConfigError

SessionSettings

public SessionSettings(InputStream stream,
                       Properties variableValues)
                throws ConfigError

Loads session settings from an input stream with custom source of variable values in the settings.

Parameters:

stream - the input stream

variableValues - custom source of variable values in the settings

Throws:

ConfigError

SessionSettings

public SessionSettings(List<String> listValues)
                throws ConfigError

Loads session settings from a list of strings.

Parameters:

listValues - the list of strings

Throws:

ConfigError

SessionSettings

public SessionSettings(List<String> listValues,
                       Properties variableValues)
                throws ConfigError

Loads session settings from a list of strings with custom source of variable values in the settings.

Parameters:

listValues - the list of strings

variableValues - custom source of variable values in the settings

Throws:

ConfigError

Method Detail

getString

public String getString(String key)
                 throws ConfigError

Gets a string from the default section of the settings.

Parameters:

key -

Returns:

the default string value

Throws:

ConfigError

getString

public String getString(SessionID sessionID,
                        String key)
                 throws ConfigError

Get a settings string.

Parameters:

sessionID - the session ID

key - the settings key

Returns:

the string value for the setting

Throws:

ConfigError - configuration error, probably a missing setting.

getSessionProperties

public Properties getSessionProperties(SessionID sessionID,
                                       boolean includeDefaults)
                                throws ConfigError

Return the settings for a session as a Properties object.

Parameters:

sessionID -

includeDefaults - if true, include settings defaults in properties

Returns:

the Properties object with the session settings

Throws:

ConfigError

See Also:

Properties

getSessionProperties

public Properties getSessionProperties(SessionID sessionID)
                                throws ConfigError

Return the settings for a session as a Properties object.

Parameters:

sessionID -

Returns:

the Properties object with the session settings

Throws:

ConfigError

See Also:

Properties

getDefaultProperties

public Properties getDefaultProperties()

Returns the defaults for the session-level settings.

Returns:

the default properties

getLong

public long getLong(String key)
             throws ConfigError,
                    FieldConvertError

Gets a long from the default section of settings.

Parameters:

key -

Returns:

the default value

Throws:

ConfigError

FieldConvertError

getLong

public long getLong(SessionID sessionID,
                    String key)
             throws ConfigError,
                    FieldConvertError

Get a settings value as a long integer.

Parameters:

sessionID - the session ID

key - the settings key

Returns:

the long integer value for the setting

Throws:

ConfigError - configuration error, probably a missing setting.

FieldConvertError - error during field type conversion.

getInt

public int getInt(String key)
           throws ConfigError,
                  FieldConvertError

Gets an int from the default section of settings.

Parameters:

key -

Returns:

the default value

Throws:

ConfigError

FieldConvertError

getInt

public int getInt(SessionID sessionID,
                  String key)
           throws ConfigError,
                  FieldConvertError

Get a settings value as an integer.

Parameters:

sessionID - the session ID

key - the settings key

Returns:

the long integer value for the setting

Throws:

ConfigError - configuration error, probably a missing setting.

FieldConvertError - error during field type conversion.

getDouble

public double getDouble(String key)
                 throws ConfigError,
                        FieldConvertError

Gets a double value from the default section of the settings.

Parameters:

key -

Returns:

the default value

Throws:

ConfigError

FieldConvertError

getDouble

public double getDouble(SessionID sessionID,
                        String key)
                 throws ConfigError,
                        FieldConvertError

Get a settings value as a double number.

Parameters:

sessionID - the session ID

key - the settings key

Returns:

the double number value for the setting

Throws:

ConfigError - configuration error, probably a missing setting.

FieldConvertError - error during field type conversion.

getBool

public boolean getBool(String key)
                throws ConfigError,
                       FieldConvertError

Gets a boolean value from the default section of the settings.

Parameters:

key -

Returns:

the boolean value

Throws:

ConfigError

FieldConvertError

getBool

public boolean getBool(SessionID sessionID,
                       String key)
                throws ConfigError,
                       FieldConvertError

Get a settings value as a boolean value.

Parameters:

sessionID - the session ID

key - the settings key

Returns:

the boolean value for the setting

Throws:

ConfigError - configuration error, probably a missing setting.

FieldConvertError - error during field type conversion.

setString

public void setString(SessionID sessionID,
                      String key,
                      String value)

Sets a string-valued session setting.

Parameters:

sessionID - the session ID

key - the setting key

value - the string value

setLong

public void setLong(SessionID sessionID,
                    String key,
                    long value)

Sets a long integer-valued session setting.

Parameters:

sessionID - the session ID

key - the setting key

value - the long integer value

setDouble

public void setDouble(SessionID sessionID,
                      String key,
                      double value)

Sets a double-valued session setting.

Parameters:

sessionID - the session ID

key - the setting key

value - the double value

setBool

public void setBool(SessionID sessionID,
                    String key,
                    boolean value)

Sets a boolean-valued session setting.

Parameters:

sessionID - the session ID

key - the setting key

value - the boolean value

sectionIterator

public Iterator<SessionID> sectionIterator()

isSetting

public boolean isSetting(String key)

Predicate for determining if a setting is in the default section.

Parameters:

key -

Returns:

true if setting is in the defaults, false otherwise

isSetting

public boolean isSetting(SessionID sessionID,
                         String key)

Predicate for determining if a setting exists.

Parameters:

sessionID - the session ID

key - the setting key

Returns:

true is setting exists, false otherwise.

removeSetting

public void removeSetting(SessionID sessionID,
                          String key)

setVariableValues

public void setVariableValues(Properties variableValues)

Set properties that will be the source of variable values in the settings. A variable is of the form ${variable} and will be replaced with values from the map when the setting is retrieved. By default, the System properties are used for variable values. If you use this method, it will override the defaults so use the Properties default value mechanism if you want to chain a custom properties object with System properties as the default.

 // Custom properties with System properties as default
 Properties myprops = new Properties(System.getProperties());
 myprops.load(getPropertiesInputStream());
 settings.setVariableValues(myprops);

 // Custom properties with System properties as override
 Properties myprops = new Properties();
 myprops.load(getPropertiesInputStream());
 myprops.putAll(System.getProperties());
 settings.setVariableValues(myprops);
 

Parameters:

variableValues -

See Also:

Properties, System

set

public void set(Map<Object,Object> defaults)

Adds defaults to the settings. Will not delete existing settings not overlapping with the new defaults, but will overwrite existing settings specified in this call.

Parameters:

defaults -

setBool

public void setBool(String key,
                    boolean value)

Set a default boolean parameter.

Parameters:

key - the settings key

value - the settings value

setDouble

public void setDouble(String key,
                      double value)

Set a default double parameter.

Parameters:

key - the settings key

value - the settings value

setLong

public void setLong(String key,
                    long value)

Set a default long parameter.

Parameters:

key - the settings key

value - the settings value

setString

public void setString(String key,
                      String value)

Set a default string parameter.

Parameters:

key - the settings key

value - the settings value

size

public int size()

get

public Dictionary get(SessionID sessionID)
               throws ConfigError

Throws:

ConfigError

set

public void set(SessionID sessionID,
                Dictionary dictionary)
         throws ConfigError

Throws:

ConfigError

get

public Dictionary get()

set

public void set(Dictionary dictionary)
         throws ConfigError

Throws:

ConfigError

toString

public void toString(PrintWriter writer)

toStream

public void toStream(OutputStream out)

toString

public String toString()

Overrides:

toString in class Object

parseSettingReconnectInterval

public static int[] parseSettingReconnectInterval(String raw)

parseRemoteAddresses

public static Set<InetAddress> parseRemoteAddresses(String raw)