com.teraspaces.qwfix
Class FIXSessionSettings

java.lang.Object
  extended by com.teraspaces.qwfix.FIXObject
      extended by com.teraspaces.qwfix.FIXSessionSettings

public class FIXSessionSettings
extends FIXObject

Represents the settings of a FIXSession. This class cannot be inherited.


Field Summary
 
Fields inherited from class com.teraspaces.qwfix.FIXObject
DOCUMENT_TYPE_FAST_SCHEMA, DOCUMENT_TYPE_FIX_ENGINE, DOCUMENT_TYPE_FIX_SCHEMA, DOCUMENT_TYPE_PROCESS, DOCUMENT_TYPE_SCHEDULER, DOCUMENT_TYPE_SESSION, DOCUMENT_TYPE_VISUAL_LAMBDA
 
Method Summary
static FIXSessionSettings fromXmlDocument(Document doc, FIXSchemaLoader schemaLoader, com.teraspaces.qwfix.scheduler.FIXSchedulerLoader schedulerLoader)
          Deserializes from XML document.
 String getAcceptorCompID()
          Gets the acceptor comp id.
 List<FIXSessionAdditionalSchema> getAdditionalSchemas()
          Gets the additional schemas.
 FIXSchema getDefaultSchema()
          Gets the default schema.
 String getDescription()
          Gets the description.
 int getHeartBeatInt()
          Gets the heart beat int.
 String getInitiatorCompID()
           
 String getName()
          Gets the name.
 TimeSpan getResetTime()
          Gets the reset time.
 com.teraspaces.qwfix.scheduler.FIXScheduler getScheduler()
          Gets the scheduler.
 FIXSessionOptions getSessionOptions()
          Gets the session options.
 boolean getSessionResetAsInitiator()
          Gets a value indicating whether the initiator of the session should initiate the 24 hour reset.
 boolean getSupportNextExpectedMsgSeqNum()
          Gets a value indicating whether the session supports NextExpectedMsgSeqNum in Log on message as specified in FIX specification 4.4.
 boolean getSupportTransportProtocol()
          Gets value indicating whether new FIX Transport Protocol for FIX 5.0+ is supported.
 FIXSchema getTransportSchema()
          Gets the transport schema.
 boolean getUseApplExtID()
          Gets a value indicating whether ApplExtID is used (if available in message header) to determine the schema of the message.
 boolean getUseCstmApplVerID()
          Gets a value indicating whether CstmApplVerID is used (if available in message header) to determine the schema of the message.
 QWVersion getVersion()
          Gets the version.
 boolean is24HourSession()
          Checks if is 24 hour session.
 void set24HourSession(boolean is24HourSession)
          Sets the 24 hour session.
 
Methods inherited from class com.teraspaces.qwfix.FIXObject
createXmlDocument, getGuid, parseXmlDocument, readXmlDocumentInfo, writeXmlDocumentInfo
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getScheduler

public com.teraspaces.qwfix.scheduler.FIXScheduler getScheduler()
Gets the scheduler.

Returns:
the scheduler

getVersion

public QWVersion getVersion()
Gets the version.

Returns:
the version

getDefaultSchema

public FIXSchema getDefaultSchema()
Gets the default schema.

Returns:
the default schema

getTransportSchema

public FIXSchema getTransportSchema()
Gets the transport schema.

Returns:
the transport schema

getInitiatorCompID

public String getInitiatorCompID()

getAcceptorCompID

public String getAcceptorCompID()
Gets the acceptor comp id.

Returns:
the acceptor comp id

getHeartBeatInt

public int getHeartBeatInt()
Gets the heart beat int.

Returns:
the heart beat int

getSupportNextExpectedMsgSeqNum

public boolean getSupportNextExpectedMsgSeqNum()
Gets a value indicating whether the session supports NextExpectedMsgSeqNum in Log on message as specified in FIX specification 4.4.

Returns:
true if NextExpectedMsgSeqNum is supported.

set24HourSession

public void set24HourSession(boolean is24HourSession)
Sets the 24 hour session.

Parameters:
is24HourSession - the new 24 hour session

is24HourSession

public boolean is24HourSession()
Checks if is 24 hour session.

Returns:
true, if is 24 hour session

getResetTime

public TimeSpan getResetTime()
Gets the reset time.

Returns:
the reset time

getName

public String getName()
Gets the name.

Returns:
the name

getDescription

public String getDescription()
Gets the description.

Returns:
the description

getSessionResetAsInitiator

public boolean getSessionResetAsInitiator()
Gets a value indicating whether the initiator of the session should initiate the 24 hour reset.

If this property is true, the initiator (usually the client) of the session will also initiate the 24 hour reset; otherwise the acceptor initiates the reset.

If the session is not a 24 hour session. This property should be ignored.

Returns:
the session reset as initiator

getSupportTransportProtocol

public boolean getSupportTransportProtocol()
Gets value indicating whether new FIX Transport Protocol for FIX 5.0+ is supported.

TransportSchema is defined if and only if this property is true; otherwise getTransportSchema() should be null

Returns:
true if new FIX Transport Protocol for FIX 5.0+ is supported; otherwise, false.

getAdditionalSchemas

public List<FIXSessionAdditionalSchema> getAdditionalSchemas()
Gets the additional schemas.

The property is valid if and only if getSupportTransportProtocol() is true; otherwise it should be empty. This list is read only.

Returns:
the additional schemas

getUseApplExtID

public boolean getUseApplExtID()
Gets a value indicating whether ApplExtID is used (if available in message header) to determine the schema of the message.

Used with new FIX Transport Protocol only.

Returns:
true if ApplExtID is used; otherwise, false

getUseCstmApplVerID

public boolean getUseCstmApplVerID()
Gets a value indicating whether CstmApplVerID is used (if available in message header) to determine the schema of the message.

Used with new FIX Transport Protocol only.

Returns:
true if CstmApplVerID is used; otherwise, false.

getSessionOptions

public FIXSessionOptions getSessionOptions()
Gets the session options.

Returns:
the session options

fromXmlDocument

public static FIXSessionSettings fromXmlDocument(Document doc,
                                                 FIXSchemaLoader schemaLoader,
                                                 com.teraspaces.qwfix.scheduler.FIXSchedulerLoader schedulerLoader)
Deserializes from XML document.

Parameters:
doc - the doc
schemaLoader - the schema loader
schedulerLoader - the scheduler loader
Returns:
the fIX session settings