Skip to content

Commit f9a1e89

Browse files
Package rename to com.ibm.eventstreams.connect.mqsource.
1 parent 058bdde commit f9a1e89

File tree

11 files changed

+33
-33
lines changed

11 files changed

+33
-33
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ There are two record builders supplied with the connector, although you can writ
6161

6262
There are three converters build into Apache Kafka and another which is part of the Confluent Platform. You need to make sure that the incoming message format, the setting of the *mq.message.body.jms* configuration, the record builder and converter are all compatible. By default, everything is just treated as bytes but if you want the connector to understand the message format and apply more sophisticated processing such as single-message transforms, you'll need a more complex configuration. The following table shows the basic options that work.
6363

64-
| Record builder class | Incoming MQ message | mq.message.body.jms | Converter class | Outgoing Kafka message |
65-
| ----------------------------------------------------- | ---------------------- | ------------------- | ------------------------------------------------------ | ----------------------- |
66-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | Any | false (default) | org.apache.kafka.connect.converters.ByteArrayConverter | **Binary data** |
67-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | JMS BytesMessage | true | org.apache.kafka.connect.converters.ByteArrayConverter | **Binary data** |
68-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | JMS TextMessage | true | org.apache.kafka.connect.storage.StringConverter | **String data** |
69-
| com.ibm.mq.kafkaconnect.builders.JsonRecordBuilder | JSON, may have schema | Not used | org.apache.kafka.connect.json.JsonConverter | **JSON, no schema** |
70-
| com.ibm.mq.kafkaconnect.builders.JsonRecordBuilder | JSON, may have schema | Not used | io.confluent.connect.avro.AvroConverter | **Binary-encoded Avro** |
64+
| Record builder class | Incoming MQ message | mq.message.body.jms | Converter class | Outgoing Kafka message |
65+
| ------------------------------------------------------------------- | ---------------------- | ------------------- | ------------------------------------------------------ | ----------------------- |
66+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | Any | false (default) | org.apache.kafka.connect.converters.ByteArrayConverter | **Binary data** |
67+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | JMS BytesMessage | true | org.apache.kafka.connect.converters.ByteArrayConverter | **Binary data** |
68+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | JMS TextMessage | true | org.apache.kafka.connect.storage.StringConverter | **String data** |
69+
| com.ibm.eventstreams.connect.mqsource.builders.JsonRecordBuilder | JSON, may have schema | Not used | org.apache.kafka.connect.json.JsonConverter | **JSON, no schema** |
70+
| com.ibm.eventstreams.connect.mqsource.builders.JsonRecordBuilder | JSON, may have schema | Not used | io.confluent.connect.avro.AvroConverter | **Binary-encoded Avro** |
7171

7272
There's no single configuration that will always be right, but here are some high-level suggestions.
7373

@@ -94,13 +94,13 @@ value.converter=org.apache.kafka.connect.storage.StringConverter
9494
### The gory detail
9595
The messages received from MQ are processed by a record builder which builds a Kafka Connect record to represent the message. There are two record builders supplied with the MQ source connector. The connector has a configuration option *mq.message.body.jms* that controls whether it interprets the MQ messages as JMS messages or regular MQ messages.
9696

97-
| Record builder class | mq.message.body.jms | Incoming message body | Value schema | Value class |
98-
| ----------------------------------------------------- | ------------------- | --------------------- | ------------------ | ------------------ |
99-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | false (default) | Any | OPTIONAL_BYTES | byte[] |
100-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | true | JMS BytesMessage | null | byte[] |
101-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | true | JMS TextMessage | null | String |
102-
| com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder | true | Everything else | *EXCEPTION* | *EXCEPTION* |
103-
| com.ibm.mq.kafkaconnect.builders.JsonRecordBuilder | Not used | JSON | Depends on message | Depends on message |
97+
| Record builder class | mq.message.body.jms | Incoming message body | Value schema | Value class |
98+
| ------------------------------------------------------------------- | ------------------- | --------------------- | ------------------ | ------------------ |
99+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | false (default) | Any | OPTIONAL_BYTES | byte[] |
100+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | true | JMS BytesMessage | null | byte[] |
101+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | true | JMS TextMessage | null | String |
102+
| com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder | true | Everything else | *EXCEPTION* | *EXCEPTION* |
103+
| com.ibm.eventstreams.connect.mqsource.builders.JsonRecordBuilder | Not used | JSON | Depends on message | Depends on message |
104104

105105
You must then choose a converter than can handle the value schema and class. There are three basic converters built into Apache Kafka, with the likely useful combinations in **bold**.
106106

@@ -128,7 +128,7 @@ In MQ, the message ID and correlation ID are both 24-byte arrays. As strings, th
128128
The connector supports authentication with user name and password and also connections secured with TLS using a server-side certificate and mutual authentication with client-side certificates.
129129

130130
### Setting up TLS using a server-side certificate
131-
To enable use of TLS, set the configuration `mq.ssl.cipher.suite` to the name of the cipher suite which matches the CipherSpec in the SSLCIPH attribute of the MQ server-connection channel. Use the table of supported cipher suites for MQ 9.0.x [here](https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.dev.doc/q113220_.htm) as a reference. Note that the names of the CipherSpecs as used in the MQ configuration are not necessarily the same as the cipher suite names that the connector uses. The connector uses the JMS interface so it follows the Java conventions.
131+
To enable use of TLS, set the configuration `mq.ssl.cipher.suite` to the name of the cipher suite which matches the CipherSpec in the SSLCIPH attribute of the MQ server-connection channel. Use the table of supported cipher suites for MQ 9.1 [here] ((https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.1.0/com.ibm.mq.dev.doc/q113220_.htm) as a reference. Note that the names of the CipherSpecs as used in the MQ configuration are not necessarily the same as the cipher suite names that the connector uses. The connector uses the JMS interface so it follows the Java conventions.
132132

133133
You will need to put the public part of the queue manager's certificate in the JSSE truststore used by the Kafka Connect worker that you're using to run the connector. If you need to specify extra arguments to the worker's JVM, you can use the EXTRA_ARGS environment variable.
134134

config/mq-source.properties

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# limitations under the License.
1414

1515
name=mq-source
16-
connector.class=com.ibm.mq.kafkaconnect.MQSourceConnector
16+
connector.class=com.ibm.eventstreams.connect.mqsource.MQSourceConnector
1717

1818
# You can increase this for higher throughput, but message ordering will be lost
1919
tasks.max=1
@@ -37,8 +37,8 @@ mq.queue=
3737
# mq.password=
3838

3939
# The record builders control conversion of data between the messages in MQ and the internal Kafka Connect representation - required
40-
mq.record.builder=com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder
41-
# mq.record.builder=com.ibm.mq.kafkaconnect.builders.JsonRecordBuilder
40+
mq.record.builder=com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder
41+
# mq.record.builder=com.ibm.eventstreams.connect.mqsource.builders.JsonRecordBuilder
4242

4343
# Whether to interpret the message body as a JMS message type (default false) - optional
4444
# mq.message.body.jms=
@@ -49,7 +49,7 @@ mq.record.builder=com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder
4949
# mq.record.builder.key.header=
5050

5151
# The name of the cipher suite for TLS (SSL) connection (default blank, meaning do not use TLS) - optional
52-
# See https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.0.0/com.ibm.mq.dev.doc/q113220_.htm for valid values
52+
# See https://www.ibm.com/support/knowledgecenter/en/SSFKSJ_9.1.0/com.ibm.mq.dev.doc/q113220_.htm for valid values
5353
# mq.ssl.cipher.suite=
5454

5555
# The distinguished name pattern of the TLS (SSL) peer - optional

pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
1818
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
1919
<modelVersion>4.0.0</modelVersion>
20-
<groupId>com.ibm.mq.kafkaconnect</groupId>
20+
<groupId>com.ibm.eventstreams.connect</groupId>
2121
<artifactId>kafka-connect-mq-source</artifactId>
2222
<packaging>jar</packaging>
2323
<version>1.0-SNAPSHOT</version>
@@ -63,7 +63,7 @@
6363
<dependency>
6464
<groupId>com.ibm.mq</groupId>
6565
<artifactId>com.ibm.mq.allclient</artifactId>
66-
<version>9.0.4.0</version>
66+
<version>9.1.0.0</version>
6767
</dependency>
6868

6969
<dependency>

src/main/java/com/ibm/mq/kafkaconnect/JMSReader.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/JMSReader.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect;
16+
package com.ibm.eventstreams.connect.mqsource;
1717

1818
import com.ibm.mq.MQException;
1919
import com.ibm.mq.constants.MQConstants;
2020
import com.ibm.mq.jms.*;
21-
import com.ibm.mq.kafkaconnect.builders.RecordBuilder;
21+
import com.ibm.eventstreams.connect.mqsource.builders.RecordBuilder;
2222
import com.ibm.msg.client.wmq.WMQConstants;
2323

2424
import java.util.Map;

src/main/java/com/ibm/mq/kafkaconnect/MQSourceConnector.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/MQSourceConnector.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect;
16+
package com.ibm.eventstreams.connect.mqsource;
1717

1818
import java.util.ArrayList;
1919
import java.util.List;

src/main/java/com/ibm/mq/kafkaconnect/MQSourceTask.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/MQSourceTask.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect;
16+
package com.ibm.eventstreams.connect.mqsource;
1717

1818
import java.util.ArrayList;
1919
import java.util.List;

src/main/java/com/ibm/mq/kafkaconnect/builders/BaseRecordBuilder.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/builders/BaseRecordBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect.builders;
16+
package com.ibm.eventstreams.connect.mqsource.builders;
1717

18-
import com.ibm.mq.kafkaconnect.MQSourceConnector;
18+
import com.ibm.eventstreams.connect.mqsource.MQSourceConnector;
1919

2020
import java.util.Map;
2121

src/main/java/com/ibm/mq/kafkaconnect/builders/DefaultRecordBuilder.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/builders/DefaultRecordBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect.builders;
16+
package com.ibm.eventstreams.connect.mqsource.builders;
1717

1818
import javax.jms.BytesMessage;
1919
import javax.jms.JMSContext;
@@ -41,7 +41,7 @@ public class DefaultRecordBuilder extends BaseRecordBuilder {
4141
private static final Logger log = LoggerFactory.getLogger(DefaultRecordBuilder.class);
4242

4343
public DefaultRecordBuilder() {
44-
log.info("Building records using com.ibm.mq.kafkaconnect.builders.DefaultRecordBuilder");
44+
log.info("Building records using com.ibm.eventstreams.connect.mqsource.builders.DefaultRecordBuilder");
4545
}
4646

4747
/**

src/main/java/com/ibm/mq/kafkaconnect/builders/JsonRecordBuilder.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/builders/JsonRecordBuilder.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect.builders;
16+
package com.ibm.eventstreams.connect.mqsource.builders;
1717

1818
import static java.nio.charset.StandardCharsets.*;
1919

@@ -43,7 +43,7 @@ public class JsonRecordBuilder extends BaseRecordBuilder {
4343
private JsonConverter converter;
4444

4545
public JsonRecordBuilder() {
46-
log.info("Building records using com.ibm.mq.kafkaconnect.builders.JsonRecordBuilder");
46+
log.info("Building records using com.ibm.eventstreams.connect.mqsource.builders.JsonRecordBuilder");
4747
converter = new JsonConverter();
4848

4949
// We just want the payload, not the schema in the output message

src/main/java/com/ibm/mq/kafkaconnect/builders/RecordBuilder.java renamed to src/main/java/com/ibm/eventstreams/connect/mqsource/builders/RecordBuilder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
* See the License for the specific language governing permissions and
1414
* limitations under the License.
1515
*/
16-
package com.ibm.mq.kafkaconnect.builders;
16+
package com.ibm.eventstreams.connect.mqsource.builders;
1717

1818
import java.util.Map;
1919

0 commit comments

Comments
 (0)