Session (QuickFIX/J Distribution 2.3.0 API)

java.lang.Object
- quickfix.Session

All Implemented Interfaces:

Closeable, AutoCloseable
```
public class Session
extends Object
implements Closeable
```
The Session is the primary FIX abstraction for message communication.
It performs sequencing and error recovery and represents a communication channel to a counter-party. Sessions are independent of specific communication layer connections. The Session could span many sequential connections (but cannot operate on multiple connection simultaneously).
A logical session is defined as starting with message sequence number 1 and ending when the session is reset. However, the Session object instance is registered when first created (per SessionID), and remains registered for the lifetime of the application (until the Connector is stopped), even across resets (which reset its internal state, such as the sequence number).

Field Summary

Fields
Modifier and Type	Field and Description
`static double`	`DEFAULT_HEARTBEAT_TIMEOUT_MULTIPLIER`
`static int`	`DEFAULT_MAX_LATENCY`
`static int`	`DEFAULT_RESEND_RANGE_CHUNK_SIZE`
`static double`	`DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER`
`protected static org.slf4j.Logger`	`LOG`
`static String`	`SETTING_ALLOW_UNKNOWN_MSG_FIELDS` Allow unknown fields in messages.
`static String`	`SETTING_ALLOWED_REMOTE_ADDRESSES`
`static String`	`SETTING_APP_DATA_DICTIONARY` Session setting specifying the path to the application data dictionary to use for this session.
`static String`	`SETTING_CHECK_COMP_ID` If set to Y, messages must be received from the counterparty with the correct SenderCompID and TargetCompID.
`static String`	`SETTING_CHECK_LATENCY` Session setting for enabling message latency checks.
`static String`	`SETTING_DATA_DICTIONARY` Session setting specifying the path to the data dictionary to use for this session.
`static String`	`SETTING_DEFAULT_APPL_VER_ID`
`static String`	`SETTING_DESCRIPTION` Session description.
`static String`	`SETTING_DISABLE_HEART_BEAT_CHECK` Allow to disable heart beat failure detection
`static String`	`SETTING_DISCONNECT_ON_ERROR` Session setting for doing an automatic disconnect when an error occurs.
`static String`	`SETTING_ENABLE_LAST_MSG_SEQ_NUM_PROCESSED` Return the last msg seq number processed (optional tag 369).
`static String`	`SETTING_ENABLE_NEXT_EXPECTED_MSG_SEQ_NUM` Return the next expected message sequence number (optional tag 789 on Logon) on sent Logon message and use value of tag 789 on received Logon message to synchronize session.
`static String`	`SETTING_END_DAY` Session scheduling setting to specify last day of trading week.
`static String`	`SETTING_END_TIME` Session scheduling setting to specify end time of the trading day.
`static String`	`SETTING_FORCE_RESEND_WHEN_CORRUPTED_STORE`
`static String`	`SETTING_HEARTBEAT_TIMEOUT_MULTIPLIER` Session setting for the heartbeat timeout multiplier (as fraction of heartbeat interval).
`static String`	`SETTING_HEARTBTINT` Session setting for heartbeat interval (in seconds).
`static String`	`SETTING_LOGON_TAG` Session setting for custom logon tags.
`static String`	`SETTING_LOGON_TIMEOUT` Session setting for logon timeout (in seconds).
`static String`	`SETTING_LOGOUT_TIMEOUT` Session setting for logout timeout (in seconds).
`static String`	`SETTING_MAX_LATENCY` Session setting for maximum message latency (in seconds).
`static String`	`SETTING_MAX_SCHEDULED_WRITE_REQUESTS`
`static String`	`SETTING_NON_STOP_SESSION` Session scheduling setting to specify that session never reset
`static String`	`SETTING_PERSIST_MESSAGES` Persist messages setting (true, by default).
`static String`	`SETTING_REFRESH_ON_LOGON` Requests that state and message data be refreshed from the message store at logon, if possible.
`static String`	`SETTING_REJECT_GARBLED_MESSAGE` Reject garbled messages instead of ignoring them.
`static String`	`SETTING_REJECT_INVALID_MESSAGE`
`static String`	`SETTING_REJECT_MESSAGE_ON_UNHANDLED_EXCEPTION`
`static String`	`SETTING_REQUIRES_ORIG_SENDING_TIME`
`static String`	`SETTING_RESEND_REQUEST_CHUNK_SIZE` Setting to limit the size of a resend request in case of missing messages.
`static String`	`SETTING_RESET_ON_DISCONNECT` Session setting for doing an automatic sequence number reset on disconnect.
`static String`	`SETTING_RESET_ON_ERROR` Session setting for doing an automatic reset when an error occurs.
`static String`	`SETTING_RESET_ON_LOGON` Session setting that causes the session to reset sequence numbers when initiating a logon (>= FIX 4.2).
`static String`	`SETTING_RESET_ON_LOGOUT` Session setting for doing an automatic sequence number reset on logout.
`static String`	`SETTING_SEND_REDUNDANT_RESEND_REQUEST` Configures the session to send redundant resend requests (off, by default).
`static String`	`SETTING_START_DAY` Session scheduling setting to specify first day of trading week.
`static String`	`SETTING_START_TIME` Session scheduling setting to specify starting time of the trading day.
`static String`	`SETTING_TEST_REQUEST_DELAY_MULTIPLIER` Session setting for the test delay multiplier (as fraction of heartbeat interval).
`static String`	`SETTING_TIMESTAMP_PRECISION` Session setting to control precision in message timestamps.
`static String`	`SETTING_TIMEZONE` Session scheduling setting to specify time zone for the session.
`static String`	`SETTING_TRANSPORT_DATA_DICTIONARY` Session setting specifying the path to the transport data dictionary.
`static String`	`SETTING_USE_CLOSED_RESEND_INTERVAL` Use actual end of sequence gap for resend requests rather than using "infinity" as the end sequence of the gap.
`static String`	`SETTING_USE_DATA_DICTIONARY` Session setting to indicate whether a data dictionary should be used.
`static String`	`SETTING_VALIDATE_CHECKSUM`
`static String`	`SETTING_VALIDATE_FIELDS_HAVE_VALUES` Session validation setting for enabling whether field values are validated.
`static String`	`SETTING_VALIDATE_FIELDS_OUT_OF_ORDER` Default is "Y".
`static String`	`SETTING_VALIDATE_INCOMING_MESSAGE` Allow to bypass the message validation.
`static String`	`SETTING_VALIDATE_SEQUENCE_NUMBERS` Check the next expected target SeqNum against the received SeqNum.
`static String`	`SETTING_VALIDATE_UNORDERED_GROUP_FIELDS` Session validation setting for enabling whether field ordering is validated.
`static String`	`SETTING_VALIDATE_USER_DEFINED_FIELDS` Controls validation of user-defined fields.
`static String`	`SETTING_WEEKDAYS` Session scheduling setting to specify active days of the week.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addStateListener(SessionStateListener listener)`
`void`	`close()` Closes session resources and unregisters session.
`void`	`disconnect(String reason, boolean logError)` Logs out from session and closes the network connection.
`static boolean`	`doesSessionExist(SessionID sessionID)` Determine if a session exists with the given ID.
`protected static Integer`	`extractExpectedSequenceNumber(String txt)`
`void`	`generateHeartbeat()`
`void`	`generateLogout()`
`void`	`generateTestRequest(String id)`
`boolean`	`getCheckCompID()`
`DataDictionary`	`getDataDictionary()`
`DataDictionaryProvider`	`getDataDictionaryProvider()`
`int`	`getExpectedSenderNum()` Retrieves the expected sender sequence number.
`int`	`getExpectedTargetNum()` Retrieves the expected target sequence number.
`Log`	`getLog()`
`int`	`getLogonTimeout()`
`int`	`getLogoutTimeout()`
`int`	`getMaxScheduledWriteRequests()`
`MessageFactory`	`getMessageFactory()`
`boolean`	`getRedundantResentRequestsAllowed()`
`boolean`	`getRefreshOnLogon()`
`String`	`getRemoteAddress()` Provides remote address of the session connection, if any.
`boolean`	`getResetOnDisconnect()`
`boolean`	`getResetOnLogout()`
`Responder`	`getResponder()`
`ApplVerID`	`getSenderDefaultApplicationVersionID()`
`SessionID`	`getSessionID()`
`Date`	`getStartTime()`
`SessionStateListener`	`getStateListener()`
`MessageStore`	`getStore()` Get the message store.
`ApplVerID`	`getTargetDefaultApplicationVersionID()`
`double`	`getTestRequestDelayMultiplier()`
`boolean`	`hasResponder()` This should not be used by end users.
`boolean`	`isAllowedForSession(InetAddress remoteInetAddress)`
`boolean`	`isEnabled()` Used internally
`boolean`	`isLoggedOn()` Is the session logged on.
`boolean`	`isLogonAlreadySent()`
`boolean`	`isLogonReceived()`
`boolean`	`isLogonSendNeeded()`
`boolean`	`isLogonSent()`
`boolean`	`isLogonTimedOut()`
`boolean`	`isLogoutReceived()`
`boolean`	`isLogoutSent()`
`boolean`	`isLogoutTimedOut()`
`boolean`	`isRejectGarbledMessage()`
`boolean`	`isSessionTime()` Predicate for determining if the session should be active at the current time.
`boolean`	`isUsingDataDictionary()`
`boolean`	`isValidateChecksum()`
`void`	`logon()` This method can be used to manually logon to a FIX session.
`void`	`logout()` This method can be used to manually logout of a FIX session.
`void`	`logout(String reason)` This method can be used to manually logout of a FIX session.
`static Session`	`lookupSession(SessionID sessionID)` Locates a session specified by the provided session ID.
`void`	`next()` Called from the timer-related code in the acceptor/initiator implementations.
`void`	`next(Message message)` (Internal use only)
`static int`	`numSessions()` Return the session count.
`boolean`	`receivedLogon()` Predicate indicating whether a logon message has been received.
`boolean`	`receivedLogout()` Predicate indicating whether a logout message has been received.
`void`	`removeStateListener(SessionStateListener listener)`
`void`	`reset()` Logs out session (if logged on) and then resets session state.
`boolean`	`send(Message message)` Send a message to a counterparty.
`static boolean`	`sendToTarget(Message message)` Send a message to the session specified in the message's target identifiers.
`static boolean`	`sendToTarget(Message message, SessionID sessionID)` Send a message to the session specified by the provided session ID.
`static boolean`	`sendToTarget(Message message, String qualifier)` Send a message to the session specified in the message's target identifiers.
`static boolean`	`sendToTarget(Message message, String senderCompID, String targetCompID)` Send a message to the session specified by the provided target company ID.
`static boolean`	`sendToTarget(Message message, String senderCompID, String targetCompID, String qualifier)` Send a message to the session specified by the provided target company ID.
`boolean`	`sentLogon()` Predicate indicating whether a logon message has been sent.
`boolean`	`sentLogout()` Predicate indicating whether a logout message has been sent.
`void`	`setForceResendWhenCorruptedStore(boolean forceResendWhenCorruptedStore)`
`void`	`setHeartBeatInterval(int heartbeatInterval)` Internal use by acceptor code.
`void`	`setIgnoreHeartBeatFailure(boolean ignoreHeartBeatFailure)`
`void`	`setLogonTimeout(int seconds)` Sets the timeout for waiting for a logon response.
`void`	`setLogoutTimeout(int seconds)` Sets the timeout for waiting for a logout response.
`void`	`setMaxScheduledWriteRequests(int maxScheduledWriteRequests)`
`void`	`setNextSenderMsgSeqNum(int num)` Set the next outgoing message sequence number.
`void`	`setNextTargetMsgSeqNum(int num)` Set the next expected target message sequence number.
`void`	`setRejectGarbledMessage(boolean rejectGarbledMessage)`
`void`	`setRejectInvalidMessage(boolean rejectInvalidMessage)`
`void`	`setRejectMessageOnUnhandledException(boolean rejectMessageOnUnhandledException)`
`void`	`setRequiresOrigSendingTime(boolean requiresOrigSendingTime)`
`void`	`setResponder(Responder responder)` Registers a responder with the session.
`void`	`setTargetDefaultApplicationVersionID(ApplVerID applVerID)` Sets the default application version ID for messages received by this session.
`void`	`setValidateChecksum(boolean validateChecksum)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - SETTING_HEARTBTINT
```
public static final String SETTING_HEARTBTINT
```
    Session setting for heartbeat interval (in seconds).
    
    See Also:
    
    Constant Field Values
  - SETTING_CHECK_LATENCY
```
public static final String SETTING_CHECK_LATENCY
```
    Session setting for enabling message latency checks. Values are "Y" or "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_CHECK_COMP_ID
```
public static final String SETTING_CHECK_COMP_ID
```
    If set to Y, messages must be received from the counterparty with the correct SenderCompID and TargetCompID. Some systems will send you different CompIDs by design, so you must set this to N.
    
    See Also:
    
    Constant Field Values
  - SETTING_MAX_LATENCY
```
public static final String SETTING_MAX_LATENCY
```
    Session setting for maximum message latency (in seconds).
    
    See Also:
    
    Constant Field Values
  - SETTING_TEST_REQUEST_DELAY_MULTIPLIER
```
public static final String SETTING_TEST_REQUEST_DELAY_MULTIPLIER
```
    Session setting for the test delay multiplier (as fraction of heartbeat interval).
    
    See Also:
    
    Constant Field Values
  - SETTING_HEARTBEAT_TIMEOUT_MULTIPLIER
```
public static final String SETTING_HEARTBEAT_TIMEOUT_MULTIPLIER
```
    Session setting for the heartbeat timeout multiplier (as fraction of heartbeat interval).
    
    See Also:
    
    Constant Field Values
  - SETTING_NON_STOP_SESSION
```
public static final String SETTING_NON_STOP_SESSION
```
    Session scheduling setting to specify that session never reset
    
    See Also:
    
    Constant Field Values
  - SETTING_START_DAY
```
public static final String SETTING_START_DAY
```
    Session scheduling setting to specify first day of trading week.
    
    See Also:
    
    Constant Field Values
  - SETTING_END_DAY
```
public static final String SETTING_END_DAY
```
    Session scheduling setting to specify last day of trading week.
    
    See Also:
    
    Constant Field Values
  - SETTING_TIMEZONE
```
public static final String SETTING_TIMEZONE
```
    Session scheduling setting to specify time zone for the session.
    
    See Also:
    
    Constant Field Values
  - SETTING_START_TIME
```
public static final String SETTING_START_TIME
```
    Session scheduling setting to specify starting time of the trading day.
    
    See Also:
    
    Constant Field Values
  - SETTING_END_TIME
```
public static final String SETTING_END_TIME
```
    Session scheduling setting to specify end time of the trading day.
    
    See Also:
    
    Constant Field Values
  - SETTING_WEEKDAYS
```
public static final String SETTING_WEEKDAYS
```
    Session scheduling setting to specify active days of the week.
    
    See Also:
    
    Constant Field Values
  - SETTING_USE_DATA_DICTIONARY
```
public static final String SETTING_USE_DATA_DICTIONARY
```
    Session setting to indicate whether a data dictionary should be used. If a data dictionary is not used then message validation is not possible.
    
    See Also:
    
    Constant Field Values
  - SETTING_DATA_DICTIONARY
```
public static final String SETTING_DATA_DICTIONARY
```
    Session setting specifying the path to the data dictionary to use for this session. This setting supports the possibility of a custom data dictionary for each session. Normally, the default data dictionary for a specific FIX version will be specified.
    
    See Also:
    
    Constant Field Values
  - SETTING_TRANSPORT_DATA_DICTIONARY
```
public static final String SETTING_TRANSPORT_DATA_DICTIONARY
```
    Session setting specifying the path to the transport data dictionary. This setting supports the possibility of a custom transport data dictionary for each session. This setting would only be used with FIXT 1.1 and new transport protocols.
    
    See Also:
    
    Constant Field Values
  - SETTING_APP_DATA_DICTIONARY
```
public static final String SETTING_APP_DATA_DICTIONARY
```
    Session setting specifying the path to the application data dictionary to use for this session. This setting supports the possibility of a custom application data dictionary for each session. This setting would only be used with FIXT 1.1 and new transport protocols. This setting can be used as a prefix to specify multiple application dictionaries for the FIXT transport. For example:
```
 DefaultApplVerID=FIX.4.2
 AppDataDictionary=FIX42.xml
 AppDataDictionary.FIX.4.4=FIX44.xml
 
```
    This would use FIX42.xml for the default application version ID and FIX44.xml for any FIX 4.4 messages.
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_FIELDS_OUT_OF_ORDER
```
public static final String SETTING_VALIDATE_FIELDS_OUT_OF_ORDER
```
    Default is "Y". If set to N, fields that are out of order (i.e. body fields in the header, or header fields in the body) will not be rejected.
    
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_UNORDERED_GROUP_FIELDS
```
public static final String SETTING_VALIDATE_UNORDERED_GROUP_FIELDS
```
    Session validation setting for enabling whether field ordering is validated. Values are "Y" or "N". Default is "Y".
    
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_FIELDS_HAVE_VALUES
```
public static final String SETTING_VALIDATE_FIELDS_HAVE_VALUES
```
    Session validation setting for enabling whether field values are validated. Empty fields values are not allowed. Values are "Y" or "N". Default is "Y".
    
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_INCOMING_MESSAGE
```
public static final String SETTING_VALIDATE_INCOMING_MESSAGE
```
    Allow to bypass the message validation. Default is "Y".
    
    See Also:
    
    Constant Field Values
  - SETTING_LOGON_TIMEOUT
```
public static final String SETTING_LOGON_TIMEOUT
```
    Session setting for logon timeout (in seconds).
    
    See Also:
    
    Constant Field Values
  - SETTING_LOGOUT_TIMEOUT
```
public static final String SETTING_LOGOUT_TIMEOUT
```
    Session setting for logout timeout (in seconds).
    
    See Also:
    
    Constant Field Values
  - SETTING_LOGON_TAG
```
public static final String SETTING_LOGON_TAG
```
    Session setting for custom logon tags. Single entry or consecutive list of tag=value pairs, e.g. LogonTag=553=user and LogonTag1=554=password.
    
    See Also:
    
    Constant Field Values
  - SETTING_RESET_ON_LOGOUT
```
public static final String SETTING_RESET_ON_LOGOUT
```
    Session setting for doing an automatic sequence number reset on logout. Valid values are "Y" or "N". Default is "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_SEQUENCE_NUMBERS
```
public static final String SETTING_VALIDATE_SEQUENCE_NUMBERS
```
    Check the next expected target SeqNum against the received SeqNum. Default is "Y". If a mismatch is detected, apply the following logic:
    - if lower than expected SeqNum , logout
    - if higher, send a resend request
    See Also:
    
    Constant Field Values
  - SETTING_RESET_ON_DISCONNECT
```
public static final String SETTING_RESET_ON_DISCONNECT
```
    Session setting for doing an automatic sequence number reset on disconnect. Valid values are "Y" or "N". Default is "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_RESET_ON_ERROR
```
public static final String SETTING_RESET_ON_ERROR
```
    Session setting for doing an automatic reset when an error occurs. Valid values are "Y" or "N". Default is "N". A reset means disconnect, sequence numbers reset, store cleaned and reconnect, as for a daily reset.
    
    See Also:
    
    Constant Field Values
  - SETTING_DISCONNECT_ON_ERROR
```
public static final String SETTING_DISCONNECT_ON_ERROR
```
    Session setting for doing an automatic disconnect when an error occurs. Valid values are "Y" or "N". Default is "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_TIMESTAMP_PRECISION
```
public static final String SETTING_TIMESTAMP_PRECISION
```
    Session setting to control precision in message timestamps. Valid values are "SECONDS", "MILLIS", "MICROS", "NANOS". Default is "MILLIS". Only valid for FIX version >= 4.2.
    
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_USER_DEFINED_FIELDS
```
public static final String SETTING_VALIDATE_USER_DEFINED_FIELDS
```
    Controls validation of user-defined fields.
    
    See Also:
    
    Constant Field Values
  - SETTING_RESET_ON_LOGON
```
public static final String SETTING_RESET_ON_LOGON
```
    Session setting that causes the session to reset sequence numbers when initiating a logon (>= FIX 4.2).
    
    See Also:
    
    Constant Field Values
  - SETTING_DESCRIPTION
```
public static final String SETTING_DESCRIPTION
```
    Session description. Used by external tools.
    
    See Also:
    
    Constant Field Values
  - SETTING_REFRESH_ON_LOGON
```
public static final String SETTING_REFRESH_ON_LOGON
```
    Requests that state and message data be refreshed from the message store at logon, if possible. This supports simple failover behavior for acceptors.
    
    See Also:
    
    Constant Field Values
  - SETTING_SEND_REDUNDANT_RESEND_REQUEST
```
public static final String SETTING_SEND_REDUNDANT_RESEND_REQUEST
```
    Configures the session to send redundant resend requests (off, by default).
    
    See Also:
    
    Constant Field Values
  - SETTING_PERSIST_MESSAGES
```
public static final String SETTING_PERSIST_MESSAGES
```
    Persist messages setting (true, by default). If set to false this will cause the Session to not persist any messages and all resend requests will be answered with a gap fill.
    
    See Also:
    
    Constant Field Values
  - SETTING_USE_CLOSED_RESEND_INTERVAL
```
public static final String SETTING_USE_CLOSED_RESEND_INTERVAL
```
    Use actual end of sequence gap for resend requests rather than using "infinity" as the end sequence of the gap. Not recommended by the FIX specification, but needed for some counterparties.
    
    See Also:
    
    Constant Field Values
  - SETTING_ALLOW_UNKNOWN_MSG_FIELDS
```
public static final String SETTING_ALLOW_UNKNOWN_MSG_FIELDS
```
    Allow unknown fields in messages. This is intended for unknown fields with tags < 5000 (not user defined fields)
    
    See Also:
    
    Constant Field Values
  - SETTING_DEFAULT_APPL_VER_ID
```
public static final String SETTING_DEFAULT_APPL_VER_ID
```
    See Also:
    
    Constant Field Values
  - SETTING_DISABLE_HEART_BEAT_CHECK
```
public static final String SETTING_DISABLE_HEART_BEAT_CHECK
```
    Allow to disable heart beat failure detection
    
    See Also:
    
    Constant Field Values
  - SETTING_ENABLE_LAST_MSG_SEQ_NUM_PROCESSED
```
public static final String SETTING_ENABLE_LAST_MSG_SEQ_NUM_PROCESSED
```
    Return the last msg seq number processed (optional tag 369). Valid values are "Y" or "N". Default is "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_ENABLE_NEXT_EXPECTED_MSG_SEQ_NUM
```
public static final String SETTING_ENABLE_NEXT_EXPECTED_MSG_SEQ_NUM
```
    Return the next expected message sequence number (optional tag 789 on Logon) on sent Logon message and use value of tag 789 on received Logon message to synchronize session. Valid values are "Y" or "N". Default is "N". This should not be enabled for FIX versions lower than 4.4
    
    See Also:
    
    Constant Field Values
  - SETTING_REJECT_GARBLED_MESSAGE
```
public static final String SETTING_REJECT_GARBLED_MESSAGE
```
    Reject garbled messages instead of ignoring them. This is only working for messages that pass the FIX decoder and reach the engine. Messages that cannot be considered a real FIX message (i.e. not starting with 8=FIX or not ending with 10=xxx) will be ignored in any case. Default is "N".
    
    See Also:
    
    Constant Field Values
  - SETTING_REJECT_INVALID_MESSAGE
```
public static final String SETTING_REJECT_INVALID_MESSAGE
```
    See Also:
    
    Constant Field Values
  - SETTING_REJECT_MESSAGE_ON_UNHANDLED_EXCEPTION
```
public static final String SETTING_REJECT_MESSAGE_ON_UNHANDLED_EXCEPTION
```
    See Also:
    
    Constant Field Values
  - SETTING_REQUIRES_ORIG_SENDING_TIME
```
public static final String SETTING_REQUIRES_ORIG_SENDING_TIME
```
    See Also:
    
    Constant Field Values
  - SETTING_FORCE_RESEND_WHEN_CORRUPTED_STORE
```
public static final String SETTING_FORCE_RESEND_WHEN_CORRUPTED_STORE
```
    See Also:
    
    Constant Field Values
  - SETTING_ALLOWED_REMOTE_ADDRESSES
```
public static final String SETTING_ALLOWED_REMOTE_ADDRESSES
```
    See Also:
    
    Constant Field Values
  - SETTING_RESEND_REQUEST_CHUNK_SIZE
```
public static final String SETTING_RESEND_REQUEST_CHUNK_SIZE
```
    Setting to limit the size of a resend request in case of missing messages. This is useful when the remote FIX engine does not allow to ask for more than n message for a ResendRequest
    
    See Also:
    
    Constant Field Values
  - SETTING_MAX_SCHEDULED_WRITE_REQUESTS
```
public static final String SETTING_MAX_SCHEDULED_WRITE_REQUESTS
```
    See Also:
    
    Constant Field Values
  - SETTING_VALIDATE_CHECKSUM
```
public static final String SETTING_VALIDATE_CHECKSUM
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MAX_LATENCY
```
public static final int DEFAULT_MAX_LATENCY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_RESEND_RANGE_CHUNK_SIZE
```
public static final int DEFAULT_RESEND_RANGE_CHUNK_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER
```
public static final double DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER
```
    See Also:
    
    Constant Field Values
  - DEFAULT_HEARTBEAT_TIMEOUT_MULTIPLIER
```
public static final double DEFAULT_HEARTBEAT_TIMEOUT_MULTIPLIER
```
    See Also:
    
    Constant Field Values
  - LOG
```
protected static final org.slf4j.Logger LOG
```
- Method Detail
  - getMessageFactory
```
public MessageFactory getMessageFactory()
```
  - setResponder
```
public void setResponder(Responder responder)
```
    Registers a responder with the session. This is used by the acceptor and initiator implementations.
    
    Parameters:
    
    responder - a responder implementation
  - getResponder
```
public Responder getResponder()
```
  - hasResponder
```
public boolean hasResponder()
```
    This should not be used by end users.
    
    Returns:
    
    the Session's connection responder
  - getRemoteAddress
```
public String getRemoteAddress()
```
    Provides remote address of the session connection, if any.
    
    Returns:
    
    remote address (host:port) if connected, null if not.
  - sendToTarget
```
public static boolean sendToTarget(Message message)
                            throws SessionNotFound
```
    Send a message to the session specified in the message's target identifiers.
    
    Parameters:
    
    message - a FIX message
    
    Returns:
    
    true is send was successful, false otherwise
    
    Throws:
    
    SessionNotFound - if session could not be located
  - sendToTarget
```
public static boolean sendToTarget(Message message,
                                   String qualifier)
                            throws SessionNotFound
```
    Send a message to the session specified in the message's target identifiers. The session qualifier is used to distinguish sessions with the same target identifiers.
    
    Parameters:
    
    message - a FIX message
    
    qualifier - a session qualifier
    
    Returns:
    
    true is send was successful, false otherwise
    
    Throws:
    
    SessionNotFound - if session could not be located
  - sendToTarget
```
public static boolean sendToTarget(Message message,
                                   String senderCompID,
                                   String targetCompID)
                            throws SessionNotFound
```
    Send a message to the session specified by the provided target company ID. The sender company ID is provided as an argument rather than from the message.
    
    Parameters:
    
    message - a FIX message
    
    senderCompID - the sender's company ID
    
    targetCompID - the target's company ID
    
    Returns:
    
    true is send was successful, false otherwise
    
    Throws:
    
    SessionNotFound - if session could not be located
  - sendToTarget
```
public static boolean sendToTarget(Message message,
                                   String senderCompID,
                                   String targetCompID,
                                   String qualifier)
                            throws SessionNotFound
```
    Send a message to the session specified by the provided target company ID. The sender company ID is provided as an argument rather than from the message. The session qualifier is used to distinguish sessions with the same target identifiers.
    
    Parameters:
    
    message - a FIX message
    
    senderCompID - the sender's company ID
    
    targetCompID - the target's company ID
    
    qualifier - a session qualifier
    
    Returns:
    
    true is send was successful, false otherwise
    
    Throws:
    
    SessionNotFound - if session could not be located
  - sendToTarget
```
public static boolean sendToTarget(Message message,
                                   SessionID sessionID)
                            throws SessionNotFound
```
    Send a message to the session specified by the provided session ID.
    
    Parameters:
    
    message - a FIX message
    
    sessionID - the target SessionID
    
    Returns:
    
    true is send was successful, false otherwise
    
    Throws:
    
    SessionNotFound - if session could not be located
  - lookupSession
```
public static Session lookupSession(SessionID sessionID)
```
    Locates a session specified by the provided session ID.
    
    Parameters:
    
    sessionID - the session ID
    
    Returns:
    
    the session, if found, or null otherwise
  - logon
```
public void logon()
```
    This method can be used to manually logon to a FIX session.
  - logout
```
public void logout()
```
    This method can be used to manually logout of a FIX session.
  - logout
```
public void logout(String reason)
```
    This method can be used to manually logout of a FIX session.
    
    Parameters:
    
    reason - this will be included in the logout message
  - isEnabled
```
public boolean isEnabled()
```
    Used internally
    
    Returns:
    
    true if session is enabled, false otherwise.
  - sentLogon
```
public boolean sentLogon()
```
    Predicate indicating whether a logon message has been sent. (QF Compatibility)
    
    Returns:
    
    true if logon message was sent, false otherwise.
  - receivedLogon
```
public boolean receivedLogon()
```
    Predicate indicating whether a logon message has been received. (QF Compatibility)
    
    Returns:
    
    true if logon message was received, false otherwise.
  - sentLogout
```
public boolean sentLogout()
```
    Predicate indicating whether a logout message has been sent. (QF Compatibility)
    
    Returns:
    
    true if logout message was sent, false otherwise.
  - receivedLogout
```
public boolean receivedLogout()
```
    Predicate indicating whether a logout message has been received. This can be used to determine if a session ended with an unexpected disconnect.
    
    Returns:
    
    true if logout message has been received, false otherwise.
  - isLoggedOn
```
public boolean isLoggedOn()
```
    Is the session logged on.
    
    Returns:
    
    true if logged on, false otherwise.
  - reset
```
public void reset()
```
    Logs out session (if logged on) and then resets session state.
    
    See Also:
    
    SessionState.reset()
  - setNextSenderMsgSeqNum
```
public void setNextSenderMsgSeqNum(int num)
                            throws IOException
```
    Set the next outgoing message sequence number. This method is not synchronized.
    
    Parameters:
    
    num - next outgoing sequence number
    
    Throws:
    
    IOException - IO error
  - setNextTargetMsgSeqNum
```
public void setNextTargetMsgSeqNum(int num)
                            throws IOException
```
    Set the next expected target message sequence number. This method is not synchronized.
    
    Parameters:
    
    num - next expected target sequence number
    
    Throws:
    
    IOException - IO error
  - getExpectedSenderNum
```
public int getExpectedSenderNum()
```
    Retrieves the expected sender sequence number. This method is not synchronized.
    
    Returns:
    
    next expected sender sequence number
  - getExpectedTargetNum
```
public int getExpectedTargetNum()
```
    Retrieves the expected target sequence number. This method is not synchronized.
    
    Returns:
    
    next expected target sequence number
  - getLog
```
public Log getLog()
```
  - getStore
```
public MessageStore getStore()
```
    Get the message store. (QF Compatibility)
    
    Returns:
    
    the message store
  - next
```
public void next(Message message)
          throws FieldNotFound,
                 RejectLogon,
                 IncorrectDataFormat,
                 IncorrectTagValue,
                 UnsupportedMessageType,
                 IOException,
                 InvalidMessage
```
    (Internal use only)
    
    Throws:
    
    FieldNotFound
    
    RejectLogon
    
    IncorrectDataFormat
    
    IncorrectTagValue
    
    UnsupportedMessageType
    
    IOException
    
    InvalidMessage
  - generateLogout
```
public void generateLogout()
```
  - next
```
public void next()
          throws IOException
```
    Called from the timer-related code in the acceptor/initiator implementations. This is not typically called from application code.
    
    Throws:
    
    IOException - IO error
  - generateHeartbeat
```
public void generateHeartbeat()
```
  - generateTestRequest
```
public void generateTestRequest(String id)
```
  - disconnect
```
public void disconnect(String reason,
                       boolean logError)
                throws IOException
```
    Logs out from session and closes the network connection. This method should not be called from user-code since it is likely to deadlock when called from a different thread than the Session thread and messages are sent/received concurrently. Instead the logout() method should be used where possible.
    
    Parameters:
    
    reason - the reason why the session is disconnected
    
    logError - set to true if this disconnection is an error
    
    Throws:
    
    IOException - IO error
  - send
```
public boolean send(Message message)
```
    Send a message to a counterparty. Sequence numbers and information about the sender and target identification will be added automatically (or overwritten if that information already is present). The returned status flag is included for compatibility with the JNI API but it's usefulness is questionable. In QuickFIX/J, the message is transmitted using asynchronous network I/O so the boolean only indicates the message was successfully queued for transmission. An error could still occur before the message data is actually sent.
    
    Parameters:
    
    message - the message to send
    
    Returns:
    
    a status flag indicating whether the write to the network layer was successful.
  - getDataDictionary
```
public DataDictionary getDataDictionary()
```
  - getDataDictionaryProvider
```
public DataDictionaryProvider getDataDictionaryProvider()
```
  - getSessionID
```
public SessionID getSessionID()
```
  - isSessionTime
```
public boolean isSessionTime()
```
    Predicate for determining if the session should be active at the current time.
    
    Returns:
    
    true if session should be active, false otherwise.
  - doesSessionExist
```
public static boolean doesSessionExist(SessionID sessionID)
```
    Determine if a session exists with the given ID.
    
    Parameters:
    
    sessionID -
    
    Returns:
    
    true if session exists, false otherwise.
  - numSessions
```
public static int numSessions()
```
    Return the session count.
    
    Returns:
    
    the number of sessions
  - setLogonTimeout
```
public void setLogonTimeout(int seconds)
```
    Sets the timeout for waiting for a logon response.
    
    Parameters:
    
    seconds - the timeout in seconds
  - setLogoutTimeout
```
public void setLogoutTimeout(int seconds)
```
    Sets the timeout for waiting for a logout response.
    
    Parameters:
    
    seconds - the timeout in seconds
  - setHeartBeatInterval
```
public void setHeartBeatInterval(int heartbeatInterval)
```
    Internal use by acceptor code.
    
    Parameters:
    
    heartbeatInterval -
  - getCheckCompID
```
public boolean getCheckCompID()
```
  - getLogonTimeout
```
public int getLogonTimeout()
```
  - getLogoutTimeout
```
public int getLogoutTimeout()
```
  - getRedundantResentRequestsAllowed
```
public boolean getRedundantResentRequestsAllowed()
```
  - getRefreshOnLogon
```
public boolean getRefreshOnLogon()
```
  - getResetOnDisconnect
```
public boolean getResetOnDisconnect()
```
  - getResetOnLogout
```
public boolean getResetOnLogout()
```
  - isLogonAlreadySent
```
public boolean isLogonAlreadySent()
```
  - isLogonReceived
```
public boolean isLogonReceived()
```
  - isLogonSendNeeded
```
public boolean isLogonSendNeeded()
```
  - isLogonSent
```
public boolean isLogonSent()
```
  - isLogonTimedOut
```
public boolean isLogonTimedOut()
```
  - isLogoutReceived
```
public boolean isLogoutReceived()
```
  - isLogoutSent
```
public boolean isLogoutSent()
```
  - isLogoutTimedOut
```
public boolean isLogoutTimedOut()
```
  - isValidateChecksum
```
public boolean isValidateChecksum()
```
  - isRejectGarbledMessage
```
public boolean isRejectGarbledMessage()
```
  - isUsingDataDictionary
```
public boolean isUsingDataDictionary()
```
  - getStartTime
```
public Date getStartTime()
                  throws IOException
```
    Throws:
    
    IOException
  - getTestRequestDelayMultiplier
```
public double getTestRequestDelayMultiplier()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - addStateListener
```
public void addStateListener(SessionStateListener listener)
```
  - removeStateListener
```
public void removeStateListener(SessionStateListener listener)
```
  - getStateListener
```
public SessionStateListener getStateListener()
```
  - getSenderDefaultApplicationVersionID
```
public ApplVerID getSenderDefaultApplicationVersionID()
```
    Returns:
    
    the default application version ID for messages sent from this session
  - getTargetDefaultApplicationVersionID
```
public ApplVerID getTargetDefaultApplicationVersionID()
```
    Returns:
    
    the default application version ID for messages received by this session
  - setTargetDefaultApplicationVersionID
```
public void setTargetDefaultApplicationVersionID(ApplVerID applVerID)
```
    Sets the default application version ID for messages received by this session. This is called by the AcceptorIoHandler upon reception of a Logon message and should not be called by user code.
    
    Parameters:
    
    applVerID -
  - extractExpectedSequenceNumber
```
protected static Integer extractExpectedSequenceNumber(String txt)
```
  - getMaxScheduledWriteRequests
```
public int getMaxScheduledWriteRequests()
```
  - setMaxScheduledWriteRequests
```
public void setMaxScheduledWriteRequests(int maxScheduledWriteRequests)
```
  - setIgnoreHeartBeatFailure
```
public void setIgnoreHeartBeatFailure(boolean ignoreHeartBeatFailure)
```
  - setRejectGarbledMessage
```
public void setRejectGarbledMessage(boolean rejectGarbledMessage)
```
  - setValidateChecksum
```
public void setValidateChecksum(boolean validateChecksum)
```
  - setRejectInvalidMessage
```
public void setRejectInvalidMessage(boolean rejectInvalidMessage)
```
  - setRejectMessageOnUnhandledException
```
public void setRejectMessageOnUnhandledException(boolean rejectMessageOnUnhandledException)
```
  - setRequiresOrigSendingTime
```
public void setRequiresOrigSendingTime(boolean requiresOrigSendingTime)
```
  - setForceResendWhenCorruptedStore
```
public void setForceResendWhenCorruptedStore(boolean forceResendWhenCorruptedStore)
```
  - isAllowedForSession
```
public boolean isAllowedForSession(InetAddress remoteInetAddress)
```
  - close
```
public void close()
           throws IOException
```
    Closes session resources and unregisters session. This is for internal use and should typically not be called by an user application.
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    Throws:
    
    IOException

Class Session

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SETTING_HEARTBTINT

SETTING_CHECK_LATENCY

SETTING_CHECK_COMP_ID

SETTING_MAX_LATENCY

SETTING_TEST_REQUEST_DELAY_MULTIPLIER

SETTING_HEARTBEAT_TIMEOUT_MULTIPLIER

SETTING_NON_STOP_SESSION

SETTING_START_DAY

SETTING_END_DAY

SETTING_TIMEZONE

SETTING_START_TIME

SETTING_END_TIME

SETTING_WEEKDAYS

SETTING_USE_DATA_DICTIONARY

SETTING_DATA_DICTIONARY

SETTING_TRANSPORT_DATA_DICTIONARY

SETTING_APP_DATA_DICTIONARY

SETTING_VALIDATE_FIELDS_OUT_OF_ORDER

SETTING_VALIDATE_UNORDERED_GROUP_FIELDS

SETTING_VALIDATE_FIELDS_HAVE_VALUES

SETTING_VALIDATE_INCOMING_MESSAGE

SETTING_LOGON_TIMEOUT

SETTING_LOGOUT_TIMEOUT

SETTING_LOGON_TAG

SETTING_RESET_ON_LOGOUT

SETTING_VALIDATE_SEQUENCE_NUMBERS

SETTING_RESET_ON_DISCONNECT

SETTING_RESET_ON_ERROR

SETTING_DISCONNECT_ON_ERROR

SETTING_TIMESTAMP_PRECISION

SETTING_VALIDATE_USER_DEFINED_FIELDS

SETTING_RESET_ON_LOGON

SETTING_DESCRIPTION

SETTING_REFRESH_ON_LOGON

SETTING_SEND_REDUNDANT_RESEND_REQUEST

SETTING_PERSIST_MESSAGES

SETTING_USE_CLOSED_RESEND_INTERVAL

SETTING_ALLOW_UNKNOWN_MSG_FIELDS

SETTING_DEFAULT_APPL_VER_ID

SETTING_DISABLE_HEART_BEAT_CHECK

SETTING_ENABLE_LAST_MSG_SEQ_NUM_PROCESSED

SETTING_ENABLE_NEXT_EXPECTED_MSG_SEQ_NUM

SETTING_REJECT_GARBLED_MESSAGE

SETTING_REJECT_INVALID_MESSAGE

SETTING_REJECT_MESSAGE_ON_UNHANDLED_EXCEPTION

SETTING_REQUIRES_ORIG_SENDING_TIME

SETTING_FORCE_RESEND_WHEN_CORRUPTED_STORE

SETTING_ALLOWED_REMOTE_ADDRESSES

SETTING_RESEND_REQUEST_CHUNK_SIZE

SETTING_MAX_SCHEDULED_WRITE_REQUESTS

SETTING_VALIDATE_CHECKSUM

DEFAULT_MAX_LATENCY

DEFAULT_RESEND_RANGE_CHUNK_SIZE

DEFAULT_TEST_REQUEST_DELAY_MULTIPLIER

DEFAULT_HEARTBEAT_TIMEOUT_MULTIPLIER

LOG

Method Detail

getMessageFactory

setResponder

getResponder

hasResponder

getRemoteAddress

sendToTarget

sendToTarget

sendToTarget

sendToTarget

sendToTarget

lookupSession

logon

logout

logout

isEnabled

sentLogon

receivedLogon

sentLogout