biz.onixs.cme.dropcopy.handler

Class Handler

java.lang.Object

biz.onixs.cme.dropcopy.handler.Handler

All Implemented Interfaces:

biz.onixs.fix.engine.Session.InboundApplicationMessageListener, biz.onixs.fix.engine.Session.InboundSessionMessageListener, biz.onixs.fix.engine.Session.OutboundApplicationMessageListener, biz.onixs.fix.engine.Session.OutboundSessionMessageListener, biz.onixs.fix.scheduler.InitiatorConnectionListener

public class Handler
extends Object
implements biz.onixs.fix.engine.Session.InboundSessionMessageListener, biz.onixs.fix.engine.Session.InboundApplicationMessageListener, biz.onixs.fix.engine.Session.OutboundSessionMessageListener, biz.onixs.fix.engine.Session.OutboundApplicationMessageListener, biz.onixs.fix.scheduler.InitiatorConnectionListener

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Handler.ErrorListener Defines the contract for listeners that handle error events.
static interface	Handler.HandlerListener Defines the contract for listeners that handle various messages received from the CME Drop Copy Handler.
static interface	Handler.WarningListener Defines the contract for listeners that handle warning events.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ApplicationSystemName
static String	ApplicationSystemVendor
static String	ApplicationSystemVersion
static int	MaxResendMsgCount

Constructor Summary

Constructors

Constructor and Description
Handler(biz.onixs.fix.engine.Session session) Handler constructor.
Handler(String senderCompId, String senderSubId, String targetSubId) Handler constructor.
Handler(String senderCompId, String targetCompId, String senderSubId, String targetSubId, String senderLocationId) Handler constructor.

Method Summary

Modifier and Type	Method and Description
biz.onixs.fix.parser.Message	createLogonMessage(String accessKeyID, String secretKey) Sets the access key ID and secret key, and then creates a FIX Logon message.
void	dispose() Releases all resources held by this Handler and gracefully shuts down its internal FIX session and the global OnixS FIX Engine.
static String	getDialectFile() Returns the location of the Cme Drop Copy FIX Dialect file.
Handler.ErrorListener	getErrorListener() Retrieves the currently registered ErrorListener.
Handler.HandlerListener	getHandlerListener() Retrieves the currently registered HandlerListener.
static String	getLicenseFile() Retrieves the path configured for the OnixS license file (`.lic`) location.
static String	getLogDirectory() Retrieves the path configured for storing log files.
boolean	getProcessNextExpectedSeqNumFromCmeLogout()
biz.onixs.fix.engine.Session	getSession() Retrieves the underlying FIX session used by this Handler.
Handler.WarningListener	getWarningListener() Retrieves the currently registered WarningListener.
void	logon(String host, int port, String accessKeyID, String secretKey) Establishes a connection and logs on to the CME Drop Copy session.
void	logout() Initiates the logout process from the CME Drop Copy session.
void	onConnecting(biz.onixs.fix.scheduler.InitiatorConnectingArgs initiatorConnectingArgs)
void	onInboundApplicationMessage(Object sender, biz.onixs.fix.engine.Session.InboundApplicationMessageArgs args)
void	onInboundSessionMessage(Object sender, biz.onixs.fix.engine.Session.InboundSessionMessageArgs args)
void	onOutboundApplicationMessage(Object o, biz.onixs.fix.engine.Session.OutboundApplicationMessageArgs outboundApplicationMessageArgs)
void	onOutboundSessionMessage(Object o, biz.onixs.fix.engine.Session.OutboundSessionMessageArgs outboundSessionMessageArgs)
void	reset() Resets the underlying FIX session's local sequence numbers.
static void	setDialectFile(String value) Sets a custom path to the CME Drop Copy FIX Dialect file (`.xml`).
void	setErrorListener(Handler.ErrorListener listener) Sets the listener for error events.
void	setHandlerListener(Handler.HandlerListener listener) Sets the listener for Handler-related events.
static void	setLicenseFile(String value) Sets a custom, absolute path to the OnixS license file (`.lic`) location.
static void	setLogDirectory(String value) Sets the absolute path where log files will be stored.
void	setProcessNextExpectedSeqNumFromCmeLogout(boolean processNextExpectedSeqNumFromCmeLogout)
void	setWarningListener(Handler.WarningListener listener) Sets the listener for warning events.

Methods inherited from class java.lang.Object

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

Field Detail

MaxResendMsgCount

public static final int MaxResendMsgCount

See Also:

Constant Field Values

ApplicationSystemName

public static String ApplicationSystemName

ApplicationSystemVendor

public static String ApplicationSystemVendor

ApplicationSystemVersion

public static String ApplicationSystemVersion

Constructor Detail

Handler

public Handler(String senderCompId,
               String senderSubId,
               String targetSubId)

Handler constructor.

Parameters:

senderCompId - Fix session SenderCompID

senderSubId - Fix session SenderSubID

targetSubId - Fix session TargetSubID

Handler

public Handler(String senderCompId,
               String targetCompId,
               String senderSubId,
               String targetSubId,
               String senderLocationId)

Handler constructor.

Parameters:

senderCompId - Fix session SenderCompID

targetCompId - Fix session TargetCompID

senderSubId - Fix session SenderSubID

targetSubId - Fix session TargetSubID

senderLocationId - Fix session SenderLocationID

Handler

public Handler(biz.onixs.fix.engine.Session session)

Handler constructor.

Parameters:

session - Fix session.

Method Detail

getLogDirectory

public static String getLogDirectory()

Retrieves the path configured for storing log files.

By default, this path is initialized to the current working directory (`.`) when the Handler class is loaded. Developers can change this path at any time using setLogDirectory(String).

Returns:

The absolute path to the log directory that has been configured. This method will always return a non-null value, defaulting to the current working directory if no other path has been explicitly set.

setLogDirectory

public static void setLogDirectory(String value)

Sets the absolute path where log files will be stored. All log files generated by the CME Drop Copy Handler will be written to this location.

This method is typically called during application startup to configure logging. It is a static method, meaning it configures the log directory globally for all instances of the Handler within the application's lifecycle.

Parameters:

value - The absolute path to the directory where log files should be written. For example, "/var/log/my-app" or "C:\\ProgramData\\MyApp\\Logs". Using "." specifies the current working directory.

getLicenseFile

public static String getLicenseFile()

Retrieves the path configured for the OnixS license file (`.lic`) location.

By default, this path is initialized to the current working directory (`.`) when the Handler class is loaded. Developers can change this path at any time using setLicenseFile(String).

It's important to note that even if a custom path is set, the OnixS library might also search for the license file in default locations like the classpath if the file is not found at the specified path.

Returns:

The absolute path to the license file that has been configured. This method will always return a non-null value, defaulting to the current working directory if no other path has been explicitly set.

setLicenseFile

public static void setLicenseFile(String value)

Sets a custom, absolute path to the OnixS license file (`.lic`) location. This method should be called before initializing the Handler or any other components that require licensing, as it directs the library to the specified location to find its valid license.

If this method is not called, the OnixS library will by default attempt to locate the license file (`OnixS.lic`) on the **application's classpath**. This means you can often include the license file directly in your application's resources without explicitly setting a file path.

This is a static method, meaning it configures the license file location for all instances of the Handler or other library components within the application's lifecycle.

Parameters:

value - The file or folder path, e.g., "/path/to/OnixS.lic" or "C:\\licenses") * where the OnixS license file is located.

setDialectFile

public static void setDialectFile(String value)

Sets a custom path to the CME Drop Copy FIX Dialect file (`.xml`). This file defines the specific FIX message structures, fields, and rules used by the CME Drop Copy service, enabling the Handler to correctly parse and construct FIX messages according to CME's precise implementation.

By default, if this method is not called, the Handler will automatically load the dialect file named CmeDropCopyFixDialect.xml from the application's classpath. This approach is often preferred for deployment, allowing the dialect file to be bundled directly within the application's JAR or resources.

This is a static method, meaning it configures the dialect file location globally for all instances of the Handler within the application's lifecycle.

Parameters:

value - The absolute path (including the file name and extension, e.g., "/path/to/CmeDropCopyFixDialect.xml" or "C:\\configs\\CmeDropCopyFixDialect.xml") where the CME Drop Copy FIX Dialect file is located. Pass null to reset to the default classpath lookup behavior.

getDialectFile

public static String getDialectFile()

Returns the location of the Cme Drop Copy FIX Dialect file. Default value is 'CmeDropCopyFixDialect.xml'

Returns:

path to the dialect file

logon

public final void logon(String host,
                        int port,
                        String accessKeyID,
                        String secretKey)
                 throws Exception

Establishes a connection and logs on to the CME Drop Copy session. This method sets the provided authentication credentials (Access Key ID and Secret Key) and then initiates the underlying FIX session connection and logon sequence. A successful logon allows the handler to start receiving Drop Copy messages.

The `accessKeyID` and `secretKey` are critical for authenticating your application with the CME Globex platform. They are used to generate a Hashed Message Authentication Code (HMAC) to secure the logon request and ensure the confidentiality and integrity of messages.

Parameters:

host - The hostname or IP address of the CME Drop Copy session endpoint.

port - The port number for the CME Drop Copy session endpoint.

accessKeyID - The Access Key ID provided by CME Group, used for authentication.

secretKey - The Secret Key provided by CME Group, used in conjunction with the Access Key ID for authentication.

Throws:

Exception - If any error occurs during the logon process.

createLogonMessage

public biz.onixs.fix.parser.Message createLogonMessage(String accessKeyID,
                                                       String secretKey)

Sets the access key ID and secret key, and then creates a FIX Logon message. This method is a convenience for setting credentials and immediately generating the initial logon message required to establish a CME Drop Copy session.

Parameters:

accessKeyID - The Access Key ID used for authentication with the CME Drop Copy service.

secretKey - The Secret Key associated with the Access Key ID, used for authentication.

Returns:

A Message object representing the FIX Logon message (MsgType=A), pre-populated with the necessary authentication credentials.

logout

public final void logout()

Initiates the logout process from the CME Drop Copy session. This method sends a FIX Logout (MsgType=5) message to the counterparty, gracefully terminating the FIX session.

After calling this method, the session will transition to a logged-out state, and no further messages will be exchanged until a new logon is performed.

This method is synchronized to ensure thread safety when initiating logout.

reset

public final void reset()

Resets the underlying FIX session's local sequence numbers. This operation prepares the session for a fresh start with the empty session storage.

This method is synchronized to ensure thread safety during the reset operation.

Throws:

RuntimeException - If the session is not in a DISCONNECTED state. This method must only be called when the session is not actively connected or logging on/out.

onOutboundSessionMessage

public void onOutboundSessionMessage(Object o,
                                     biz.onixs.fix.engine.Session.OutboundSessionMessageArgs outboundSessionMessageArgs)

Specified by:

onOutboundSessionMessage in interface biz.onixs.fix.engine.Session.OutboundSessionMessageListener

onOutboundApplicationMessage

public void onOutboundApplicationMessage(Object o,
                                         biz.onixs.fix.engine.Session.OutboundApplicationMessageArgs outboundApplicationMessageArgs)

Specified by:

onOutboundApplicationMessage in interface biz.onixs.fix.engine.Session.OutboundApplicationMessageListener

onInboundSessionMessage

public void onInboundSessionMessage(Object sender,
                                    biz.onixs.fix.engine.Session.InboundSessionMessageArgs args)

Specified by:

onInboundSessionMessage in interface biz.onixs.fix.engine.Session.InboundSessionMessageListener

onInboundApplicationMessage

public void onInboundApplicationMessage(Object sender,
                                        biz.onixs.fix.engine.Session.InboundApplicationMessageArgs args)

Specified by:

onInboundApplicationMessage in interface biz.onixs.fix.engine.Session.InboundApplicationMessageListener

getProcessNextExpectedSeqNumFromCmeLogout

public boolean getProcessNextExpectedSeqNumFromCmeLogout()

setProcessNextExpectedSeqNumFromCmeLogout

public void setProcessNextExpectedSeqNumFromCmeLogout(boolean processNextExpectedSeqNumFromCmeLogout)

onConnecting

public void onConnecting(biz.onixs.fix.scheduler.InitiatorConnectingArgs initiatorConnectingArgs)

Specified by:

onConnecting in interface biz.onixs.fix.scheduler.InitiatorConnectionListener

setHandlerListener

public void setHandlerListener(Handler.HandlerListener listener)

Sets the listener for Handler-related events. This method allows an application to register an object that will receive callbacks for various events such as received messages (e.g., Execution Reports, Mass Order Cancel Reports), and connection status changes (e.g., logon, logout, connect, disconnect).

Parameters:

listener - The Handler.HandlerListener instance that will receive Handler events. Pass null to unregister the current listener.

getHandlerListener

public Handler.HandlerListener getHandlerListener()

Retrieves the currently registered HandlerListener.

Returns:

The Handler.HandlerListener instance currently set to receive Handler events, or null if no listener has been set.

setErrorListener

public void setErrorListener(Handler.ErrorListener listener)

Sets the listener for error events. This method allows an application to register an object that will receive callbacks when critical errors occur within the CME Drop Copy Handler.

Parameters:

listener - The Handler.ErrorListener instance that will receive error events. Pass null to unregister the current listener.

getErrorListener

public Handler.ErrorListener getErrorListener()

Retrieves the currently registered ErrorListener.

Returns:

The Handler.ErrorListener instance currently set to receive error events, or null if no listener has been set.

setWarningListener

public void setWarningListener(Handler.WarningListener listener)

Sets the listener for warning events. This method allows an application to register an object that will receive callbacks when non-critical warnings occur within the CME Drop Copy Handler.

Parameters:

listener - The Handler.WarningListener instance that will receive warning events. Pass null to unregister the current listener.

getWarningListener

public Handler.WarningListener getWarningListener()

Retrieves the currently registered WarningListener.

Returns:

The Handler.WarningListener instance currently set to receive warning events, or null if no listener has been set.

dispose

public final void dispose()

Releases all resources held by this Handler and gracefully shuts down its internal FIX session and the global OnixS FIX Engine. This method should be called when the Handler instance, and the underlying FIX Engine services, are no longer needed to ensure proper cleanup and prevent resource leaks, such as open network connections, file handles for logs, and internal FIX engine threads and state.

Once disposed, this Handler instance should no longer be used.

This method is idempotent; calling it multiple times will not cause an error and will only perform the cleanup once. It is also synchronized to ensure thread safety during the disposal process.

**Important Note on Engine Shutdown:** Calling Engine.getInstance().shutdown() will shut down the entire OnixS FIX Engine. This means any other sessions or components using the same Engine instance will also be affected and should no longer be used after this method is called. Ensure no other active sessions or Engine-dependent operations are running or intended to run after this call.

getSession

public final biz.onixs.fix.engine.Session getSession()

Retrieves the underlying FIX session used by this Handler. This session represents the active FIX connection to the CME Drop Copy service and provides access to lower-level FIX protocol details and capabilities.

Returns:

The Session object representing the underlying FIX session, or null if the session has been disposed.