This document contains description of the main features of JMS Transport Adaptor for FixEdge and common steps required to install JMS Transport Adaptor (JMS TA) for the FIX Edge.
The JMS Adaptor for FIX Server (hereinafter JMS Adaptor) is intended for communication with FIX Server from third-part applications via JMS. JMS TA is a library that exposes a set of methods for communicating with FixEdge's Transport Layer. Also, JMS TA gives a transport, which implements JMS protocol for transmitting/receiving data to/from JMS provider(s):
- JMS TA performs packaging of FIX(ML) messages to JMS Messages (Binary or Text) with further sending to appropriate JMS provider(s);
- JMS TA performs extracting of FIX(ML) messages from received JMS Messages with further sending it to Transport Layer;
During FIX server start-up Transport Layer creates JMS connection for each Client Name listed in configuration ClientNames property with specified Session Type, Topic, Ack mode and other properties created.
- After success creation of Connection to JMS Provider - notification to Transport Layer is sent via onLogon() with ClientName as parameter;
- After success disconnect from JMS Provider - notification to Transport Layer is sent via onLogout() with ClientName as parameter;
- After successfull registration in Transport Layer, JMS TA starts processing incoming messages from JMS Provider(s) and routing outgoing messages from TL to JMS provider(s).
Path to jvm libraries should be specified in PATH variable if installation goes in Linux (E.g.: /home/user/work/environment/jdk1.7.0/jre/lib/amd64/server).
For FIXEdge prior to v5.7:
- Java Runtime Environment 1.6 or higher
- Path to jvm libraries should be specified in PATH variable if installation goes in Windows . (E.g.: C:\Program Files (x86)\Java\jre7\bin\server)
Installation and run steps
Configuration for ActiveMQ
Installation and run steps (after rev. 66518)
Install FIXEdge for Windows (use "tar xvf" commands for Linux/Solaris)
Add path to appropriate activemq*.jar to java classpath in FIXEdge1/conf/jms-ta-distribution/etc/JVM_Options.jvmopts file e.g.:
Configure paths to logs in FIXEdge1/conf/jms-ta-distribution/etc/log4j.properties. Paths to logs directory must be absolute.
Configure JMS adapter in FIXEdge.properties.
Add TransportLayer.JMSTA to TransportLayer.TransportAdapters, so as a result you should get "TransportLayer.TransportAdapters = TransportLayer.JMSTA"
And add JMS session parameters, for example:
Note: TransportLayer.JMSTA.Connection.Connection1.ProviderURI = tcp://10.17.12.244:61616 - host:port of Apache ActiveMQ Message Broker.
According to this configuration, FIXEdge will establish connection (Connection1) with ActiveMQ on 10.17.12.244:61616. This connection will be used by two JMS sessions: ProducerSession will receive FIX messages and send converted messages into MyQueue queue of ActiveMQ (producer session), ConsumerSession will receive JMS messages from MyQueue queue of ActiveMQ and convert them into FIX (consumer session).
Use FixEdge1/conf/BL_Config.xml as Business Layer Rules configuration file.
According to that BL rule and to JMS adapter configuration: FIX messages from FIXCLIENT1 will be converted into JMS and sent to ActiveMQ using producer session JMSPTestSession, then consumers session JMSPTestSession2 will get these JMS messages from ActiveMQ, convert it back to FIX and send messages to FIXCLIENT2.
- ActiveMQ configuration (You can get it from official site).
In conf/activemq.xml add <destination> to <broker> section:
Start ActiveMQ using bin/activemq.bat
Enable UnregisteredAcceptors in FixEdge1/conf/engine.properties (UnregisteredAcceptor.CreateSession = true)
Start, for example, SimpleClient (or HSBC tool) and establish FIXCLIENT1-FIXEDGE, FIXCLIENT2-FIXEDGE sessions with FIXEdge
Send FIX messages to FIXCLIENT1-FIXEDGE session
Messages from FIXCLIENT1-FIXEDGE session should be received in FIXCLIENT2-FIXEDGE Session
Open ActiveMQ admin console. Messages Enqueued and Messages Dequeued counters on Queues and Topics page should be changing with each sent message.
Installation and run steps (prior rev. 66518)
3. Unpack jms-ta-distribution*.zip to FixEdge1/conf/
4-5. In FixEdge1/conf directory create JVM_Options.jvmopts file with:
Where 1.2.2 - numbers in version of jms-distribution.
A.B.C - numbers in version of activemq jar-file.
6. Copy log4j.properties file (on older version it is logback.xml) from FixEdge1/conf/jms-distribution/etc to FixEdge1/conf
8. Configure BL_Config.xml as:
Configuration for TIBCO EMS
On TIBCO EMS side
- In C:\ProgramData\TIBCO_HOME\tibco\cfgmgmt\ems\data\tibemsd.conf file set
authorization = enabled
user_auth = local // Not sure if this is required
2. Using TIBCO EMS admin tool og GEMS create user "fixedge_dev" with password "fixedge_dev"
3. Using TIBCO EMS admin tool og GEMS create TOPIC "fixedge.deals"
4. In "fixedge.deals" topic set isSecure property to "true"
5. Assign "Subscribe To Topic", "Create Durable" and "Use Durable" permissions for "fixedge_dev" user
6. There is no need in manual creation of DURABLE. FIXEdge will create it automatically.
On FIXEdge side
Install FIXEdge for Windows (use "tar xvf" commands for Linux/Solaris)
Put jmsTADll-xx.dll (libjmsTADll-xx.so and symlink libjmsTA.so for Linux/Solaris) file from JMSAdaptor package into bin directory of FIXEdge
Copy "jms-ta-distribution" directory to FIXEdge's configuration directory (e.g FixEdge1/conf/)
Copy JVM_Options.jvmopts from Package/DOC/ to FixEdge1/conf/
Copy appropriate tibjms.jar library from TIBCO EMS (for example, it can be located into C:/tibco/ems/6.3/lib/) to, for example, jms-ta-distribution/tool/lib/ folder and add path to this library to classpath in JVM_Options.jvmopts, e.g.:
Configure consumer connection parameters in the FIXEdge.properties, e.g.:
If you need to configure consumer and producer, then you should repeat steps 2 and 5 from "On TIBCO EMS side" instruction and in FIXEdge.properties configuration should looks like:
7. Configure BL Rules in BL_Config.xml to put received FIX messages to "fixedge_send_dev" client and get messages from "fixedge_recv_dev" client
8. Start TIBCO EMS
9. Start FIXEdge
The JMS adaptor is configured by means of the following properties:
Comma delimited list of TA.
Separate configuration section for each listed client should be specified. JMSTA should be specified here.
|TransportLayer.JMSTA.Description||TA Description||Y||JMS Transport Adaptor|
|TransportLayer.JMSTA.DllName||TA library file name||Y|
|TransportLayer.JMSTA.JVMOptionsFile||TA configuration file name||Y|
|TransportLayer.JMSTA.AllowRejectMessages||When option is true, JMS rejects messages if unable to send to the MQ or error was fired. False by default.||N||false|
|TransportLayer.JMSTA.AllowRepeatedStatusNotification||When option is true, JMS allows to call onLogout() callback if no onLogon() callback was called. False by default.||N||false|
|TransportLayer.JMSTA.ConnectionNames||Comma delimited list of TA connections.|
Separate configuration section for each listed connection should be specified
|TransportLayer.JMSTA.ClientNames||Comma delimited list of TA clients.|
Separate configuration section for each listed client should be specified
JNDI option. The fully qualified class name of the factory class that will create the initial context. An initial context is the starting point for naming operations.
|C, required if JNDI mechanism is used|
|TransportLayer.JMSTA.Connection.[ConnectionName].ProviderURI||JMS provider URI that defines where the Connection that is created is to connect to as well as the protocol that should be used, for example TCP/IP. Additionally configuration information can be encoded in the URI.||Y|
|TransportLayer.JMSTA.Connection.[ConnectionName].ConnectionFactory||JNDI option. Connection factory object name in the JNDI object store.||C, required if JNDI mechanism is used|
|TransportLayer.JMSTA.Connection.[ConnectionName].Reconnect||Enables or disables reconnect procedure for connection restore||N||false|
|TransportLayer.JMSTA.Connection.[ConnectionName].ReconnectTries||Number of reconnect tries or -1 for an infinite number of attempts||N||3|
|TransportLayer.JMSTA.Connection.[ConnectionName].ReconnectInterval||Fixed interval in milliseconds between reconnection attempts||N||2000|
|TransportLayer.JMSTA.Client.[ClientName].ConnectionName||Name of primary connection used by client. Connection should be registered in ConnectionNames enumeration and has all required parameters||Y|
|TransportLayer.JMSTA.Client.[ClientName].StorageDir||Directory where persistence file is stored in case the communication problem||Y, if persistent mode is enabled|
Session messaging mode:
Queue - Point-To-Point. Each message is addressed to a specific queue, and receiving clients extract messages from the queue(s) established to hold their messages. Queues retain all messages sent to them until the messages are consumed or until the messages expire.Topic - Publish/Subscribe. In a pub/sub product or application, clients address messages to a topic. Publishers and subscribers are generally anonymous and may dynamically publish or subscribe to the content hierarchy. The system takes care of distributing the messages arriving from a topic’s multiple publishers to its multiple subscribers. Topics retain messages only as long as it takes to distribute them to current subscribers.
|TransportLayer.JMSTA.Client.[ClientName].DestinationURI||URI of session destination (Queue name)||Y|
Specifies whether sent messages are lost if the JMS provider fails.
Persist - instructs the JMS provider to take extra care to ensure that a message is not lost in transit in case of a JMS provider failure. A message sent with this delivery mode is logged to stable storage when it is sent.
NoPersist - does not require the JMS provider to store the message or otherwise guarantee that it is not lost if the provider fails.
NOTE: used only for Producer sessions.
|TransportLayer.JMSTA.Client.[ClientName].TimeToLive||This value defines a message expiration time (in milliseconds) that is the sum of the message's time-to-live and the GMT when it is sent (for transacted sends, this is the time the client sends the message, not the time the transaction is committed). Setting parameter value to "0" will lead to infinite TTL.||Y||3000|
Defines mode in which the Session will acknowledge the messages that it receives and dispatches.
Auto - With this acknowledgement mode, the session automatically acknowledges a client's receipt of a message either when the session has successfully returned from a call to receive or when the message listener the session has called to process the message successfully returns.
Client - With this acknowledgement mode, the client acknowledges a consumed message by calling the message's acknowledge method. Acknowledging a consumed message acknowledges all messages that the session has consumed. When client acknowledgement mode is used, a client may build up a large number of unacknowledged messages while attempting to process them.
DupsOk - This acknowledgement mode instructs the session to lazily acknowledge the delivery of messages. This is likely to result in the delivery of some duplicate messages if the JMS provider fails, so it should only be used by consumers that can tolerate duplicate messages. Use of this mode can reduce session overhead by minimizing the work the session does to prevent duplicates.
JMS Message type used for this session.
Bytes - A stream of interpreted bytes. This message type is for literally encoding a body to match an existing message format.
Text - Data is stored as a string. This message type is useful for exchanging simple text messages and for more complex character data, such as XML documents.
Custom - The ability to use your own message type. This message type is useful for adaptation to already existing systems. For this message type property TransportLayer.JMSTA.Client.[ClientName].CustomMessageType is required.
Class of custom message type implementation. This should be the implementation of one of the interface:
NOTE: used only for Custom message type.
|Y, if MessageType is Custom|
Sending/consuming of messages in the session is transacted.
true - transacted.
false - not transacted. The value is used by default.
Max number of message for one transaction. Take from queue the available number of message but no more than that specified in this property.
NOTE: used only if transacted is enabled.
|TransportLayer.JMSTA.Client.[ClientName].QueueSize||Max number of messages in queue. Message is queued until successfully sent. Waiting for space to become available if the queue is full.||N||100|
Store messages in file until it committed. It allows to restore and send messages after a sudden cardiac application.
true – persistent queue.false – in memory queue. Faster but less safe, some messages may be lost after restart.
After reaching this size, adapter waits when the queue will be empty for to truncate file. File size in Mbytes.
NOTE: used only for persistent queue.
After reaching this size, adapter truncate the file and overwrites the messages that are queued. File size in Mbytes.
NOTE: used only for persistent queue.
Durable topic subscriptions allows receiving messages published while the subscriber is not active. Durable subscriptions offer the reliability of queues to the publish/subscribe message domain.
true - Subscription is durable.
false - Subscription is not durable.
|TransportLayer.JMSTA.Client.[ClientName].DurableSubscriptionName||Durable subscription name.||Y, required if DurableSubscription set to true.|
Number of JMS connections.
Adaptor will open given amount of connections to JMS server for given session to send simultaneously.
NOTE: Please pay attention that if a number of connection is greater then 1 that there is no guaranty that messages will be placed to JMS in the same order they were received by adapter.
Number of threads per one JMS connection. Adaptor will open given amount of JMS sessions for each JMS connection to send simultaneously.
NOTE: Please pay attention that if a number of thread per connection is greater then 1 that there is no guaranty that messages will be placed to JMS in the same order they were received by adapter.
Note that all changes in the properties file are applied only after FixEdge restart.
Linux and Windows default configuration have different relative paths
- On linux all relative paths should be set from FIXEdge bin/ directory (e.g /home/user/B2BITS/FixEdge/v.5.8.0.x/bin) because packages for various OS has different values of FIXEdge.RootDir parameter in FIXEdge.properties.
JMS Transport Adapter fails with "Exception description.java.lang.IllegalArgumentException: Problem with initiation of InitialContext. Cannot instantiate class"
Issues in the logs
JMS transport adapter libraries (e.g JMS ta, Tibco, active MQ, etc..) are not found in the configured classpath:
- Make sure that libraries are placed to jms-ta-distribution/tool/lib/.
Check if the required libraries are defined in JVM properties files (JVM_Options.jvmopts) classpath
The recent version of TIBCO EMS libraries uses jms version 2.0 or newer. For this case jms-2.0.jar should be also copied to to FIXEdge1\conf\jms-ta-distribution\lib and added to the classpath: