Skip to content

Commit 292b028

Browse files
Documentation tweaks
1 parent 68d528e commit 292b028

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,21 @@ To build the connector, you must have the following installed:
1010
* [Maven](https://maven.apache.org)
1111
* Java 7 or later
1212

13-
In an empty directory, clone the repository:
13+
Download the MQ client JAR by following the instructions in [Getting the IBM MQ classes for Java and JMS](https://www-01.ibm.com/support/docview.wss?uid=swg21683398). Once you've accepted the license, download the *IBM MQ JMS and Java redistributable client* file (currently called `9.0.0.1-IBM-MQC-Redist-Java.zip`). Unpack the ZIP file.
14+
15+
Clone the repository with the following command:
1416
```shell
1517
git clone https://github.com/ibm-messaging/kafka-connect-mq-source.git
1618
```
1719

18-
Download the MQ client JAR by following the instructions in [Getting the IBM MQ classes for Java and JMS](https://www-01.ibm.com/support/docview.wss?uid=swg21683398). Once you've accepted the license, download the *IBM MQ JMS and Java redistributable client* file (currently called `9.0.0.1-IBM-MQC-Redist-Java.zip`).
20+
Change directory into the `kafka-connect-mq-source` directory:
21+
```shell
22+
cd kafka-connect-mq-source
23+
```
1924

20-
Unpack the ZIP file and copy the JAR file `allclient-9.0.0.1.jar` into the top level directory into which you cloned the repository earlier.
25+
Copy the JAR file `allclient-9.0.0.1.jar` that you unpacked from the ZIP file earlier into the `kafka-connect-mq-source` directory.
2126

22-
So this JAR file can be used as a dependency in building the connector, run the following command to create a local Maven repository containing just this file:
27+
Run the following command to create a local Maven repository containing just this file so that it can be used to build the connector:
2328
```shell
2429
mvn deploy:deploy-file -Durl=file://local-maven-repo -Dfile=allclient-9.0.0.1.jar -DgroupId=com.ibm.mq -DartifactId=allclient -Dpackaging=jar -Dversion=9.0.0.1
2530
```
@@ -28,6 +33,7 @@ Build the connector using Maven:
2833
```shell
2934
mvn clean package
3035
```
36+
3137
Once built, the output is a single JAR called `target/kafka-connect-mq-source-0.1-SNAPSHOT-jar-with-dependencies.jar` which contains all of the required dependencies.
3238

3339

@@ -61,13 +67,19 @@ When the MQ source connector reads a message from MQ, it chooses a schema to rep
6167
There's no single configuration that will always be right, but here are some high-level suggestions.
6268

6369
* Pass unchanged binary data as the Kafka message value
64-
> `value.converter=org.apache.kafka.connect.converters.ByteArrayConverter`
70+
```
71+
value.converter=org.apache.kafka.connect.converters.ByteArrayConverter
72+
```
6573
* Messages are JMS BytesMessage, pass byte array as the Kafka message value
66-
> `mq.message.body.jms=true`
67-
> `value.converter=org.apache.kafka.connect.converters.ByteArrayConverter`
74+
```
75+
mq.message.body.jms=true
76+
value.converter=org.apache.kafka.connect.converters.ByteArrayConverter
77+
```
6878
* Messages are JMS TextMessage, pass string as the Kafka message value
69-
> `mq.message.body.jms=true`
70-
> `value.converter=org.apache.kafka.connect.storage.StringConverter`
79+
```
80+
mq.message.body.jms=true
81+
value.converter=org.apache.kafka.connect.storage.StringConverter
82+
```
7183

7284
### The gory detail
7385
The MQ source connector has a configuration option *mq.message.body.jms* that controls whether it interprets the MQ messages as JMS messages or regular MQ messages. By default, *mq.message.body.jms=false* which gives the following behaviour.

0 commit comments

Comments
 (0)