biz.onixs.cme.ilink3.testing

Class Emulator

java.lang.Object

biz.onixs.cme.ilink3.testing.Emulator

public class Emulator
extends Object

Emulator class for simulating a network endpoint in FIXP protocol tests. Handles connection management, message handling, and session lifecycle events.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Emulator.MessageListener

Constructor Summary

Constructors

Constructor and Description
Emulator(TestUtility testUtility) Constructs an Emulator instance with a reference to a TestUtility object.

Method Summary

Modifier and Type	Method and Description
void	acceptConnection() Accepts an incoming TCP connection.
void	acceptConnection(TestAcceptorTask acceptorTask) Accepts an incoming TCP connection and prepares the Emulator for communication.
IMessage	acceptEstablishment() Accepts an "Establish" message and automatically sends a corresponding establishment response.
IMessage	acceptEstablishment(long outgoingSequenceNumber) Accepts an "Establish" message and automatically sends a corresponding establishment response.
IMessage	acceptEstablishment(long outgoingSequenceNumber, long expectedIncomingSequenceNumber, long previousUuid, long previousSeqNo) Accepts an "Establish" message, allows setting expected sequence numbers and previous UUID/SeqNo.
IMessage	acceptEstablishmentWithoutResponse() Accepts an "Establish" message, used to confirm session setup after negotiation.
IMessage	acceptNegotiation() Accepts a "Negotiate" message and automatically sends a corresponding negotiation response.
IMessage	acceptNegotiationWithoutResponse() Receives a "Negotiate" message, used at the start of a communication session.
IMessage	acceptSequence(int keepAliveIntervalLapsed) Accepts a sequence message, including checking the KeepAliveLapsed status.
IMessage	acceptTerminate() Accepts a "Terminate" message and sends a confirmation response.
IMessage	acceptTerminateWithoutResponse() Accepts a "Terminate" message without sending any response.
void	closeServerSocket() Closes the server socket.
IMessage	createExecutionReportTradeOutright(long orderId, boolean retransmission)
IMessage	createMassQuoteAck(boolean retransmission)
void	disconnect() Closes the socket and associated input/output streams.
void	disconnectImmediately() Closes the socket immediately, using SO_LINGER with a timeout of 0.
int	getPort() Returns the port number the Emulator is listening on (default value is 11012).
long	getTimeoutInMilliseconds() Returns the timeout in milliseconds for sockets.
long	getUuid() Returns the UUID.
boolean	isConnectionClosed() Checks if the TCP connection associated with the Emulator is closed.
void	receiveAll() Receives all the data from the input stream.
IMessage	receiveMessage() Receives the next available message.
IMessage	receiveMessage(int inSeqNum) Receives a message, asserting that it has the expected sequence number.
IMessage	receiveMessage(int inSeqNum, int templateId) Receives a message, asserting that it has the expected sequence number and template ID.
IMessage	receiveOrder(int inSeqNum) Receives a "NewOrderSingle" message and verifies its sequence number.
IMessage	receiveRetransmitRequest(long fromSeqNo, long msgCount) Receives a "RetransmitRequest" message, verifying the provided sequence numbers.
IMessage	receiveSequence(int nextSeqNo) Receives a "Sequence" message and verifies its sequence number.
IMessage	rejectEstablishment() Accepts an "Establish" message and automatically sends a rejection response.
IMessage	rejectNegotiation() Accepts a "Negotiate" message and automatically sends a rejection response.
void	send(ByteBuffer rawMsg) Sends a raw message.
void	send(IMessage msg) Sends an IMessage object.
void	send(IMessage msg, long seqNum) Sends an IMessage object with sequence number.
void	sendNotApplied(long fromSeqNo, int msgCount) Sends a "Not Applied" message, indicating that some previous messages were not processed.
void	sendRetransmission(IMessage request) Sends a "Retransmission" message is sent in response to a valid Retransmit Request.
void	sendSequence(long nextSeqNo) Sends a "Sequence" message to maintain session synchronization.
void	sendSequence(long nextSeqNo, int keepAliveLapsed) Sends a "Sequence" message with keep-alive status information.
void	sendSequence(long nextSeqNo, int keepAliveLapsed, long uuid) Sends a "Sequence" message with keep-alive information and a specified UUID.
void	setPort(int port) Sets the port number for the Emulator.
void	setTimeoutInMilliseconds(int timeoutInMilliseconds) Sets the timeout in milliseconds for sockets.
IMessage	terminate() Initiates a "Terminate" sequence and waits for the corresponding Terminate response.
IMessage	terminateWithoutResponse(String text) Initiates a "Terminate" sequence (with customizable text) without waiting for a response.
IMessage	terminateWithoutResponse(String text, int errorCode) Initiates a "Terminate" sequence (with customizable text) without waiting for a response.
void	testLink(int expectedOutgoingSequenceNumber, int expectedIncomingSequenceNumber) Tests the link by sending and receiving Sequence messages with expected sequence numbers.
IMessage	waitUntilTerminate(Emulator.MessageListener listener) Waits for a "Terminate" message and provides a way to process other incoming messages during the wait.
static void	writeToLog(String message) Static method for writing a message to a log, often used for test tracking.

Methods inherited from class java.lang.Object

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

Constructor Detail

Emulator

public Emulator(TestUtility testUtility)

Constructs an Emulator instance with a reference to a TestUtility object.

Parameters:

testUtility - object used for message creation.

Method Detail

getUuid

public long getUuid()

Returns the UUID.

Returns:

The UUID.

getPort

public int getPort()

Returns the port number the Emulator is listening on (default value is 11012).

Returns:

The port number.

setPort

public void setPort(int port)

Sets the port number for the Emulator.

Parameters:

port - The desired port number.

getTimeoutInMilliseconds

public long getTimeoutInMilliseconds()

Returns the timeout in milliseconds for sockets.

Returns:

The timeout in milliseconds for sockets.

setTimeoutInMilliseconds

public void setTimeoutInMilliseconds(int timeoutInMilliseconds)

Sets the timeout in milliseconds for sockets.

Parameters:

timeoutInMilliseconds - The timeout in milliseconds.

isConnectionClosed

public boolean isConnectionClosed()
                           throws IOException

Checks if the TCP connection associated with the Emulator is closed. Tries to read from bytes from stream to internal buffer if -1 is returned then the connection is considered as closed.

Returns:

true if the connection is closed, false otherwise.

Throws:

IOException - If an error occurs during the connection status check.

writeToLog

public static void writeToLog(String message)

Static method for writing a message to a log, often used for test tracking.

Parameters:

message - message to be logged.

acceptConnection

public void acceptConnection(TestAcceptorTask acceptorTask)
                      throws IOException

Accepts an incoming TCP connection and prepares the Emulator for communication. This method listens on automatically allocated port via ServerSocket(0) until a connection is established.

Parameters:

acceptorTask - object is used to return automatically allocated port number.

Throws:

IOException - If an error occurs during connection acceptance.

acceptConnection

public void acceptConnection()
                      throws IOException

Accepts an incoming TCP connection. Similar to the other 'acceptConnection' method, but uses the port number set to the emulator.

Throws:

IOException - If an error occurs during connection acceptance.

acceptNegotiationWithoutResponse

public IMessage acceptNegotiationWithoutResponse()
                                          throws IOException

Receives a "Negotiate" message, used at the start of a communication session. Extracts UUID and RequestTimestamp values from the message.

Returns:

The received IMessage object representing the Negotiate message.

Throws:

IOException - If an error occurs during message reception.

acceptNegotiation

public IMessage acceptNegotiation()
                           throws IOException

Accepts a "Negotiate" message and automatically sends a corresponding negotiation response.

Returns:

The received IMessage object representing the Negotiate message.

Throws:

IOException - If an error occurs during message reception or sending the response.

rejectNegotiation

public IMessage rejectNegotiation()
                           throws IOException

Accepts a "Negotiate" message and automatically sends a rejection response.

Returns:

The received IMessage object representing the Negotiate message.

Throws:

IOException - If an error occurs during message reception or sending the rejection.

acceptEstablishmentWithoutResponse

public IMessage acceptEstablishmentWithoutResponse()
                                            throws IOException

Accepts an "Establish" message, used to confirm session setup after negotiation.

Returns:

The received IMessage object representing the Establish message.

Throws:

IOException - If an error occurs during message reception.

acceptEstablishment

public IMessage acceptEstablishment(long outgoingSequenceNumber,
                                    long expectedIncomingSequenceNumber,
                                    long previousUuid,
                                    long previousSeqNo)
                             throws IOException

Accepts an "Establish" message, allows setting expected sequence numbers and previous UUID/SeqNo.

Parameters:

outgoingSequenceNumber - The expected next outgoing sequence number to send in the response.

expectedIncomingSequenceNumber - The expected incoming sequence number in the Establish message.

previousUuid - The UUID from a previous session (if resuming)

previousSeqNo - The sequence number from a previous session (if resuming)

Returns:

The received IMessage object representing the Establish message.

Throws:

IOException - If an error occurs during message reception or sending the response.

acceptEstablishment

public IMessage acceptEstablishment(long outgoingSequenceNumber)
                             throws IOException

Accepts an "Establish" message and automatically sends a corresponding establishment response. Where: expectedIncomingSequenceNumber = 1, previousUuid = 0, previousSeqNo = 0

Parameters:

outgoingSequenceNumber - The expected next outgoing sequence number to send in the response.

Returns:

The received IMessage object representing the Establish message.

Throws:

IOException - If an error occurs during message reception or sending the response.

acceptEstablishment

public IMessage acceptEstablishment()
                             throws IOException

Accepts an "Establish" message and automatically sends a corresponding establishment response. Where: outgoingSequenceNumber = 1, expectedIncomingSequenceNumber = 1, previousUuid = 0, previousSeqNo = 0

Returns:

The received IMessage object representing the Establish message.

Throws:

IOException - If an error occurs during message reception or sending the response.

rejectEstablishment

public IMessage rejectEstablishment()
                             throws IOException

Accepts an "Establish" message and automatically sends a rejection response.

Returns:

The received IMessage object representing the Establish message.

Throws:

IOException - If an error occurs during message reception or sending the rejection.

acceptSequence

public IMessage acceptSequence(int keepAliveIntervalLapsed)
                        throws IOException

Accepts a sequence message, including checking the KeepAliveLapsed status.

Parameters:

keepAliveIntervalLapsed - Indicates if the keep-alive mechanism has lapsed.

Returns:

The received IMessage representing the Sequence message.

Throws:

IOException - If an error occurs during message reception.

sendNotApplied

public void sendNotApplied(long fromSeqNo,
                           int msgCount)
                    throws IOException

Sends a "Not Applied" message, indicating that some previous messages were not processed.

Parameters:

fromSeqNo - The starting sequence number of the unprocessed messages.

msgCount - The number of unprocessed messages.

Throws:

IOException - If an error occurs while sending the message.

sendRetransmission

public void sendRetransmission(IMessage request)
                        throws IOException

Sends a "Retransmission" message is sent in response to a valid Retransmit Request.

Parameters:

request - The Retransmit Request.

Throws:

IOException - If an error occurs while sending the message.

sendSequence

public void sendSequence(long nextSeqNo,
                         int keepAliveLapsed,
                         long uuid)
                  throws IOException

Sends a "Sequence" message with keep-alive information and a specified UUID.

Parameters:

nextSeqNo - The next expected sequence number.

keepAliveLapsed - Indicates if the keep-alive mechanism has lapsed.

uuid - UUID.

Throws:

IOException - If an error occurs while sending the message.

sendSequence

public void sendSequence(long nextSeqNo,
                         int keepAliveLapsed)
                  throws IOException

Sends a "Sequence" message with keep-alive status information.

Parameters:

nextSeqNo - The next expected sequence number.

keepAliveLapsed - Indicates if the keep-alive mechanism has lapsed.

Throws:

IOException - If an error occurs while sending the message.

sendSequence

public void sendSequence(long nextSeqNo)
                  throws IOException

Sends a "Sequence" message to maintain session synchronization. Where: keep-alive is not lapsed.

Parameters:

nextSeqNo - The next expected sequence number.

Throws:

IOException - If an error occurs while sending the message.

acceptTerminateWithoutResponse

public IMessage acceptTerminateWithoutResponse()
                                        throws IOException

Accepts a "Terminate" message without sending any response.

Returns:

The received IMessage object representing the Terminate message.

Throws:

IOException - If an error occurs during message reception.

acceptTerminate

public IMessage acceptTerminate()
                         throws IOException

Accepts a "Terminate" message and sends a confirmation response.

Returns:

The received IMessage object representing the Terminate message.

Throws:

IOException - If an error occurs during message reception.

terminateWithoutResponse

public IMessage terminateWithoutResponse(String text,
                                         int errorCode)
                                  throws IOException

Initiates a "Terminate" sequence (with customizable text) without waiting for a response.

Parameters:

text - Customizable text to be included in the Terminate message.

errorCode - An error code to be included in the Terminate message.

Returns:

The sent IMessage object representing the Terminate message.

Throws:

IOException - If an error occurs during sending the Terminate message.

terminateWithoutResponse

public IMessage terminateWithoutResponse(String text)
                                  throws IOException

Initiates a "Terminate" sequence (with customizable text) without waiting for a response. Where: errorCode is TerminateErrorCodes.Finished.

Parameters:

text - Customizable text to be included in the Terminate message.

Returns:

The sent IMessage object representing the Terminate message.

Throws:

IOException - If an error occurs during sending the Terminate message.

terminate

public IMessage terminate()
                   throws IOException

Initiates a "Terminate" sequence and waits for the corresponding Terminate response. Where: text is "Terminate" and errorCode is TerminateErrorCodes.Finished.

Returns:

The received IMessage object representing the Terminate response message.

Throws:

IOException - If an error occurs during sending or receiving Terminate messages.

send

public void send(IMessage msg)
          throws IOException

Sends an IMessage object.

Parameters:

msg - The IMessage object to send.

Throws:

IOException - If an error occurs while sending the message.

send

public void send(IMessage msg,
                 long seqNum)
          throws IOException

Sends an IMessage object with sequence number.

Parameters:

msg - The IMessage object send.

seqNum - A sequence number to set.

Throws:

IOException - If an error occurs while sending the message.

send

public void send(ByteBuffer rawMsg)
          throws IOException

Sends a raw message.

Parameters:

rawMsg - The raw message buffer (ByteBuffer) to send.

Throws:

IOException - If an error occurs while sending the message.

receiveAll

public void receiveAll()
                throws IOException

Receives all the data from the input stream.

Throws:

IOException - If an error occurs during message reception.

receiveMessage

public IMessage receiveMessage()
                        throws IOException

Receives the next available message.

Returns:

The received IMessage object, or null if none are available.

Throws:

IOException - If an error occurs during message reception.

receiveMessage

public IMessage receiveMessage(int inSeqNum)
                        throws IOException

Receives a message, asserting that it has the expected sequence number.

Parameters:

inSeqNum - The expected sequence number.

Returns:

The received IMessage object.

Throws:

IOException - If an error occurs during message reception.

receiveMessage

public IMessage receiveMessage(int inSeqNum,
                               int templateId)
                        throws IOException

Receives a message, asserting that it has the expected sequence number and template ID.

Parameters:

inSeqNum - The expected sequence number.

templateId - The expected template ID of the message.

Returns:

The received IMessage object.

Throws:

IOException - If an error occurs during message reception.

receiveOrder

public IMessage receiveOrder(int inSeqNum)
                      throws IOException

Receives a "NewOrderSingle" message and verifies its sequence number.

Parameters:

inSeqNum - The expected sequence number of the order message.

Returns:

The received IMessage representing the NewOrderSingle message.

Throws:

IOException - If an error occurs during message reception.

receiveSequence

public IMessage receiveSequence(int nextSeqNo)
                         throws IOException

Receives a "Sequence" message and verifies its sequence number.

Parameters:

nextSeqNo - The expected sequence number of the sequence message.

Returns:

The received IMessage representing the Sequence message.

Throws:

IOException - If an error occurs during message reception.

receiveRetransmitRequest

public IMessage receiveRetransmitRequest(long fromSeqNo,
                                         long msgCount)
                                  throws IOException

Receives a "RetransmitRequest" message, verifying the provided sequence numbers.

Parameters:

fromSeqNo - The expected starting sequence number of the retransmission request.

msgCount - The expected number of messages to be retransmitted.

Returns:

The received IMessage representing the RetransmitRequest message.

Throws:

IOException - If an error occurs during message reception.

testLink

public void testLink(int expectedOutgoingSequenceNumber,
                     int expectedIncomingSequenceNumber)
              throws IOException

Tests the link by sending and receiving Sequence messages with expected sequence numbers.

Parameters:

expectedOutgoingSequenceNumber - The expected next outgoing sequence number.

expectedIncomingSequenceNumber - The expected next incoming sequence number.

Throws:

IOException - If an error occurs during communication.

waitUntilTerminate

public IMessage waitUntilTerminate(Emulator.MessageListener listener)
                            throws IOException

Waits for a "Terminate" message and provides a way to process other incoming messages during the wait.

Parameters:

listener - A MessageListener to handle incoming messages before the Terminate message.

Returns:

The received IMessage object representing the Terminate message.

Throws:

IOException - If an error occurs during communication.

disconnectImmediately

public void disconnectImmediately()

Closes the socket immediately, using SO_LINGER with a timeout of 0.

disconnect

public void disconnect()

Closes the socket and associated input/output streams.

closeServerSocket

public void closeServerSocket()

Closes the server socket.

createMassQuoteAck

public IMessage createMassQuoteAck(boolean retransmission)

createExecutionReportTradeOutright

public IMessage createExecutionReportTradeOutright(long orderId,
                                                   boolean retransmission)