Connection specifications document

A connection specifications document is an XML document that describes how operators in the MQTT Toolkit connect to and access messaging systems.

The compiler checks that the document conforms to the semantic rules of the XML schema that is defined for these documents. The SPL compiler uses the information that is given in the connection specifications to configure the operator. The compiler does not attempt to connect to the messaging system or access its data to verify correct configuration at compile time. The operators have run-time checks to validate configuration; if the configuration is incorrect these checks might result in run time failures, which are captured in the processing element logs.

For MQTTSink and MQTTSource operators, the connection specifications document that is named by the connectionDocument operator parameter contains only a <connection_specification> element. The connectionDocument operator parameter is not mandatory. You can specify the connection information as parameters to the operator.

A valid connection specifications document consists of a connections root element which contains one <connection_specifications> element. These elements serve as containers for the connection specifications. Here is an abridged example of a complete connection specifications document, with all <connection_specification> elements omitted:


<?xml version="1.0" encoding="UTF-8"?>
<st:connections xmlns:st="http://www.ibm.com/xmlns/prod/streams/adapters"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <connection_specifications>
  ...
  </connection_specifications>
</st:connections>
Connection_specification element