uk.co.real_logic.artio.ilink

Class ILink3ConnectionConfiguration.Builder

java.lang.Object

uk.co.real_logic.artio.ilink.ILink3ConnectionConfiguration.Builder

Enclosing class:

ILink3ConnectionConfiguration

public static final class ILink3ConnectionConfiguration.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ILink3ConnectionConfiguration.Builder	accessKeyId(java.lang.String accessKeyId) Sets the key id used by the HMAC encryption.
ILink3ConnectionConfiguration.Builder	backupHost(java.lang.String backupHost) Sets the backup host IP to connect to.
ILink3ConnectionConfiguration	build()
ILink3ConnectionConfiguration.Builder	firmId(java.lang.String firmId) Sets the firmId used in the Negotiate and Establish messages.
ILink3ConnectionConfiguration.Builder	handler(ILink3ConnectionHandler handler) Sets your callback handler in order to receive business / application level messages from the exchange.
ILink3ConnectionConfiguration.Builder	host(java.lang.String host) Sets the host IP to connect to.
ILink3ConnectionConfiguration.Builder	initialReceivedSequenceNumber(long initialReceivedSequenceNumber) Sets the sequence number that is expected by your session upon session establishment from the exchange.
ILink3ConnectionConfiguration.Builder	initialSentSequenceNumber(long initialSentSequenceNumber) Sets the sequence number that is sent by your session upon session establishment.
ILink3ConnectionConfiguration.Builder	maxRetransmitQueueSizeInBytes(int maxRetransmitQueueSize) Sets the maximum size for the retransmit queue.
ILink3ConnectionConfiguration.Builder	port(int port) Sets the host port to connect to.
ILink3ConnectionConfiguration.Builder	reEstablishLastConnection(boolean reEstablishLastConnection) Enable a re-establishment of the same session with the same UUID, rather than generating a new UUID.
ILink3ConnectionConfiguration.Builder	requestedKeepAliveIntervalInMs(int requestedKeepAliveIntervalInMs) Sets the keepAliveInterval used in the Establish message.
ILink3ConnectionConfiguration.Builder	retransmitNotificationTimeoutInMs(int retransmitNotificationTimeoutInMs) Sets a timeout used in retransmit operations.
ILink3ConnectionConfiguration.Builder	sessionId(java.lang.String sessionId) Sets the sessionId used in the Negotiate and Establish messages.
ILink3ConnectionConfiguration.Builder	tradingSystemName(java.lang.String tradingSystemName) Sets the tradingSystemName used in the Establish message.
ILink3ConnectionConfiguration.Builder	tradingSystemVendor(java.lang.String tradingSystemVendor) Sets the tradingSystemVendor used in the Establish message.
ILink3ConnectionConfiguration.Builder	tradingSystemVersion(java.lang.String tradingSystemVersion) Sets the tradingSystemVersion used in the Establish message.
ILink3ConnectionConfiguration.Builder	useBackupHost(boolean useBackupHost) Sets whether you're connecting to the normal primary or the backup IP address.
ILink3ConnectionConfiguration.Builder	userKey(java.lang.String userKey) Sets the key used to by the HMAC encryption in the Negotiate and Establish messages.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public ILink3ConnectionConfiguration build()

host

public ILink3ConnectionConfiguration.Builder host(java.lang.String host)

Sets the host IP to connect to.

Parameters:

host - the host IP to connect to.

Returns:

this

port

public ILink3ConnectionConfiguration.Builder port(int port)

Sets the host port to connect to.

Parameters:

port - the host port to connect to.

Returns:

this

sessionId

public ILink3ConnectionConfiguration.Builder sessionId(java.lang.String sessionId)

Sets the sessionId used in the Negotiate and Establish messages.

Parameters:

sessionId - the sessionId used in the Negotiate and Establish messages.

Returns:

this

firmId

public ILink3ConnectionConfiguration.Builder firmId(java.lang.String firmId)

Sets the firmId used in the Negotiate and Establish messages.

Parameters:

firmId - the firmId used in the Negotiate and Establish messages.

Returns:

this

tradingSystemName

public ILink3ConnectionConfiguration.Builder tradingSystemName(java.lang.String tradingSystemName)

Sets the tradingSystemName used in the Establish message.

Parameters:

tradingSystemName - the tradingSystemName used in the Establish message.

Returns:

this

tradingSystemVersion

public ILink3ConnectionConfiguration.Builder tradingSystemVersion(java.lang.String tradingSystemVersion)

Sets the tradingSystemVersion used in the Establish message.

Parameters:

tradingSystemVersion - the tradingSystemVersion used in the Establish message.

Returns:

this

tradingSystemVendor

public ILink3ConnectionConfiguration.Builder tradingSystemVendor(java.lang.String tradingSystemVendor)

Sets the tradingSystemVendor used in the Establish message.

Parameters:

tradingSystemVendor - the tradingSystemVendor used in the Establish message.

Returns:

this

requestedKeepAliveIntervalInMs

public ILink3ConnectionConfiguration.Builder requestedKeepAliveIntervalInMs(int requestedKeepAliveIntervalInMs)

Sets the keepAliveInterval used in the Establish message. This is specified in milliseconds and used as a timeout period by the iLink3 session. Sequence messages will be used to keep the session alive after this interval passes and sessions will be terminated if twice this length passes without a reply from the exchange.

Parameters:

requestedKeepAliveIntervalInMs - the keepAliveInterval used in the Establish message.

Returns:

this

accessKeyId

public ILink3ConnectionConfiguration.Builder accessKeyId(java.lang.String accessKeyId)

Sets the key id used by the HMAC encryption. This is the ID for the userKey(String) parameter. This key id will be generated by the CME and can be downloaded from their Request Center along with the user key.

Parameters:

accessKeyId - the key id used by the HMAC encryption.

Returns:

this

See Also:

userKey(String)

userKey

public ILink3ConnectionConfiguration.Builder userKey(java.lang.String userKey)

Sets the key used to by the HMAC encryption in the Negotiate and Establish messages. This key will be generated by the CME and can be downloaded from their Request Center. It may also be referred as "the secret key".

Parameters:

userKey - the key used to by the HMAC encryption in the Negotiate and Establish messages.

Returns:

this

initialSentSequenceNumber

public ILink3ConnectionConfiguration.Builder initialSentSequenceNumber(long initialSentSequenceNumber)

Sets the sequence number that is sent by your session upon session establishment. The default is AUTOMATIC_INITIAL_SEQUENCE_NUMBER which will start from 1 if this is a new UUID or continuing from the last known sequence number if reEstablishLastConnection(boolean) is set to true.

Parameters:

initialSentSequenceNumber - the sequence that is sent by your session upon session establishment

Returns:

this

initialReceivedSequenceNumber

public ILink3ConnectionConfiguration.Builder initialReceivedSequenceNumber(long initialReceivedSequenceNumber)

Sets the sequence number that is expected by your session upon session establishment from the exchange. The default is AUTOMATIC_INITIAL_SEQUENCE_NUMBER which will start from 1 if this is a new UUID or continuing from the last known sequence number if reEstablishLastConnection(boolean) is set to true.

Parameters:

initialReceivedSequenceNumber - the sequence number that is expected by your session upon session establishment from the exchange

Returns:

this

reEstablishLastConnection

public ILink3ConnectionConfiguration.Builder reEstablishLastConnection(boolean reEstablishLastConnection)

Enable a re-establishment of the same session with the same UUID, rather than generating a new UUID. If there is an existing UUID associated with this session identifier then that will be used. The session identifier here is a triple of (port, host and accessKeyId).

Note: if this session has never connected before then a new UUID will be generated.

Parameters:

reEstablishLastConnection - true to re-establish the connection, false otherwise.

Returns:

this.

handler

public ILink3ConnectionConfiguration.Builder handler(ILink3ConnectionHandler handler)

Sets your callback handler in order to receive business / application level messages from the exchange.

Parameters:

handler - your callback handler in order to receive business / application level messages from the exchange.

Returns:

this

useBackupHost

public ILink3ConnectionConfiguration.Builder useBackupHost(boolean useBackupHost)

Sets whether you're connecting to the normal primary or the backup IP address. Used in failover scenarios.

Parameters:

useBackupHost - true to connect to the backup host

Returns:

this

backupHost

public ILink3ConnectionConfiguration.Builder backupHost(java.lang.String backupHost)

Sets the backup host IP to connect to.

Parameters:

backupHost - the backup host IP to connect to.

Returns:

this

maxRetransmitQueueSizeInBytes

public ILink3ConnectionConfiguration.Builder maxRetransmitQueueSizeInBytes(int maxRetransmitQueueSize)

Sets the maximum size for the retransmit queue. This is an in-memory on heap buffer that is used to queue received messages from a server that were sent out of order whilst a retransmit is occurring. The maximum allows users to stop OOME from occuring in the case of large retransmits.

Parameters:

maxRetransmitQueueSize - the maximum size for the retransmit queue.

Returns:

this

retransmitNotificationTimeoutInMs

public ILink3ConnectionConfiguration.Builder retransmitNotificationTimeoutInMs(int retransmitNotificationTimeoutInMs)

Sets a timeout used in retransmit operations. The timeout is started when a retransmit request is sent. If this timeout is breached then the FixPConnectionHandler.onRetransmitTimeout(FixPConnection) method will be invoked. This notification could be used to cancel the retransmit or inform operators, traders or algorithms that it's taking a while to get sequence numbers back into sync. The timeout doesn't not in and of itself cancel the retransmit request - just call the callback.

Parameters:

retransmitNotificationTimeoutInMs - timeout for receiving a notification when retransmit operations take too long to be filled.

Returns:

this