Overview

Prerequisites: See Key Concepts in Gateway Application section and application configuration, before proceeding with this step.

When writing a Gateway application, there are several key steps involved. First, you need to analyze the types of Services that are required for your application. Next, you must identify necessary configuration parameters for the ServiceTypes. These parameters play a crucial role in defining the behaviour and settings of your Gateway application..

Following that, you need to consider supporting "sharedConfigs," which allow reuse of configurations across multiple instances of the Services.

Additionally, you should consider using the Payload Converter to handle data conversion between an external system and the specific format needed by the Diffusion topic. If custom conversion is needed, you may have to write a custom Payload Converter.

Finally, to specify all above details, you will need to implement the required interfaces provided by the Framework.

Broadly, developing a Gateway application requires the following steps:

  1. Getting framework resources

  2. Setting up logging

  3. Implementing the GatewayApplication interface

  4. Implementing service handlers

  5. Implementing Payload converters (if required)

  6. Application Initialization

The diagram below illustrates the basic architecture of the Gateway Application.

gateway framework architecture new
Figure 1. Gateway application architecture

Gateway application examples are provided, for demonstration of development of different types of Gateway applications.

CSV File adapter contains applications to integrate with CSV file contents. The csv-file-source can read the contents of a CSV file and publish to Diffusion topics. The csv-file-sink can consume data from Diffusion JSON topics and save the contents as CSV files.

This section will include code snippets from the example project to demonstrate the crucial steps in developing the Gateway application. However, it is crucial for developers to refer to the complete example source code, as certain details have been omitted for brevity.

For detailed information about the interfaces involved in writing a Gateway Framework application, refer to the Javadoc that is released with the product.