Skip to content

CHANGELOG.md

Latest commit

 

History

History
330 lines (257 loc) · 12 KB

CHANGELOG.md

File metadata and controls

330 lines (257 loc) · 12 KB

How to Deploy EMA RTO Application to Azure

  • Last Update: Mar 2026
  • Compiler: Supported Java versions, Docker, and Maven
  • Prerequisite: RTO Authentication Version 2 (or 1) credential

Example Code Disclaimer: ALL EXAMPLE CODE IS PROVIDED ON AN “AS IS” AND “AS AVAILABLE” BASIS FOR ILLUSTRATIVE PURPOSES ONLY. REFINITIV MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, AS TO THE OPERATION OF THE EXAMPLE CODE, OR THE INFORMATION, CONTENT, OR MATERIALS USED IN CONNECTION WITH THE EXAMPLE CODE. YOU EXPRESSLY AGREE THAT YOUR USE OF THE EXAMPLE CODE IS AT YOUR SOLE RISK.

What I have changed from the original project

Let me start by explaining the updated that I have made to support the RTO connection.

pom.xml file

Firstly, I added spring-dotenv dependencies to the project to load the RTO Authentication Version 2 credential from the Environment Variable or a .env file (see configuration in the environment for more detail).

The pom.xml file:

<dependency>
 <groupId>me.paulschwarz</groupId>
 <artifactId>spring-dotenv</artifactId>
 <version>4.0.0</version>
</dependency>

Next, I also updated the version of RTSDK and Spring Boot in the pom.xml file as follows:

Last Updated: Mar 2026

Updated the versions of spring-boot-starter-parent and rtsdk.

<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>3.5.12</version>
  <relativePath/> <!-- lookup parent from repository -->
 </parent>
...
<properties>
  <java.version>11</java.version>
  <maven.test.skip>true</maven.test.skip>
  <rtsdk.version>3.9.2.0</rtsdk.version>
 </properties>

Lastly, I added a dependency exclusions on the EMA's slf4j-jdk14 library to force the application to use Spring's default Logback library instead.

<dependency>
  <groupId>com.refinitiv.ema</groupId>
  <artifactId>ema</artifactId>
  <version>${rtsdk.version}</version>
  <exclusions>
    <exclusion> 
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-jdk14</artifactId>
    </exclusion>
  </exclusions> 
</dependency>

Finally, I have updated an application version to 1.0-snapshot.

<version>1.0-SNAPSHOT</version>

That covers the pom.xml file changed part.

application.properties file

Turning to the application configuration file. I have added the new MarketData.ConnectionMode configuration node to the application.properties file as follows to make the application supports both RTO and deployed RTDS connections:

#Choose connection mode RTDS or RTO
MarketData.ConnectionMode=RTO
#MarketData.ConnectionMode=RTDS

The code needs to support the RTO with Authentication Version 1, so I am adding the following new property to the the application.properties file

#Choose RTO Authentication mode V1 (Machine-ID) or V2 (Service Account), only for MarketData.ConnectionMode=RTO
MarketData.RTOAuthenMode=V2

This new configuration also need a code changed on a Consumer.java file:

@Service
public class Consumer {
 // market data configuration values read from application.properties

 @Value("${MarketData.ConnectionMode}")
 private String connectionMode;
 ...
}

Let’s leave the application.properties file there.

Consumer.java file

Now, what about application source code updated. The next step is change a Consumer.java to load RTO credential from the Environment Variables or a .env file.

  • For Version 2 Authentication, loads Client ID and Client Secret
  • For Version 1 Authentication, loads Machine ID, Password, and App Key
@Service
public class Consumer {
 ...
  /** V2 Service Account client ID — required when connectionMode=RTO and rtoAuthenMode=V2 */
	@Value("${CLIENT_ID}")
	private String client_id;

	/** V2 Service Account client secret — required when connectionMode=RTO and rtoAuthenMode=V2 */
	@Value("${CLIENT_SECRET}")
	private String client_secret;

	/** V1 Machine-ID username — required when connectionMode=RTO and rtoAuthenMode=V1 */
	@Value("${RTO_MACHINE_ID}")
	private String rto_machine_id;

	/** V1 Machine-ID password — required when connectionMode=RTO and rtoAuthenMode=V1 */
	@Value("${RTO_PASSWORD}")
	private String rto_password;

	/** V1 application key — required when connectionMode=RTO and rtoAuthenMode=V1 */
	@Value("${RTO_APPKEY}")
	private String rto_appkey;
 ...
}

Then changed the code to

  • Initialize the OmmConsumer object based on a MarketData.ConnectionMode configuration.
  • Create a share OmmConsumerConfig object to store each configuration above.
  • If MarketData.ConnectionMode is RTO, set a RTO credential based on MarketData.RTOAuthenMode configuration.
private OmmConsumerConfig config = null;

public void initialize() {
    // ...

    // create a shared OmmConsumerConfig that will be customized below
    config = EmaFactory.createOmmConsumerConfig();

    if (connectionMode.equals("RTDS")) {
        LOG.info("Starting OMMConsumer with following parameters: ");
        // ...

        // connect directly to the ADS using hostname/port and DACS username
        consumer = EmaFactory.createOmmConsumer(config.host(hostName + ":" + port).username(userName));

    } else if (connectionMode.equals("RTO")) {
        LOG.info("Starting OMMConsumer connecting to RTO with following parameters: ");
        // ...

        // configure credentials based on the RTO authentication mode
        if (rtoAuthenMode.equals("V1")) {
            LOG.info("RTO Authentication Mode: V1 (Machine-ID)");
            // V1 uses a personal Machine-ID, password, and application key
            config.consumerName("Consumer_RTO").username(rto_machine_id).password(rto_password).clientId(rto_appkey);
        } else if (rtoAuthenMode.equals("V2")) {
            LOG.info("RTO Authentication Mode: V2 (Service Account)");
            // V2 uses a service account client ID and secret (OAuth2 client credentials)
            config.consumerName("Consumer_RTO").clientId(client_id).clientSecret(client_secret);
        }

        // connect to RTO using the configured credentials
        consumer = EmaFactory.createOmmConsumer(config);
    }
    // ...
}

I am also added .env (.gitignore) and .env.example files for set the RTO credential locally as follows:

#Authentication V2
CLIENT_ID=<Your Auth V2 Client-ID>
CLIENT_SECRET=<Your Auth V2 Client-Secret>

#Authentication V1
RTO_MACHINE_ID=<Your Auth V1 Machine-ID>
RTO_PASSWORD=<Your Auth V1 Password>
RTO_APPKEY=<Your Auth V1 AppKey>

That is all I have to say about the Consumer.java file.

MDController.java

I am adding the try catch on the onApplicationEvent callback method.

@EventListener
	public void onApplicationEvent(ContextRefreshedEvent event) {
		try {
			LOG.info("Initialize the consumer and connect to market data system....");
			ommCons.initialize();
		} catch (Exception e) {
			LOG.error("Failed to initialize consumer: {}", e.getMessage(), e);
			// You might want to set a flag or take other action to indicate initialization failure
		}
	}

That’s all I have to say about the application source code changed.

EmaConfig.xml file

That brings us to the new project's configuration file, the EmaConfig.xml file. It gives us the easiest way to connect to RTO with the Service Discovery (dynamically gets RTO endpoints) is via the Location and EnableSessionManagement configurations of the newly added EmaConfig.xml file.

  • The Location configuration specifies the cloud location of the RTO endpoint to which the RTSDK API establishes a connection.
  • The EnableSessionManagement configuration specifies whether the channel manages the authentication token (obtain and refresh) on behalf of the user.

The content in the EMA configuration file (EmaConfig.xml) looks like this:

<ConsumerGroup>
 <!-- DefaultConsumer parameter defines which consumer configuration is used by OmmConsumer -->
 <!-- if application does not specify it through OmmConsumerConfig::consumerName() -->
 <!-- first consumer on the ConsumerList is a DefaultConsumer if this parameter is not specified	-->
 <ConsumerList>
  <Consumer>
   <Name value="Consumer_RTO"/>
   <Channel value="Channel_RTO"/>
   <Dictionary value="Dictionary_1"/>
   <MaxDispatchCountApiThread value="6500"/>
   <MaxDispatchCountUserThread value="6500"/>
   <XmlTraceToStdout value="0"/>
  </Consumer>
 </ConsumerList>
</ConsumerGroup>
...
<ChannelGroup>
 <ChannelList>
  <Channel>
   <Name value="Channel_RTO"/>
   <ChannelType value="ChannelType::RSSL_ENCRYPTED"/>
   <CompressionType value="CompressionType::None"/>
   <GuaranteedOutputBuffers value="5000"/>
   <!-- EMA discovers a host and a port from RDP service discovery for the specified location
				 when both of them are not set and the session management is enable. -->
   <Location value="ap-southeast"/>
   <EnableSessionManagement value="1"/>
   <ObjectName value=""/>
  </Channel>
 </ChannelList>
</ChannelGroup>

Note: The above example uses "ap-southeast" as an example RTO region. You can optionally change this to test other endpoints within your region. Please check with your LSEG representative. To retrieve a valid list of RTO endpoints based on your assigned tier and region, refer to the DNS Names within the Current Endpoints section outlined in the Real-Time - Optimized Install and Config Guide document.

The Consumer_RTDS consumer node and Channel_RTDS channel node have been added to the EmaConfig.xml file for supporting both RTO and RTDS connections too.

<ConsumerGroup>
 <!-- DefaultConsumer parameter defines which consumer configuration is used by OmmConsumer -->
 <!-- if application does not specify it through OmmConsumerConfig::consumerName() -->
 <!-- first consumer on the ConsumerList is a DefaultConsumer if this parameter is not specified	-->
 <DefaultConsumer value="Consumer_RTDS"/>
 <ConsumerList>
  <Consumer>
   <Name value="Consumer_RTDS"/>
   <Channel value="Channel_RTDS"/>
   <Dictionary value="Dictionary_1"/>
   <XmlTraceToStdout value="0"/>
  </Consumer>
 </ConsumerList>
</ConsumerGroup>


<ChannelGroup>
 <ChannelList>
  <Channel>
   <Name value="Channel_RTDS"/>
   <ChannelType value="ChannelType::RSSL_SOCKET"/>
   <CompressionType value="CompressionType::None"/>
   <GuaranteedOutputBuffers value="5000"/>
   <ConnectionPingTimeout value="30000"/>
   <TcpNodelay value="1"/>
   <Host value="localhost"/>
   <Port value="14002"/>
  </Channel>
 </ChannelList>
</ChannelGroup>

Dockerfile file

Now, what about a Dockerfile? A Dockerfile has been updated to use multi-stage build as follows:

FROM --platform=linux/amd64 maven:3.9.6-eclipse-temurin-11-focal as builder
LABEL authors="Developer Relations"
WORKDIR /app
COPY pom.xml .
RUN mvn dependency:go-offline -B
COPY src ./src
RUN mvn clean -e -B package

#FROM openjdk:11-jre-slim-bullseye
FROM --platform=linux/amd64 eclipse-temurin:11-jre-alpine
WORKDIR /app
COPY --from=builder /app/target/MDWebService-0.0.1-SNAPSHOT.jar .
COPY EmaConfig.xml .

# run MDWebService-0.0.1-SNAPSHOT.jar with CMD
CMD ["java", "-jar", "./MDWebService-0.0.1-SNAPSHOT.jar"]

I also add a .dockerignore file to not include some project files and directories into a container.

That covers all the changed I made on this project.

How to run MDWebService with RTO connection

Please check the README.md file.

How to deploy to Azure Cloud Service

Please see more detail on the AZURE.md file.