Merge pull request #362 from IBMStreams/develop

Merge latest changes

README.md

@@ -2,6 +2,19 @@
 
 The IBMStreams/streamsx.messaging toolkit project is an open source Streams toolkit project focused on the development of operators and functions that extend IBM InfoSphere Streams ability to interact with messaging systems.
 
+---
+
+**After release v5.4.2 the complete toolkit is deprecated**. Please, use the following alternatives to communicate with various message queues:
+| Message Queue | New Toolkit |
+| ------------- | ----------- |
+| JMS |      [streamsx.jms](https://github.com/IBMStreams/streamsx.jms) |
+| Kafka |    [streamsx.kafka](https://github.com/IBMStreams/streamsx.kafka) |
+| MQTT |     [streamsx.mqtt](https://github.com/IBMStreams/streamsx.mqtt) |
+| RabbitMQ | [streamsx.rabbitmq](https://github.com/IBMStreams/streamsx.rabbitmq) |
+| XMS |      no toolkit planned yet |
+
+---
+
 Messaging Toolkit v5.1 is offically released to support InfoSphere Streams v4.2:
 * https://github.com/IBMStreams/streamsx.messaging/releases
 
@@ -29,12 +42,3 @@ To learn more about Streams:
 * [Introduction to Streams Quick Start Edition](http://ibmstreams.github.io/streamsx.documentation/docs/4.1/qse-intro/)
 * [Streams Getting Started Guide](http://ibmstreams.github.io/streamsx.documentation/docs/4.1/qse-getting-started/)
 * [StreamsDev](https://developer.ibm.com/streamsdev/)
-
-
-**Deprecations**
-
-The support for RabbitMQ, Kafka, and MQTT in this toolkit is deprecated. For these types of messaging systems, use one of the following specialized open source toolkits:
-
-* [streamsx.kafka](https://github.com/IBMStreams/streamsx.kafka)
-* [streamsx.rabbitmq](https://github.com/IBMStreams/streamsx.rabbitmq)
-* [streamsx.mqtt](https://github.com/IBMStreams/streamsx.mqtt)

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.jms/JMSSink/JMSSink.xml

@@ -9,6 +9,11 @@
   <javaOperatorModel>
     <context>
       <description docHref="doc/${nl}/spldoc/html/tk$com.ibm.streamsx.messaging/op$com.ibm.streamsx.messaging.jms$JMSSink.html">
+**DEPRECATED**: The `com.ibm.streamsx.messaging.jms.JMSSink` operator is deprecated
+and is replaced by the `com.ibm.streamsx.jms.JMSSink` operator in the `com.ibm.streamsx.jms` toolkit.
+The deprecated operator might be removed in a future release.
+
+
 The `JMSSink` operator creates messages from InfoSphere Streams tuples
 and writes the messages to a WebSphere MQ or an Apache Active MQ queue or topic.
 
@@ -183,8 +188,8 @@ The following example shows a sample connections.xml file:
 	&lt;/access_specifications>
 	&lt;/st:connections>
 </description>
-      <iconUri size="16">JMSSink_16.gif</iconUri>
-      <iconUri size="32">JMSSink_32.gif</iconUri>
+      <iconUri size="16">JMSSink_deprecated_16.gif</iconUri>
+      <iconUri size="32">JMSSink_deprecated_32.gif</iconUri>
       <metrics>
         <metric>
           <name>nTruncatedInserts</name>

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.jms/JMSSource/JMSSource.xml

@@ -13,6 +13,10 @@
   <javaOperatorModel>
     <context> 
       <description docHref="doc/${nl}/spldoc/html/tk$com.ibm.streamsx.messaging/op$com.ibm.streamsx.messaging.jms$JMSSource.html">
+**DEPRECATED**: The `com.ibm.streamsx.messaging.jms.JMSSource` operator is deprecated
+and is replaced by the `com.ibm.streamsx.jms.JMSSource` operator in the `com.ibm.streamsx.jms` toolkit.
+The deprecated operator might be removed in a future release.
+
 The `JMSSource` operator reads data from a WebSphere MQ or an Apache Active MQ queue
 or a topic and creates tuples from the read data. 
 
@@ -188,8 +192,8 @@ This example shows the use of multiple `JMSSource` operators with different para
 	}
 	}                                                                                           
 </description>
-  	  <iconUri size="16">JMSSource_16.gif</iconUri>
-	  <iconUri size="32">JMSSource_32.gif</iconUri>
+  	  <iconUri size="16">JMSSource_deprecated_16.gif</iconUri>
+	  <iconUri size="32">JMSSource_deprecated_32.gif</iconUri>
 	  <metrics>
       	<metric>
           <name>nMessagesRead</name>

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.xms/XMSSink/XMSSink.xml

@@ -7,6 +7,10 @@ others. All Rights Reserved.
   <cppOperatorModel>
     <context>
       <description docHref="doc/${nl}/spldoc/html/tk$com.ibm.streamsx.messaging/op$com.ibm.streamsx.messaging.xms$XMSSink.html">
+**DEPRECATED**: The `com.ibm.streamsx.messaging.xms.XMSSink` operator is deprecated. There is no toolkit
+providing a replacement operator. The deprecated operator might be removed in a future release.
+
+
 The `XMSSink` operator takes messages from IBM InfoSphere Streams and can send them to a WebSphere MQ queue or topic.
 
 The incoming tuple from InfoSphere Streams can be one or many of the following data types:
@@ -160,8 +164,8 @@ The following is a sample `connections.xml` file:
 	  &lt;/access_specifications>
 	&lt;/st:connections>	
 </description>
-      <iconUri size="16">XMSSink_16.gif</iconUri>
-      <iconUri size="32">XMSSink_32.gif</iconUri>
+      <iconUri size="16">XMSSink_deprecated_16.gif</iconUri>
+      <iconUri size="32">XMSSink_deprecated_32.gif</iconUri>
       <metrics>
         <metric>
           <name>nTruncatedInserts</name>

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.xms/XMSSink/XMSSink_cpp.cgt

@@ -145,6 +145,7 @@ if($crContext && $crContext->isStartOfRegion()) {
 // Constructor
 MY_OPERATOR::MY_OPERATOR() : nTruncatedInserts(0),nTruncatedInsertsPC( getContext().getMetrics().getCustomMetricByName("nTruncatedInserts")),nFailedInserts(0),nFailedInsertsPC( getContext().getMetrics().getCustomMetricByName("nFailedInserts")),nConnectionAttempts(0),nConnectionAttemptsPC( getContext().getMetrics().getCustomMetricByName("nConnectionAttempts"))
 {
+	SPLAPPTRC(L_ERROR, "The `com.ibm.streamsx.messaging.xms.XMSSink` operator is deprecated. There is no toolkit providing a replacement operator. The deprecated operator might be removed in a future release.", "XMSSink");
 	SPLAPPTRC(L_DEBUG, "Entry: Constructor", "XMSSink");
 
 	<%if ($isInConsistentRegion) {%>

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.xms/XMSSource/XMSSource.xml

@@ -7,6 +7,10 @@ others. All Rights Reserved.
   <cppOperatorModel>
     <context>
       <description docHref="doc/${nl}/spldoc/html/tk$com.ibm.streamsx.messaging/op$com.ibm.streamsx.messaging.xms$XMSSource.html">
+**DEPRECATED**: The `com.ibm.streamsx.messaging.xms.XMSSource` operator is deprecated. There is no toolkit
+providing a replacement operator. The deprecated operator might be removed in a future release.
+
+
 The `XMSSource` operator reads data from a WebSphere MQ queue or topic and creates tuples out of it.
 
 Each input WebSphere MQ message is converted to a separate tuple and sent to the output stream. 
@@ -142,8 +146,8 @@ This example demonstrates the use of multiple `XMSSource` operators with differe
 
 This example uses the same `connections.xml` that is provided in the example for the `XMSSink` operator.
 </description>
-      <iconUri size="16">XMSSource_16.gif</iconUri>
-      <iconUri size="32">XMSSource_32.gif</iconUri>
+      <iconUri size="16">XMSSource_deprecated_16.gif</iconUri>
+      <iconUri size="32">XMSSource_deprecated_32.gif</iconUri>
       <metrics>
         <metric>
           <name>nMessagesRead</name>

com.ibm.streamsx.messaging/com.ibm.streamsx.messaging.xms/XMSSource/XMSSource_cpp.cgt

@@ -160,7 +160,7 @@ using namespace streams_boost;
 // Constructor
 MY_OPERATOR::MY_OPERATOR(): nMessagesReadPC( getContext().getMetrics().getCustomMetricByName("nMessagesRead")),nMessagesDroppedPC( getContext().getMetrics().getCustomMetricByName("nMessagesDropped")),nConnectionAttemptsPC( getContext().getMetrics().getCustomMetricByName("nConnectionAttempts"))
 {
-
+	SPLAPPTRC(L_ERROR, "The `com.ibm.streamsx.messaging.xms.XMSSource` operator is deprecated. There is no toolkit providing a replacement operator. The deprecated operator might be removed in a future release.", "XMSSink");
 	SPLAPPTRC(L_DEBUG, "Entry: Constructor", "XMSSource");
 
 	periodVal=0.0;

com.ibm.streamsx.messaging/impl/java/src/com/ibm/streamsx/messaging/jms/JMSSink.java

@@ -41,6 +41,7 @@
 import com.ibm.streamsx.messaging.common.DataGovernanceUtil;
 import com.ibm.streamsx.messaging.common.IGovernanceConstants;
 import com.ibm.streamsx.messaging.common.PropertyProvider;
+import com.ibm.streamsx.messaging.rabbitmq.RabbitMQSink;
 
 
 //The JMSSink operator publishes data from Streams to a JMS Provider queue or a topic.
@@ -571,6 +572,8 @@ public synchronized void initialize(OperatorContext context)
 			IOException, ParseConnectionDocumentException, SAXException,
 			NamingException, ConnectionException, Exception {
 
+		tracer.log(TraceLevel.ERROR, "The `com.ibm.streamsx.messaging.jms.JMSSink` operator is deprecated and is replaced by the `com.ibm.streamsx.jms.JMSSink` operator in the `com.ibm.streamsx.jms` toolkit. The deprecated operator might be removed in a future release."); //$NON-NLS-1$
+
 		tracer.log(TraceLevel.TRACE, "Begin initialize()"); //$NON-NLS-1$
 
 		tracer.log(TraceLevel.TRACE, "Calling super class initialization"); //$NON-NLS-1$

com.ibm.streamsx.messaging/impl/java/src/com/ibm/streamsx/messaging/jms/JMSSource.java

@@ -727,6 +727,8 @@ public synchronized void initialize(OperatorContext context)
 			throws ParserConfigurationException, InterruptedException,
 			IOException, ParseConnectionDocumentException, SAXException,
 			NamingException, ConnectionException, Exception {
+
+		tracer.log(TraceLevel.ERROR, "The `com.ibm.streamsx.messaging.jms.JMSSource` operator is deprecated and is replaced by the `com.ibm.streamsx.jms.JMSSource` operator in the `com.ibm.streamsx.jms` toolkit. The deprecated operator might be removed in a future release."); //$NON-NLS-1$
 
 		tracer.log(TraceLevel.TRACE, "Begin initialize()"); //$NON-NLS-1$
 

com.ibm.streamsx.messaging/info.xml

@@ -684,7 +684,7 @@ The <attribute> element has three possible attributes:
      * composite types
      * xml
 </info:description>
-    <info:version>5.4.2</info:version>
+    <info:version>5.4.3</info:version>
     <info:requiredProductVersion>4.2.0.0</info:requiredProductVersion>
   </info:identity>
   <info:dependencies/>

com.ibm.streamsx.messaging/pom.xml

@@ -6,7 +6,7 @@
     <groupId>com.ibm.streamsx.messaging</groupId>
     <artifactId>streamsx.messaging</artifactId>
     <packaging>jar</packaging>
-    <version>5.4.2</version>
+    <version>5.4.3</version>
     <name>com.ibm.streamsx.messaging</name>
     <repositories>
         <repository>