StreamBase AdapterGroup Configuration

This article provides a reference for generating a StreamBase configuration file for a certain subset of adapters and operators, where the HOCON type is com.tibco.ep.streambase.configuration.adapter and the root object is AdapterGroup.

Most StreamBase adapters are configured with settings made in the Properties view of their components on the Studio canvas.

However, a small set of operators and adapters have more complex requirements. Prior to StreamBase 10.5.0, these complex requirements were specified with a configuration file named adapter-configurations.xml which had to reside in the Studio project's src/main/resources folder. As of 10.5.0, this XML format is deprecated in favor of the HOCON format described on this page.

Configuration files of this type and root object can be edited as usual with the StreamBase Configuration File Editor. StreamBase Studio also provides an Edit button in the Properties view of any supported adapter as a shortcut to the Editor.

Adapters and operators that are configurable using the AdapterGroup root object include:

TIBCO ActiveSpaces Operators	MQTT Client Adapters (Publish, Subscribe, Ack)
Apache Cassandra Operators	OPC UA Adapters
Cluster Topic Publisher and Subscriber Adapters	Python Operator
CME iLink Order Routing Adapter	RabbitMQ Adapters (Consumer, Producer, Ack, Nack)
Diameter Client Adapters (Input, Output, Controller)	Web Server Request Adapter
Diameter Server Adapters (Input, Output, Controller)	Web Output Adapter, Web Input Adapter
Apache HBase Operators	Web Input Response Adapter, Web Server Request Adapter
Apache Kudu Operators	WITS Adapter, WITS Controller Adapter

If your project contains an adapter-configurations.xml, Studio offers to convert it to HOCON format when you click the Edit button in the Properties view. Once converted, Studio:

Each configuration file must contain the following:

There is one root object in configuration files with type com.tibco.ep.streambase.configuration.adapter that affects the adapters and operators listed here:

This section shows the subordinate objects, properties, usage, and syntax for the AdapterGroup root object.

The following shows a sample configuration in HOCON format for the Diameter adapters. For additional configuration examples, see the applicable adapter page in the Adapters Guide, or operator in the Authoring Guide, respectively.

name = "Diameter.conf"
type = "com.tibco.ep.streambase.configuration.adapter"
version = "1.0.0"
configuration = {

  // An adapter group type defines a collection of EventFlow adapter 
  // configurations, indexed by adapter type.
  AdapterGroup = {

    // A collection of EventFlow adapter configurations, indexed by adapter 
    // type. This key is required and must contain at least one configuration.
    adapters = {

      // The root section for the configuration for one EventFlow adapter.
      DiameterAdapters = {

        // Section list. This key is optional and has no default value.
        sections = [

          // A configuration for a named section for this adapter.
          {

            // Section name. The value does not have to be unique; that is, 
            // you can have·multiple sections with the same name in the same 
            // array of sections. This key·is required.
            name = "DiameterAdapter"

            // Section property bag. All values must be strings. This key is 
            // optional and has no default value.
            settings = {
              dictionary = "TestDictionary.json"
              host = ""
              id = "DiameterSectionedMessagesServer"
              originHost = "127.0.0.1"
              originRealm = "tibco.com"
              productName = "Streambase"
            }
          }

          // A configuration for a second named section for this adapter.
          {
            name = "DiameterAdapter"

            settings = {
              dictionary = "TestDictionary.json"
              host = "127.0.0.1"
              id = "DiameterSectionedMessagesClient"
              originHost = "127.0.0.1"
              originRealm = "tibco.com"
              productName = "Streambase"
            }
          }
        ]
      }
    }
  }
}