SessionParameters (FIX Antenna Java 2.24.0 API Documentation)

java.lang.Object
- com.epam.fixengine.SessionParameters

All Implemented Interfaces:

com.epam.fixengine.session.TradingSessionParameters, Cloneable

Direct Known Subclasses:

ScheduledSessionParameters
```
public class SessionParameters
extends Object
implements Cloneable, com.epam.fixengine.session.TradingSessionParameters
```
This bean contains all session level configuration for current session.
It is possible to confiniently define a list of custom FIX fields that will be added to each message. For more complex message customization take a look at

See Also:

for more precise customization

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`APP_VERSION_PROPERTY`
`protected com.epam.fixengine.configuration.FIXVersionContainer`	`appVersionContainer`
`static String`	`BACKUP_HOST_PROPERTY`
`static String`	`BACKUP_PORT_PROPERTY`
`protected com.epam.fixengine.configuration.Configuration`	`configuration`
`static int`	`DEFAULT_SEQUENCE_NUM`
`protected static boolean`	`defUseBlockingSockets`
`protected static boolean`	`defUseJavaNIO`
`protected static boolean`	`defUseSpinningRead`
`protected List<InetSocketAddress>`	`destinations`
`static String`	`FIX_FIELD_LIST_PROPERTY`
`static String`	`FIX_VERSION_PROPERTY`
`protected FIXFieldList`	`fixFieldList`
`protected com.epam.fixengine.configuration.FIXVersionContainer`	`fixVersionContainer`
`static String`	`HEARTBEAT_INTERVAL_PROPERTY`
`protected int`	`heartbeatInterval`
`protected String`	`host`
`static String`	`HOST_PROPERTY`
`static String`	`IN_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY`
`static String`	`INCOMING_LOGIN_FIX_FIELD_LIST_PROPERTY`
`static String`	`INCOMING_SEQUENCE_NUMBER_PROPERTY`
`protected FIXFieldList`	`incomingLoginFixFieldList`
`protected long`	`incomingSequenceNumber`
`static String`	`LAST_SEQ_NUM_RESET_TIMESTAMP_PROPERTY`
`protected long`	`lastSeqNumResetTimestamp`
`static String`	`OUT_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY`
`static String`	`OUTGOING_LOGIN_FIX_FIELD_LIST_PROPERTY`
`static String`	`OUTGOING_SEQUENCE_NUMBER_PROPERTY`
`protected FIXFieldList`	`outgoingLoginFixFieldList`
`protected long`	`outgoingSequenceNumber`
`static String`	`PASSWORD_PROPERTY`
`protected Integer`	`port`
`static String`	`PORT_PROPERTY`
`static String`	`SENDER_COMP_ID_PROPERTY`
`static String`	`SENDER_LOCATION_ID_PROPERTY`
`static String`	`SENDER_SUB_ID_PROPERTY`
`protected String`	`senderLocationId`
`protected String`	`senderSubId`
`static String`	`SESSION_ID_PROPERTY`
`static String`	`SESSION_QUALIFIER_PROPERTY`
`protected SessionID`	`sessionID`
`protected String`	`sessionSSLCipherSuite`
`protected Certificate[]`	`sessionSSLPeerCertificates`
`protected String`	`sessionSSLProtocol`
`static String`	`SOCKET_CONNECT_ADDRESS_PREFIX_PROPERTY`
`static String`	`TARGET_COMP_ID_PROPERTY`
`static String`	`TARGET_LOCATION_ID_PROPERTY`
`static String`	`TARGET_SUB_ID_PROPERTY`
`protected String`	`targetLocationId`
`protected String`	`targetSubId`
`protected TimeZone`	`timeZone`
`protected CronExpression`	`tradePeriodBegin`
`protected CronExpression`	`tradePeriodEnd`
`static String`	`USERNAME_PROPERTY`

Constructor Summary

Constructors
Constructor and Description

SessionParameters()

SessionParameters(com.epam.fixengine.configuration.Configuration config)

Constructors
Constructor and Description
`SessionParameters()`
`SessionParameters(com.epam.fixengine.configuration.Configuration config)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAllDestinations(Collection<InetSocketAddress> destinations)` Add alternative(backup) destinations for initiator.
`void`	`addDestination(InetSocketAddress destination)` Add alternative(backup) destination for initiator.
`void`	`addDestination(String host, int port)` Add alternative(backup) destination for initiator.
`void`	`addHeaderField(FIXField field)` Add user defined field.
`void`	`addOutgoingLoginField(FIXField field)` Deprecated.
`void`	`addOutgoingLoginField(int tag, byte value)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, byte[] value)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, byte[] value, int offset, int length)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, Calendar value, FIXDateFormatterFactory.FIX_DATE_TYPE type)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, CharSequence value)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, double value, int precision)` Add field to outgoing login fields list.
`void`	`addOutgoingLoginField(int tag, long value)` Add field to outgoing login fields list.
`Object`	`clone()` Creates and returns a copy of this object.
`FIXSession`	`createAcceptorSession()` Creates acceptor session in disconnected state
`FIXSession`	`createInitiatorSession()` Creates initiator session
`FIXSession`	`createNewFIXSession()` Deprecated. use `createAcceptorSession()` or `createInitiatorSession()` instead
`void`	`disableInSeqNumsOnNextConnect()`
`void`	`disableOutSeqNumsOnNextConnect()`
`boolean`	`equals(Object o)`
`void`	`fromConfiguration(com.epam.fixengine.configuration.Configuration configuration)`
`void`	`fromProperties(Properties properties)` Creates the SessionParameters from properties.
`FIXVersion`	`getAppVersion()` Gets App version.
`com.epam.fixengine.configuration.FIXVersionContainer`	`getAppVersionContainer()`
`String`	`getBackupHost()` Deprecated. use `getDestinations` method.
`int`	`getBackupPort()` Deprecated. use `getDestinations` method.
`com.epam.fixengine.configuration.Configuration`	`getConfiguration()`
`Map<String,Object>`	`getConnectivityParams()` Get additional configuration properties for transport.
`Function<String,Object>`	`getCustomLoader()` The loader is used for loading configurable classes.
`List<InetSocketAddress>`	`getDestinations()` Gets alternative(backup) destinations for initiator.
`com.epam.fixengine.encryption.EncryptionType`	`getEncryptionType()` Gets encryption type.
`FIXFieldList`	`getFixFieldList()` Gets user defined fields.
`FIXVersion`	`getFixVersion()` Gets fix version.
`com.epam.fixengine.configuration.FIXVersionContainer`	`getFixVersionContainer()`
`ForceSeqNumReset`	`getForceSeqNumReset()` Gets force sequence reset.
`int`	`getHeartbeatInterval()` Gets heartbeat interval.
`String`	`getHost()` Gets host.
`FIXFieldList`	`getIncomingLoginFixFieldList()` Gets incoming login fields.
`String`	`getIncomingPassword()`
`long`	`getIncomingSequenceNumber()`
`String`	`getIncomingUserName()`
`long`	`getLastSeqNumResetTimestamp()` Gets last seq num reset timestamp.
`FIXFieldList`	`getOutgoingLoginFixFieldList()` Gets outgoing login fields.
`long`	`getOutgoingSequenceNumber()`
`String`	`getPassword()`
`int`	`getPort()` Gets port.
`String`	`getSenderCompId()` Gets sender comp id.
`String`	`getSenderLocationId()` Gets sender location id.
`String`	`getSenderSubId()` Gets sender sub id.
`SessionID`	`getSessionId()`
`String`	`getSessionID()`
`String`	`getSessionQualifier()`
`String`	`getSessionSSLCipherSuite()`
`Certificate[]`	`getSessionSSLPeerCertificates()`
`String`	`getSessionSSLProtocol()`
`String`	`getTargetCompId()` Gets target comp id.
`String`	`getTargetLocationId()` Gets target location id.
`String`	`getTargetSubId()` Gets target sub id.
`TimeZone`	`getTimeZone()`
`CronExpression`	`getTradePeriodBegin()`
`CronExpression`	`getTradePeriodEnd()`
`String`	`getUserName()`
`int`	`hashCode()`
`boolean`	`hasPort()`
`boolean`	`isCustomSessionID()`
`boolean`	`isNeedToIncludeLastProcessed()`
`boolean`	`isSetInSeqNumsOnNextConnect()`
`boolean`	`isSetOutSeqNumsOnNextConnect()`
`boolean`	`isSetSeqNumsOnNextConnect()`
`boolean`	`isSimilar(SessionParameters other)` Return true if parameter object describe the same FIX session.
`boolean`	`isSimilar(SessionParameters other, List<String> errors)` Return true if parameter object describe the same FIX session.
`protected boolean`	`isUseBlockingSocket()`
`boolean`	`isUseJavaNIO()`
`static boolean`	`isUseJavaNIOByDefault()`
`protected boolean`	`isUseSpinningRead()`
`void`	`printConfiguration()`
`void`	`removeAllDestinations(Collection<InetSocketAddress> destinations)` Remove alternative(backup) destinations from connections list.
`void`	`removeDestination(InetSocketAddress destination)` Remove alternative(backup) destination from connections list.
`void`	`removeDestination(String host, int port)` Remove alternative(backup) destination from connections list.
`void`	`setAppVersion(FIXVersion appVersion)` Sets App version.
`void`	`setAppVersion(com.epam.fixengine.configuration.FIXVersionContainer appVersionContainer)`
`void`	`setAppVersion(String appVersion)` Sets App version.
`void`	`setBackupHost(String backupHost)` Deprecated. use `addDestination` method.
`void`	`setBackupPort(int backupPort)` Deprecated. use `addDestination` method.
`void`	`setConfiguration(com.epam.fixengine.configuration.Configuration configuration)` Setter for Configuration.
`void`	`setCustomLoader(Function<String,Object> handlersLoader)` The loader is used for loading configurable classes.
`void`	`setEncryptionType(com.epam.fixengine.encryption.EncryptionType encryptionType)` Sets encryption type.
`void`	`setFixFieldList(FIXFieldList fixFieldList)` Sets user defined fields.
`void`	`setFixVersion(FIXVersion fixVersion)` Sets fix version.
`void`	`setFixVersion(com.epam.fixengine.configuration.FIXVersionContainer fixVersionContainer)`
`void`	`setFixVersion(String fixVersion)` Sets fix version.
`void`	`setForceSeqNumReset(ForceSeqNumReset forceSeqNumReset)` Sets force sequence reset.
`void`	`setHeartbeatInterval(int heartbeatInterval)` Sets heartbeat interval.
`void`	`setHost(String host)` Sets host.
`void`	`setIncomingLoginFixFieldList(FIXFieldList incomingLoginFixFieldList)` Sets incoming login fields.
`void`	`setIncomingSequenceNumber(long incomingSequenceNumber)`
`void`	`setLastSeqNumResetTimestamp(long lastSeqNumResetTimestamp)` Sets last seq num reset timestamp.
`void`	`setOutgoingLoginFixFieldList(FIXFieldList outgoingLoginFixFieldList)` Sets outgoing login fields.
`void`	`setOutgoingSequenceNumber(long outgoingSequenceNumber)`
`void`	`setPassword(String password)`
`void`	`setPort(Integer port)` Sets port.
`void`	`setSenderCompId(String senderCompId)` Sets sender comp id.
`void`	`setSenderLocationId(String senderLocationId)` Sets sender location id.
`void`	`setSenderSubId(String senderSubId)` Sets sender sub id.
`void`	`setSessionID(String sessionId)` Change session identifier
`void`	`setSessionQualifier(String qualifier)`
`void`	`setSessionSSLCipherSuite(String sessionSSLCipherSuite)`
`void`	`setSessionSSLPeerCertificates(Certificate[] sessionSSLPeerCertificates)`
`void`	`setSessionSSLProtocol(String sessionSSLProtocol)`
`void`	`setTargetCompId(String targetCompId)` Sets target comp id.
`void`	`setTargetLocationId(String targetLocationId)` Sets target location id.
`void`	`setTargetSubId(String targetSubId)` Sets target sub id.
`void`	`setTimeZone(TimeZone timeZone)`
`void`	`setTradePeriodBegin(CronExpression cronExpression)`
`void`	`setTradePeriodEnd(CronExpression cronExpression)`
`void`	`setUserName(String username)`
`Properties`	`toProperties()` Creates and returns a copy of this object.
`String`	`toString()`

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

Methods inherited from interface com.epam.fixengine.session.TradingSessionParameters
clearTradePeriod, clearTradePeriodBegin, clearTradePeriodEnd, isOnlyPeriodBeginDefined, isTimestampAfterTradingPeriodBegin, isTimestampAfterTradingPeriodBegin, isTimestampAfterTradingPeriodEnd, isTimestampInTradingPeriod, isTradingPeriodDefined

- Field Detail
  - DEFAULT_SEQUENCE_NUM
```
public static final int DEFAULT_SEQUENCE_NUM
```
    See Also:
    
    Constant Field Values
  - SESSION_ID_PROPERTY
```
public static final String SESSION_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SENDER_COMP_ID_PROPERTY
```
public static final String SENDER_COMP_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TARGET_COMP_ID_PROPERTY
```
public static final String TARGET_COMP_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SESSION_QUALIFIER_PROPERTY
```
public static final String SESSION_QUALIFIER_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SENDER_SUB_ID_PROPERTY
```
public static final String SENDER_SUB_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SENDER_LOCATION_ID_PROPERTY
```
public static final String SENDER_LOCATION_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TARGET_SUB_ID_PROPERTY
```
public static final String TARGET_SUB_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - TARGET_LOCATION_ID_PROPERTY
```
public static final String TARGET_LOCATION_ID_PROPERTY
```
    See Also:
    
    Constant Field Values
  - HOST_PROPERTY
```
public static final String HOST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PORT_PROPERTY
```
public static final String PORT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - APP_VERSION_PROPERTY
```
public static final String APP_VERSION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - FIX_VERSION_PROPERTY
```
public static final String FIX_VERSION_PROPERTY
```
    See Also:
    
    Constant Field Values
  - HEARTBEAT_INTERVAL_PROPERTY
```
public static final String HEARTBEAT_INTERVAL_PROPERTY
```
    See Also:
    
    Constant Field Values
  - LAST_SEQ_NUM_RESET_TIMESTAMP_PROPERTY
```
public static final String LAST_SEQ_NUM_RESET_TIMESTAMP_PROPERTY
```
    See Also:
    
    Constant Field Values
  - FIX_FIELD_LIST_PROPERTY
```
public static final String FIX_FIELD_LIST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - INCOMING_LOGIN_FIX_FIELD_LIST_PROPERTY
```
public static final String INCOMING_LOGIN_FIX_FIELD_LIST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - OUTGOING_LOGIN_FIX_FIELD_LIST_PROPERTY
```
public static final String OUTGOING_LOGIN_FIX_FIELD_LIST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - USERNAME_PROPERTY
```
public static final String USERNAME_PROPERTY
```
    See Also:
    
    Constant Field Values
  - PASSWORD_PROPERTY
```
public static final String PASSWORD_PROPERTY
```
    See Also:
    
    Constant Field Values
  - IN_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY
```
public static final String IN_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - INCOMING_SEQUENCE_NUMBER_PROPERTY
```
public static final String INCOMING_SEQUENCE_NUMBER_PROPERTY
```
    See Also:
    
    Constant Field Values
  - OUT_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY
```
public static final String OUT_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - OUTGOING_SEQUENCE_NUMBER_PROPERTY
```
public static final String OUTGOING_SEQUENCE_NUMBER_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SOCKET_CONNECT_ADDRESS_PREFIX_PROPERTY
```
public static final String SOCKET_CONNECT_ADDRESS_PREFIX_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BACKUP_HOST_PROPERTY
```
public static final String BACKUP_HOST_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BACKUP_PORT_PROPERTY
```
public static final String BACKUP_PORT_PROPERTY
```
    See Also:
    
    Constant Field Values
  - defUseSpinningRead
```
protected static boolean defUseSpinningRead
```
  - defUseBlockingSockets
```
protected static boolean defUseBlockingSockets
```
  - defUseJavaNIO
```
protected static boolean defUseJavaNIO
```
  - senderSubId
```
protected String senderSubId
```
  - targetSubId
```
protected String targetSubId
```
  - senderLocationId
```
protected String senderLocationId
```
  - targetLocationId
```
protected String targetLocationId
```
  - sessionID
```
protected SessionID sessionID
```
  - heartbeatInterval
```
protected int heartbeatInterval
```
  - fixVersionContainer
```
protected com.epam.fixengine.configuration.FIXVersionContainer fixVersionContainer
```
  - appVersionContainer
```
protected com.epam.fixengine.configuration.FIXVersionContainer appVersionContainer
```
  - host
```
protected String host
```
  - port
```
protected Integer port
```
  - fixFieldList
```
protected FIXFieldList fixFieldList
```
  - incomingLoginFixFieldList
```
protected FIXFieldList incomingLoginFixFieldList
```
  - outgoingLoginFixFieldList
```
protected FIXFieldList outgoingLoginFixFieldList
```
  - configuration
```
protected com.epam.fixengine.configuration.Configuration configuration
```
  - destinations
```
protected List<InetSocketAddress> destinations
```
  - lastSeqNumResetTimestamp
```
protected long lastSeqNumResetTimestamp
```
  - incomingSequenceNumber
```
protected long incomingSequenceNumber
```
  - outgoingSequenceNumber
```
protected long outgoingSequenceNumber
```
  - tradePeriodBegin
```
protected CronExpression tradePeriodBegin
```
  - tradePeriodEnd
```
protected CronExpression tradePeriodEnd
```
  - timeZone
```
protected TimeZone timeZone
```
  - sessionSSLProtocol
```
protected String sessionSSLProtocol
```
  - sessionSSLCipherSuite
```
protected String sessionSSLCipherSuite
```
  - sessionSSLPeerCertificates
```
protected Certificate[] sessionSSLPeerCertificates
```
- Constructor Detail
  - SessionParameters
```
public SessionParameters(com.epam.fixengine.configuration.Configuration config)
```
  - SessionParameters
```
public SessionParameters()
```
- Method Detail
  - getConnectivityParams
```
public Map<String,Object> getConnectivityParams()
```
    Get additional configuration properties for transport.
    
    Returns:
  - isUseBlockingSocket
```
protected boolean isUseBlockingSocket()
```
  - isUseSpinningRead
```
protected boolean isUseSpinningRead()
```
  - getConfiguration
```
public com.epam.fixengine.configuration.Configuration getConfiguration()
```
  - setConfiguration
```
public void setConfiguration(com.epam.fixengine.configuration.Configuration configuration)
```
    Setter for Configuration.
    
    Parameters:
    
    configuration - the configuration
  - getFixVersion
```
public FIXVersion getFixVersion()
```
    Gets fix version.
  - setFixVersion
```
public void setFixVersion(FIXVersion fixVersion)
```
    Sets fix version.
    if fix version is above FIX.5.0 the app version should be FIXT.1.1
    
    Parameters:
    
    fixVersion - the fix version
  - setFixVersion
```
public void setFixVersion(String fixVersion)
```
    Sets fix version.
    if fix version is above FIX.5.0 the app version should be "FIXT.1.1"
    
    Parameters:
    
    fixVersion - the fix version
  - getAppVersion
```
public FIXVersion getAppVersion()
```
    Gets App version.
  - setAppVersion
```
public void setAppVersion(FIXVersion appVersion)
```
    Sets App version.
    
    Parameters:
    
    appVersion - the app version
  - setAppVersion
```
public void setAppVersion(String appVersion)
```
    Sets App version. The parameter can be a name of FIX version like "FIX.4.2" or a numeric representation from 2 to 9(FIX.4.0 ... FIX.5.0 sp2).
    
    Parameters:
    
    appVersion - the app version
  - getFixVersionContainer
```
public com.epam.fixengine.configuration.FIXVersionContainer getFixVersionContainer()
```
  - setFixVersion
```
public void setFixVersion(com.epam.fixengine.configuration.FIXVersionContainer fixVersionContainer)
```
  - getAppVersionContainer
```
public com.epam.fixengine.configuration.FIXVersionContainer getAppVersionContainer()
```
  - setAppVersion
```
public void setAppVersion(com.epam.fixengine.configuration.FIXVersionContainer appVersionContainer)
```
  - getFixFieldList
```
public FIXFieldList getFixFieldList()
```
    Gets user defined fields.
    If this list is not empty, Engine add it to each outgoing message.
  - setFixFieldList
```
public void setFixFieldList(FIXFieldList fixFieldList)
```
    Sets user defined fields.
    If this list is not empty, Engine add it to each outgoing message.
    
    Parameters:
    
    fixFieldList - the user defined fields
  - addHeaderField
```
public void addHeaderField(FIXField field)
```
    Add user defined field.
    
    Parameters:
    
    field - the field
  - getSenderCompId
```
public String getSenderCompId()
```
    Gets sender comp id.
  - setSenderCompId
```
public void setSenderCompId(String senderCompId)
```
    Sets sender comp id.
    
    Parameters:
    
    senderCompId - the sender comp id
  - getTargetCompId
```
public String getTargetCompId()
```
    Gets target comp id.
  - setTargetCompId
```
public void setTargetCompId(String targetCompId)
```
    Sets target comp id.
    
    Parameters:
    
    targetCompId - the target comp id
  - getSenderSubId
```
public String getSenderSubId()
```
    Gets sender sub id.
  - setSenderSubId
```
public void setSenderSubId(String senderSubId)
```
    Sets sender sub id.
    
    Parameters:
    
    senderSubId - the sender sub id
  - getTargetSubId
```
public String getTargetSubId()
```
    Gets target sub id.
  - setTargetSubId
```
public void setTargetSubId(String targetSubId)
```
    Sets target sub id.
    
    Parameters:
    
    targetSubId - the target sub id
  - getSenderLocationId
```
public String getSenderLocationId()
```
    Gets sender location id.
  - setSenderLocationId
```
public void setSenderLocationId(String senderLocationId)
```
    Sets sender location id.
    
    Parameters:
    
    senderLocationId - the sender location id
  - getTargetLocationId
```
public String getTargetLocationId()
```
    Gets target location id.
  - setTargetLocationId
```
public void setTargetLocationId(String targetLocationId)
```
    Sets target location id.
    
    Parameters:
    
    targetLocationId - the target location id
  - getSessionID
```
public String getSessionID()
```
  - getSessionId
```
public SessionID getSessionId()
```
  - setSessionID
```
public void setSessionID(String sessionId)
```
    Change session identifier
    
    Parameters:
    
    sessionId - unique string value. maximum 200 characters length. Allowed characters: a-z, A-Z, 0-9, '.', '-', '_', ' '(space) and '!'
  - setSessionQualifier
```
public void setSessionQualifier(String qualifier)
```
  - getSessionQualifier
```
public String getSessionQualifier()
```
  - isCustomSessionID
```
public boolean isCustomSessionID()
```
  - getHeartbeatInterval
```
public int getHeartbeatInterval()
```
    Gets heartbeat interval.
  - setHeartbeatInterval
```
public void setHeartbeatInterval(int heartbeatInterval)
```
    Sets heartbeat interval.
    
    Parameters:
    
    heartbeatInterval - the HBI, default value is 30.
  - getHost
```
public String getHost()
```
    Gets host.
  - setHost
```
public void setHost(String host)
```
    Sets host.
    
    Parameters:
    
    host - the host
  - hasPort
```
public boolean hasPort()
```
  - getPort
```
public int getPort()
```
    Gets port.
  - setPort
```
public void setPort(Integer port)
```
    Sets port.
    
    Parameters:
    
    port - the port
  - getSessionSSLProtocol
```
public String getSessionSSLProtocol()
```
  - setSessionSSLProtocol
```
public void setSessionSSLProtocol(String sessionSSLProtocol)
```
  - getSessionSSLCipherSuite
```
public String getSessionSSLCipherSuite()
```
  - setSessionSSLCipherSuite
```
public void setSessionSSLCipherSuite(String sessionSSLCipherSuite)
```
  - getSessionSSLPeerCertificates
```
public Certificate[] getSessionSSLPeerCertificates()
```
  - setSessionSSLPeerCertificates
```
public void setSessionSSLPeerCertificates(Certificate[] sessionSSLPeerCertificates)
```
  - getForceSeqNumReset
```
public ForceSeqNumReset getForceSeqNumReset()
```
    Gets force sequence reset.
  - setForceSeqNumReset
```
public void setForceSeqNumReset(ForceSeqNumReset forceSeqNumReset)
```
    Sets force sequence reset.
    
    Parameters:
    
    forceSeqNumReset - the forceSeqNumReset
  - setUserName
```
public void setUserName(String username)
```
  - getUserName
```
public String getUserName()
```
  - setPassword
```
public void setPassword(String password)
```
  - getPassword
```
public String getPassword()
```
  - getIncomingUserName
```
public String getIncomingUserName()
```
  - getIncomingPassword
```
public String getIncomingPassword()
```
  - getIncomingLoginFixFieldList
```
public FIXFieldList getIncomingLoginFixFieldList()
```
    Gets incoming login fields.
    
    Returns:
    
    FIXFieldList list of field
  - setIncomingLoginFixFieldList
```
public void setIncomingLoginFixFieldList(FIXFieldList incomingLoginFixFieldList)
```
    Sets incoming login fields. Engine used incomingLoginFixFieldList only for acceptor session.
    
    Parameters:
    
    incomingLoginFixFieldList - the incoming login fix field list
  - getOutgoingLoginFixFieldList
```
public FIXFieldList getOutgoingLoginFixFieldList()
```
    Gets outgoing login fields.
    This parameter used only for initiator session, Engine added outgoingLoginFixFieldList to login message.
    
    Returns:
    
    list of fields
  - setOutgoingLoginFixFieldList
```
public void setOutgoingLoginFixFieldList(FIXFieldList outgoingLoginFixFieldList)
```
    Sets outgoing login fields.
    
    Parameters:
    
    outgoingLoginFixFieldList - the list of outgoing fields
  - addOutgoingLoginField
```
@Deprecated
public void addOutgoingLoginField(FIXField field)
```
    Deprecated.
    
    Add field to outgoing login fields list.
    
    Parameters:
    
    field - login field
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  CharSequence value)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  byte value)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  byte[] value)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  byte[] value,
                                  int offset,
                                  int length)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  long value)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  double value,
                                  int precision)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - addOutgoingLoginField
```
public void addOutgoingLoginField(int tag,
                                  Calendar value,
                                  FIXDateFormatterFactory.FIX_DATE_TYPE type)
```
    Add field to outgoing login fields list.
    
    Parameters:
    
    tag -
    
    value -
  - getEncryptionType
```
public com.epam.fixengine.encryption.EncryptionType getEncryptionType()
```
    Gets encryption type.
    
    Returns:
    
    EncryptionType
  - setEncryptionType
```
public void setEncryptionType(com.epam.fixengine.encryption.EncryptionType encryptionType)
```
    Sets encryption type.
    
    Parameters:
    
    encryptionType - the encryption type
  - clone
```
public Object clone()
             throws CloneNotSupportedException
```
    Creates and returns a copy of this object.
    
    Overrides:
    
    clone in class Object
    
    Returns:
    
    SessionParameters
    
    Throws:
    
    CloneNotSupportedException
  - toProperties
```
public Properties toProperties()
```
    Creates and returns a copy of this object. The engine calls this method when the specific parameters should be serialized to properties.
  - fromProperties
```
public void fromProperties(Properties properties)
```
    Creates the SessionParameters from properties. The engine calls this method when the stored parameters should be de-serialized from properties.
    
    Parameters:
    
    properties - the properties
  - fromConfiguration
```
public void fromConfiguration(com.epam.fixengine.configuration.Configuration configuration)
```
  - getLastSeqNumResetTimestamp
```
public long getLastSeqNumResetTimestamp()
```
    Gets last seq num reset timestamp.
  - setLastSeqNumResetTimestamp
```
public void setLastSeqNumResetTimestamp(long lastSeqNumResetTimestamp)
```
    Sets last seq num reset timestamp.
    
    Parameters:
    
    lastSeqNumResetTimestamp - the timestamp
  - isSetSeqNumsOnNextConnect
```
public boolean isSetSeqNumsOnNextConnect()
```
  - isSetInSeqNumsOnNextConnect
```
public boolean isSetInSeqNumsOnNextConnect()
```
  - isSetOutSeqNumsOnNextConnect
```
public boolean isSetOutSeqNumsOnNextConnect()
```
  - setIncomingSequenceNumber
```
public void setIncomingSequenceNumber(long incomingSequenceNumber)
```
  - setOutgoingSequenceNumber
```
public void setOutgoingSequenceNumber(long outgoingSequenceNumber)
```
  - getIncomingSequenceNumber
```
public long getIncomingSequenceNumber()
```
  - getOutgoingSequenceNumber
```
public long getOutgoingSequenceNumber()
```
  - disableInSeqNumsOnNextConnect
```
public void disableInSeqNumsOnNextConnect()
```
  - disableOutSeqNumsOnNextConnect
```
public void disableOutSeqNumsOnNextConnect()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getBackupHost
```
@Deprecated
public String getBackupHost()
```
    Deprecated. use getDestinations method.
    
    Gets backup host.
  - getBackupPort
```
@Deprecated
public int getBackupPort()
```
    Deprecated. use getDestinations method.
    
    Gets backup port.
  - setBackupHost
```
@Deprecated
public void setBackupHost(String backupHost)
```
    Deprecated. use addDestination method.
    
    Sets backup host.
    
    Parameters:
    
    backupHost - the backup port
  - setBackupPort
```
@Deprecated
public void setBackupPort(int backupPort)
```
    Deprecated. use addDestination method.
    
    Sets backup port.
    
    Parameters:
    
    backupPort - the backup port
  - getDestinations
```
public List<InetSocketAddress> getDestinations()
```
    Gets alternative(backup) destinations for initiator.
    
    Returns:
    
    list of alternative destinations.
  - addDestination
```
public void addDestination(String host,
                           int port)
```
    Add alternative(backup) destination for initiator.
    
    Parameters:
    
    host - backup host
    
    port - backup port
  - addDestination
```
public void addDestination(InetSocketAddress destination)
```
    Add alternative(backup) destination for initiator.
    
    Parameters:
    
    destination - backup address
  - addAllDestinations
```
public void addAllDestinations(Collection<InetSocketAddress> destinations)
```
    Add alternative(backup) destinations for initiator.
    
    Parameters:
    
    destinations - backup addresses
  - removeDestination
```
public void removeDestination(String host,
                              int port)
```
    Remove alternative(backup) destination from connections list.
    
    Parameters:
    
    host - backup host
    
    port - backup port
  - removeDestination
```
public void removeDestination(InetSocketAddress destination)
```
    Remove alternative(backup) destination from connections list.
    
    Parameters:
    
    destination - backup address
  - removeAllDestinations
```
public void removeAllDestinations(Collection<InetSocketAddress> destinations)
```
    Remove alternative(backup) destinations from connections list.
    
    Parameters:
    
    destinations - backup addresses
  - createNewFIXSession
```
public FIXSession createNewFIXSession()
                               throws IOException
```
    Deprecated. use createAcceptorSession() or createInitiatorSession() instead
    
    Creates initiator fix session.
    User can use StandardFIXSessionFactory.getFactory(SessionParameters).createInitiatorSession(SessionParameters) instead this method.
    
    Throws:
    
    IOException
  - createAcceptorSession
```
public FIXSession createAcceptorSession()
                                 throws IOException
```
    Creates acceptor session in disconnected state
    
    Returns:
    
    FIX session
    
    Throws:
    
    IOException
  - createInitiatorSession
```
public FIXSession createInitiatorSession()
                                  throws IOException
```
    Creates initiator session
    
    Returns:
    
    FIX session
    
    Throws:
    
    IOException
  - printConfiguration
```
public void printConfiguration()
```
  - isNeedToIncludeLastProcessed
```
public boolean isNeedToIncludeLastProcessed()
```
  - setCustomLoader
```
public void setCustomLoader(Function<String,Object> handlersLoader)
```
    The loader is used for loading configurable classes.
    
    Parameters:
    
    handlersLoader -
  - getCustomLoader
```
public Function<String,Object> getCustomLoader()
```
    The loader is used for loading configurable classes.
  - isUseJavaNIO
```
public boolean isUseJavaNIO()
```
  - isUseJavaNIOByDefault
```
public static boolean isUseJavaNIOByDefault()
```
  - isSimilar
```
public boolean isSimilar(SessionParameters other)
```
    Return true if parameter object describe the same FIX session.
    
    Parameters:
    
    other -
    
    Returns:
  - isSimilar
```
public boolean isSimilar(SessionParameters other,
                         List<String> errors)
```
    Return true if parameter object describe the same FIX session.
    
    Parameters:
    
    other -
    
    Returns:
  - getTradePeriodBegin
```
public CronExpression getTradePeriodBegin()
```
    Specified by:
    
    getTradePeriodBegin in interface com.epam.fixengine.session.TradingSessionParameters
  - setTradePeriodBegin
```
public void setTradePeriodBegin(CronExpression cronExpression)
```
    Specified by:
    
    setTradePeriodBegin in interface com.epam.fixengine.session.TradingSessionParameters
  - getTradePeriodEnd
```
public CronExpression getTradePeriodEnd()
```
    Specified by:
    
    getTradePeriodEnd in interface com.epam.fixengine.session.TradingSessionParameters
  - setTradePeriodEnd
```
public void setTradePeriodEnd(CronExpression cronExpression)
```
    Specified by:
    
    setTradePeriodEnd in interface com.epam.fixengine.session.TradingSessionParameters
  - getTimeZone
```
public TimeZone getTimeZone()
```
    Specified by:
    
    getTimeZone in interface com.epam.fixengine.session.TradingSessionParameters
  - setTimeZone
```
public void setTimeZone(TimeZone timeZone)
```
    Specified by:
    
    setTimeZone in interface com.epam.fixengine.session.TradingSessionParameters

Class SessionParameters

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.epam.fixengine.session.TradingSessionParameters

Field Detail

DEFAULT_SEQUENCE_NUM

SESSION_ID_PROPERTY

SENDER_COMP_ID_PROPERTY

TARGET_COMP_ID_PROPERTY

SESSION_QUALIFIER_PROPERTY

SENDER_SUB_ID_PROPERTY

SENDER_LOCATION_ID_PROPERTY

TARGET_SUB_ID_PROPERTY

TARGET_LOCATION_ID_PROPERTY

HOST_PROPERTY

PORT_PROPERTY

APP_VERSION_PROPERTY

FIX_VERSION_PROPERTY

HEARTBEAT_INTERVAL_PROPERTY

LAST_SEQ_NUM_RESET_TIMESTAMP_PROPERTY

FIX_FIELD_LIST_PROPERTY

INCOMING_LOGIN_FIX_FIELD_LIST_PROPERTY

OUTGOING_LOGIN_FIX_FIELD_LIST_PROPERTY

USERNAME_PROPERTY

PASSWORD_PROPERTY

IN_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY

INCOMING_SEQUENCE_NUMBER_PROPERTY

OUT_SEQ_NUMS_FOR_NEXT_CONNECT_PROPERTY

OUTGOING_SEQUENCE_NUMBER_PROPERTY

SOCKET_CONNECT_ADDRESS_PREFIX_PROPERTY

BACKUP_HOST_PROPERTY

BACKUP_PORT_PROPERTY

defUseSpinningRead

defUseBlockingSockets

defUseJavaNIO

senderSubId

targetSubId

senderLocationId

targetLocationId

sessionID

heartbeatInterval

fixVersionContainer

appVersionContainer

host

port

fixFieldList

incomingLoginFixFieldList

outgoingLoginFixFieldList

configuration

destinations

lastSeqNumResetTimestamp

incomingSequenceNumber

outgoingSequenceNumber

tradePeriodBegin

tradePeriodEnd

timeZone

sessionSSLProtocol

sessionSSLCipherSuite

sessionSSLPeerCertificates

Constructor Detail

SessionParameters

SessionParameters

Method Detail

getConnectivityParams

isUseBlockingSocket

isUseSpinningRead

getConfiguration

setConfiguration

getFixVersion

setFixVersion

setFixVersion

getAppVersion

setAppVersion

setAppVersion

getFixVersionContainer

setFixVersion

getAppVersionContainer

setAppVersion