Onix Solutions Logo

OnixS Java CME Drop Copy Handler — Programmer's Guide

Version 4.11.0



Onix Solutions CME Drop Copy Handler for Java is a Java library that provides an access to the CME Group Drop Copy services using FIX Protocol.

High-level Java API allows to build applications rapidly to get drop copy data without much involving into raw protocol specifics.

CME Drop Copy Handler implementations features include:

It's highly recommended to read the "Drop Copy Service" to get familiar with core aspects of CME Drop Copy Service.
By reading this Guide, we also recommend to review a source code of the sample project which comes as a part of the library distributive package.

System Requirements

Getting Started

All Handler classes are encapsulated into the biz.onixs.cme.dropcopy.handler package.

The typical way of using the Handler is as follows:

Secure Logon

CME Globex implemented secure authentication for iLink and Drop Copy sessions on Convenience Gateway (CGW) and Market Segment Gateway (MSGW). The new logon procedure secures the client system logon with:

Secure keys

Customers must create secure key pairs for iLink and Drop Copy Sessions in the CME Customer Center.

Implementation details

Secure Logon procedure was implemented inside DropCopy Handler. To provide secure keys to DropCopy Handler please call one of Handler.logon() methods, which accepts accessKeyID and secretKey parameters.

Connecting to Multiple Segments

Handler instance allows to connect to single segment only. To connect to multiple segments, there is need to create one handler instance for each segment. Please see the multisegment sample from installation package.

Segment id is specified as session TargetSubID. SenderCompId and SenderSubId will be same for all segments.
The following example demonstrates how to connect to multiple segments.
public class Sample {
    private void run() throws Exception {
        Handler handler1 = new Handler(senderCompId, targetCompId, senderSubId, targetSubId1, senderLocationId);


        handler1.logon(host1, port1, password);

        // Same SenderCompId and SenderSubId, but different TargetSubID
        Handler handler2 = new Handler(senderCompId, targetCompId, senderSubId, targetSubId2, senderLocationId);


        handler2.logon(host2, port2, password);

Connecting to Backup Sessions

If connection to primary host has been dropped, CME allows to connect to a backup host:

Backup host can be connected by providing new IP address.

The following example demonstrates how to switch to a backup host.
public class Sample {
    private void run() throws Exception {
        Handler handler = new Handler(senderCompId, targetCompId, senderSubId, targetSubId, senderLocationId);


        handler.logon(primary_host, port, accessKeyID, secretKey);

        // Some network or gateway failure occurs, so there is need to switch to backup host
        handler.logon(backup_host, port, accessKeyID, secretKey);

Using Handler with the Scheduler

Handler supports using the Session Scheduler to connect to CME host automatically. The Scheduler support switching between primary and backup hosts.

It's important to register Handler as InitiatorConnectionListener, to process host switching correctly. If the only primary host is used, this step can be omitted.
The following example demonstrates how to configure the Scheduler to connect to CME hosts.
public class Sample {
    private void run() throws Exception {
        final SessionScheduler sessionScheduler = new SessionScheduler();

        final SessionSchedule schedule = createSchedule();

        final InitiatorConnection connection = new InitiatorConnection();

        connection.setInitiatorConnectionListener(handler); // This is required to process switching between primary and backup hosts correctly.

        final InetSocketAddress primaryAddress = InetSocketAddress.createUnresolved(host, port);

        final InetSocketAddress backupAddress = InetSocketAddress.createUnresolved(backupHost, backupPort);

        Message customLogon = handler.createLogonMessage(accessKeyID, secretKey);
        sessionScheduler.register(handler.getSession(), schedule, connection);

Controlling Handler Logging

Controlling Logging in the Handler

By default, Handler logs all important aspects of its activity while processing market data. The SLF4J (Simple Logging Facade for Java) is used by Handler internally. The SLF4J detects and uses the concrete logging implementation configured by user. By default, the Logback logging implementation is recommended.

The Logback (or any other logging implementation) must be configured at the beginning of the application. The examples of Logback configuration can be found in the Handler samples. The details of Logback configuration can be found here.

By default, logging is configured to log only errors and warnings. This is an example of logback.xml where detailed logging was switched on:
<logger name="biz.onixs.cme.stp.handler.sample" level="DEBUG"/>
<logger name="biz.onixs.cme.stp.handler" level="INFO"/>
<logger name="biz.onixs.cme.stp.handler.Session.Messages" level="INFO"/>

© Onix Solutions