diff --git a/README.md b/README.md index cb0818b..7c2f51b 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both point-to-point and publish/subscribe messaging models via queues and topics. -The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. - -## Compatibility - -| | Version | -|:-----------------------|:------------:| -| IBM MQ Server | **9.3 or earlier** | -| IBM MQ Client Connector| **9.3.4.0** | +The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3. ## Setup guide @@ -27,31 +20,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis ### Create a queue -1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to - [https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console. +1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://:/ibmmq/console` URL in your browser to access the IBM MQ console. + 2. Click on the `Create a queue` link. -![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png) + Create a queue 3. Select the queue type. -![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png) + Select the queue type + +### Create a topic -4. Go back to the home page and click on the `Manage` link on the sidebar. +1. Go back to the home page and click on the `Manage` link on the sidebar. -![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png) + Click on manage -5. Navigate to `Events` tab. +2. Navigate to `Events` tab. -![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png) + Navigate to events tab -6. Click on `Create`. +3. Click on `Create`. -![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png) + Click on create ## Quickstart -To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows: +To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows: ### Step 1: Import the connector diff --git a/ballerina/Ballerina.toml b/ballerina/Ballerina.toml index 2177a8a..a788df7 100644 --- a/ballerina/Ballerina.toml +++ b/ballerina/Ballerina.toml @@ -1,9 +1,9 @@ [package] org = "ballerinax" name = "ibm.ibmmq" -version = "0.1.4" +version = "1.0.0" authors = ["Ballerina"] -keywords = ["ibm-mq"] +keywords = ["ibm.ibmmq", "client", "messaging", "network", "pubsub"] repository = "https://github.com/ballerina-platform/module-ballerinax-ibm.ibmmq" icon = "icon.png" license = ["Apache-2.0"] @@ -12,8 +12,8 @@ distribution = "2201.8.0" [[platform.java17.dependency]] groupId = "io.ballerina.stdlib" artifactId = "ibm.ibmmq-native" -version = "0.1.4" -path = "../native/build/libs/ibm.ibmmq-native-0.1.4-SNAPSHOT.jar" +version = "1.0.0" +path = "../native/build/libs/ibm.ibmmq-native-1.0.0-SNAPSHOT.jar" [[platform.java17.dependency]] groupId = "org.json" diff --git a/ballerina/Dependencies.toml b/ballerina/Dependencies.toml index ce515cf..62f918f 100644 --- a/ballerina/Dependencies.toml +++ b/ballerina/Dependencies.toml @@ -63,7 +63,7 @@ modules = [ [[package]] org = "ballerinax" name = "ibm.ibmmq" -version = "0.1.4" +version = "1.0.0" dependencies = [ {org = "ballerina", name = "crypto"}, {org = "ballerina", name = "jballerina.java"}, diff --git a/ballerina/Module.md b/ballerina/Module.md index ee3eeaa..f46bfd3 100644 --- a/ballerina/Module.md +++ b/ballerina/Module.md @@ -5,14 +5,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both point-to-point and publish/subscribe messaging models via queues and topics. -The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. - -## Compatibility - -| | Version | -|:-----------------------|:------------:| -| IBM MQ Server | **9.3 or earlier** | -| IBM MQ Client Connector| **9.3.4.0** | +The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3. ## Setup guide @@ -22,31 +15,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis ### Create a queue -1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to -[https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console. +1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://:/ibmmq/console` URL in your browser to access the IBM MQ console. + 2. Click on the `Create a queue` link. -![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png) + Create a queue 3. Select the queue type. -![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png) + Select the queue type + +### Create a topic -4. Go back to the home page and click on the `Manage` link on the sidebar. +1. Go back to the home page and click on the `Manage` link on the sidebar. -![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png) + Click on manage -5. Navigate to `Events` tab. +2. Navigate to `Events` tab. -![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png) + Navigate to events tab -6. Click on `Create`. +3. Click on `Create`. -![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png) + Click on create ## Quickstart -To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows: +To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows: ### Step 1: Import the connector diff --git a/ballerina/Package.md b/ballerina/Package.md index 3f4bdef..a5f0c9f 100644 --- a/ballerina/Package.md +++ b/ballerina/Package.md @@ -5,14 +5,7 @@ communication between disparate systems and applications. IBM MQ ensures the sec asynchronously, decoupling senders and receivers for efficient and scalable communication. It supports both point-to-point and publish/subscribe messaging models via queues and topics. -The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. - -## Compatibility - -| | Version | -|:-----------------------|:------------:| -| IBM MQ Server | **9.3 or earlier** | -| IBM MQ Client Connector| **9.3.4.0** | +The `ballerinax/ibm.ibmmq` package provides an API to connect to an IBM MQ server using Ballerina. The current connector is compatible with IBM MQ server versions up to 9.3. ## Setup guide @@ -22,31 +15,33 @@ Alternatively, to use IBM MQ on the cloud, [sign up](https://cloud.ibm.com/regis ### Create a queue -1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to - [https://localhost:9443/ibmmq/console](https://localhost:9443/ibmmq/console) URL in your browser to access the IBM MQ console. +1. Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to `https://:/ibmmq/console` URL in your browser to access the IBM MQ console. + 2. Click on the `Create a queue` link. -![Create a queue](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-create-queue.png) + Create a queue 3. Select the queue type. -![Select the queue type](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/select-queue-type.png) + Select the queue type + +### Create a topic -4. Go back to the home page and click on the `Manage` link on the sidebar. +1. Go back to the home page and click on the `Manage` link on the sidebar. -![Click on Manage](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-manage-link.png) + Click on manage -5. Navigate to `Events` tab. +2. Navigate to `Events` tab. -![Navigate to Events tab](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/navigate-to-events-tab.png) + Navigate to events tab -6. Click on `Create`. +3. Click on `Create`. -![Click on create](https://raw.githubusercontent.com/ballerina-platform/module-ballerinax-ibm.ibmmq/main/docs/setup/resources/click-on-create.png) + Click on create ## Quickstart -To use the IBM MQ connector in your Ballerina application, modify the .bal file as follows: +To use the IBM MQ connector in your Ballerina application, modify the `.bal` file as follows: ### Step 1: Import the connector diff --git a/build-config/resources/Ballerina.toml b/build-config/resources/Ballerina.toml index 769c8d8..e7e47e7 100644 --- a/build-config/resources/Ballerina.toml +++ b/build-config/resources/Ballerina.toml @@ -3,7 +3,7 @@ org = "ballerinax" name = "ibm.ibmmq" version = "@toml.version@" authors = ["Ballerina"] -keywords = ["ibm-mq"] +keywords = ["ibm.ibmmq", "client", "messaging", "network", "pubsub"] repository = "https://github.com/ballerina-platform/module-ballerinax-ibm.ibmmq" icon = "icon.png" license = ["Apache-2.0"] diff --git a/examples/consume-messages/Consume Messages.md b/examples/consume-messages/Consume Messages.md index 2cf0c7b..ba406d2 100644 --- a/examples/consume-messages/Consume Messages.md +++ b/examples/consume-messages/Consume Messages.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/consume-mqiih-headers/Consume MQIIH Headers.md b/examples/consume-mqiih-headers/Consume MQIIH Headers.md index 2b8043e..32124a3 100644 --- a/examples/consume-mqiih-headers/Consume MQIIH Headers.md +++ b/examples/consume-mqiih-headers/Consume MQIIH Headers.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/consume-mqrfh2-headers/Consume MQRFH2 Headers.md b/examples/consume-mqrfh2-headers/Consume MQRFH2 Headers.md index aa508fa..936f58a 100644 --- a/examples/consume-mqrfh2-headers/Consume MQRFH2 Headers.md +++ b/examples/consume-mqrfh2-headers/Consume MQRFH2 Headers.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/ibmmq-client-security/Securing IBM MQ Client.md b/examples/ibmmq-client-security/Securing IBM MQ Client.md index 37bd033..9aa2583 100644 --- a/examples/ibmmq-client-security/Securing IBM MQ Client.md +++ b/examples/ibmmq-client-security/Securing IBM MQ Client.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/produce-messages/Produce Messages.md b/examples/produce-messages/Produce Messages.md index 90ded7f..61731c4 100644 --- a/examples/produce-messages/Produce Messages.md +++ b/examples/produce-messages/Produce Messages.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/produce-mqiih-headers/Produce MQIIH Headers.md b/examples/produce-mqiih-headers/Produce MQIIH Headers.md index 2331c6a..cbb7093 100644 --- a/examples/produce-mqiih-headers/Produce MQIIH Headers.md +++ b/examples/produce-mqiih-headers/Produce MQIIH Headers.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/examples/produce-mqrfh2-headers/Produce MQRFH2 Headers.md b/examples/produce-mqrfh2-headers/Produce MQRFH2 Headers.md index a233992..9967a21 100644 --- a/examples/produce-mqrfh2-headers/Produce MQRFH2 Headers.md +++ b/examples/produce-mqrfh2-headers/Produce MQRFH2 Headers.md @@ -15,7 +15,7 @@ Update IBM MQ related configurations in `Config.toml` in the example directory: ```toml queueManagerName = "" host = "" -port = +port = "" channel = "" userID = "" password = "" diff --git a/gradle.properties b/gradle.properties index 5c0735c..10a485e 100644 --- a/gradle.properties +++ b/gradle.properties @@ -1,6 +1,6 @@ org.gradle.caching=true group=io.ballerina.lib -version=0.1.4-SNAPSHOT +version=1.0.0-SNAPSHOT ballerinaLangVersion=2201.8.0 checkstylePluginVersion=10.12.1