Merge pull request #362 from IBMStreams/develop

Merge latest changes

Author: schubon

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/JMSSink/JMSSink_deprecated_16.gif

@@ -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.jms/JMSSink/JMSSink_deprecated_32.gif

@@ -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.jms/JMSSource/JMSSource.xml

@@ -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) {%>