|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectquickfix.SessionSettings
public class SessionSettings
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.
Acceptor
,
Initiator
,
FileLogFactory
,
ScreenLogFactory
,
FileStoreFactory
,
JdbcSetting
,
Session
,
DefaultSessionFactory
Field Summary | |
---|---|
static java.lang.String |
BEGINSTRING
|
static java.lang.String |
SENDERCOMPID
|
static java.lang.String |
SENDERLOCID
|
static java.lang.String |
SENDERSUBID
|
static java.lang.String |
SESSION_QUALIFIER
|
static java.lang.String |
TARGETCOMPID
|
static java.lang.String |
TARGETLOCID
|
static java.lang.String |
TARGETSUBID
|
Constructor Summary | |
---|---|
SessionSettings()
Creates an empty session settings object. |
|
SessionSettings(java.io.InputStream stream)
Loads session settings from an input stream. |
|
SessionSettings(java.lang.String filename)
Loads session settings from a file. |
Method Summary | |
---|---|
Dictionary |
get()
|
Dictionary |
get(SessionID sessionID)
|
boolean |
getBool(SessionID sessionID,
java.lang.String key)
Get a settings value as a boolean value. |
boolean |
getBool(java.lang.String key)
Gets a boolean value from the default section of the settings. |
java.util.Properties |
getDefaultProperties()
Returns the defaults for the session-level settings. |
double |
getDouble(SessionID sessionID,
java.lang.String key)
Get a settings value as a double number. |
double |
getDouble(java.lang.String key)
Gets a double value from the default section of the settings. |
long |
getLong(SessionID sessionID,
java.lang.String key)
Get a settings value as a long integer. |
long |
getLong(java.lang.String key)
Gets a long from the default section of settings. |
java.util.Properties |
getSessionProperties(SessionID sessionID)
Return the settings for a session as a Properties object. |
java.util.Properties |
getSessionProperties(SessionID sessionID,
boolean includeDefaults)
Return the settings for a session as a Properties object. |
java.lang.String |
getString(SessionID sessionID,
java.lang.String key)
Get a settings string. |
java.lang.String |
getString(java.lang.String key)
Gets a string from the default section of the settings. |
boolean |
isSetting(SessionID sessionID,
java.lang.String key)
Predicate for determining if a setting exists. |
boolean |
isSetting(java.lang.String key)
Predicate for determining if a setting is in the default section. |
static int[] |
parseSettingReconnectInterval(java.lang.String raw)
|
void |
removeSetting(SessionID sessionID,
java.lang.String key)
|
java.util.Iterator<SessionID> |
sectionIterator()
|
void |
set(Dictionary dictionary)
|
void |
set(java.util.Map<java.lang.Object,java.lang.Object> defaults)
Adds defaults to the settings. |
void |
set(SessionID sessionID,
Dictionary dictionary)
|
void |
setBool(SessionID sessionID,
java.lang.String key,
boolean value)
Sets a boolean-valued session setting. |
void |
setBool(java.lang.String key,
boolean value)
Set a default boolean parameter. |
void |
setDouble(SessionID sessionID,
java.lang.String key,
double value)
Sets a double-valued session setting. |
void |
setDouble(java.lang.String key,
double value)
Set a default double parameter. |
void |
setLong(SessionID sessionID,
java.lang.String key,
long value)
Sets a long integer-valued session setting. |
void |
setLong(java.lang.String key,
long value)
Set a default long parameter. |
void |
setString(SessionID sessionID,
java.lang.String key,
java.lang.String value)
Sets a string-valued session setting. |
void |
setString(java.lang.String key,
java.lang.String value)
Set a default string parameter. |
void |
setVariableValues(java.util.Properties variableValues)
Set properties that will be the source of variable values in the settings. |
int |
size()
|
void |
toStream(java.io.OutputStream out)
|
java.lang.String |
toString()
|
void |
toString(java.io.PrintWriter writer)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String BEGINSTRING
public static final java.lang.String SENDERCOMPID
public static final java.lang.String SENDERSUBID
public static final java.lang.String SENDERLOCID
public static final java.lang.String TARGETCOMPID
public static final java.lang.String TARGETSUBID
public static final java.lang.String TARGETLOCID
public static final java.lang.String SESSION_QUALIFIER
Constructor Detail |
---|
public SessionSettings()
public SessionSettings(java.lang.String filename) throws ConfigError
filename
- the path to the file containing the session settings
ConfigError
public SessionSettings(java.io.InputStream stream) throws ConfigError
stream
- the input stream
ConfigError
Method Detail |
---|
public java.lang.String getString(java.lang.String key) throws ConfigError, FieldConvertError
key
-
ConfigError
FieldConvertError
public java.lang.String getString(SessionID sessionID, java.lang.String key) throws ConfigError, FieldConvertError
sessionID
- the session IDkey
- the settings key
ConfigError
- configurion error, probably a missing setting.
FieldConvertError
- error during field type conversion.public java.util.Properties getSessionProperties(SessionID sessionID, boolean includeDefaults) throws ConfigError
sessionID
- includeDefaults
- if true, include settings defaults in properties
ConfigError
Properties
public java.util.Properties getSessionProperties(SessionID sessionID) throws ConfigError
sessionID
-
ConfigError
Properties
public java.util.Properties getDefaultProperties()
ConfigError
public long getLong(java.lang.String key) throws ConfigError, FieldConvertError
key
-
ConfigError
FieldConvertError
public long getLong(SessionID sessionID, java.lang.String key) throws ConfigError, FieldConvertError
sessionID
- the session IDkey
- the settings key
ConfigError
- configurion error, probably a missing setting.
FieldConvertError
- error during field type conversion.public double getDouble(java.lang.String key) throws ConfigError, FieldConvertError
key
-
ConfigError
FieldConvertError
public double getDouble(SessionID sessionID, java.lang.String key) throws ConfigError, FieldConvertError
sessionID
- the session IDkey
- the settings key
ConfigError
- configurion error, probably a missing setting.
FieldConvertError
- error during field type conversion.public boolean getBool(java.lang.String key) throws ConfigError, FieldConvertError
key
-
ConfigError
FieldConvertError
public boolean getBool(SessionID sessionID, java.lang.String key) throws ConfigError, FieldConvertError
sessionID
- the session IDkey
- the settings key
ConfigError
- configurion error, probably a missing setting.
FieldConvertError
- error during field type conversion.public void setString(SessionID sessionID, java.lang.String key, java.lang.String value)
sessionID
- the session IDkey
- the setting keyvalue
- the string valuepublic void setLong(SessionID sessionID, java.lang.String key, long value)
sessionID
- the session IDkey
- the setting keyvalue
- the long integer valuepublic void setDouble(SessionID sessionID, java.lang.String key, double value)
sessionID
- the session IDkey
- the setting keyvalue
- the double valuepublic void setBool(SessionID sessionID, java.lang.String key, boolean value)
sessionID
- the session IDkey
- the setting keyvalue
- the boolean valuepublic java.util.Iterator<SessionID> sectionIterator()
public boolean isSetting(java.lang.String key)
key
-
public boolean isSetting(SessionID sessionID, java.lang.String key)
sessionID
- the session IDkey
- the setting key
public void removeSetting(SessionID sessionID, java.lang.String key)
public void setVariableValues(java.util.Properties variableValues)
// 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);
variableValues
- Properties
,
System
public void set(java.util.Map<java.lang.Object,java.lang.Object> defaults)
defaults
- public void setBool(java.lang.String key, boolean value)
key
- the settings keyvalue
- the settings valuepublic void setDouble(java.lang.String key, double value)
key
- the settings keyvalue
- the settings valuepublic void setLong(java.lang.String key, long value)
key
- the settings keyvalue
- the settings valuepublic void setString(java.lang.String key, java.lang.String value)
key
- the settings keyvalue
- the settings valuepublic int size()
public Dictionary get(SessionID sessionID) throws ConfigError
ConfigError
public void set(SessionID sessionID, Dictionary dictionary) throws ConfigError
ConfigError
public Dictionary get()
public void set(Dictionary dictionary) throws ConfigError
ConfigError
public void toString(java.io.PrintWriter writer)
public void toStream(java.io.OutputStream out)
public java.lang.String toString()
toString
in class java.lang.Object
public static int[] parseSettingReconnectInterval(java.lang.String raw)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |