The XMS samples are based on the existing samples shipped with the IBM MQ Server and Client packages. These samples have been tested with .NET 8.0 and .NET 9.0 using Visual Studio Code v 1.99.2 on macOS Sequoia 15.4.1. They have also been tested with Visual Studio 2022 for Windows, v 17.13.6.
We have included the '.sln', '.csproj', 'packages.config' files in the repository. These were created using Visual Studio 2022, and they are fully compatible with Visual Studio Code as well. We've also added the copy of the 'env.json' file from the top level directory to the '/dotnet' project directory, the files will be copied to '/bin/Debug/net8.0' or '/bin/Debug/net9.0'and adjust the parameters to use your own queue manager.
IBM Message Service Client for .NET Standard (XMS .NET)
Reference it through Solution Explorer NuGet Package installer.
Note: If you're using Visual Studio Code, you can install the required packages through the terminal. Open the provided links and use the command listed under the .NET CLI tab.
We drive the running of all the samples through this one module that has the one main entry point in the project. Once you've built the project in Visual Studio, you can run the project .exe on the command line from the project directory bin/debug location or bin/release depending on how you built it.
For example:
./ibmmq_samples.exe put
Running on Mac? : If you're running the application on Mac, make sure to remove the .exe extension from the command when executing the application.
If you're using Visual Studio Code every time you build the application, make sure to run it using the dotnet run command. This ensures that the latest changes are compiled and reflected in the running application.
Run
./ibmmq_samples.exe put
In a separate terminal
./ibmmq_samples.exe get
In the first terminal;
You have to run the subscriber sample first so it creates a subscription and waits for a publication.
Run
./ibmmq_samples.exe sub
In the second terminal;
Run the publisher sample
./ibmmq_samples.exe pub
In the first terminal;
Run the request sample
Run
./ibmmq_samples.exe request
The request sample will put a message and wait for a response until it either gets a response or you ctrl+c interrupt it.
In the second terminal;
Run the response sample
Run
./ibmmq_samples.exe response
The response sample will get a message from the queue, process it and put the response on the reply to queue and keep looking for more messages to respond to till you ctrl+c interrupt it.
If your queue manager is on cloud you will need the public certificate of the queue manager. For IBM MQ on IBM Cloud, you can obtain this certificate by navigating to the Key store tab in your MQ service instance, then downloading the public certificate of the Queue Manager.
Add the certificate to your system's trusted store
- For Mac
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain <path-to-certificate-file>
This command adds the certificate at the system level.
- For Windows
certutil –addstore -enterprise –f "Root" <pathtocertificatefile>
This command adds the certificate to the Shared Store, making it accessible at both the user and system levels.
If your Queue Manager is running in a container, follow Secure communication between IBM MQ endpoints with TLS tutorial to learn how to generate and add the public and private parts of the certificates inside the container.
Note: There's no need to create a keystore on the client machine. Simply import the public certificate of the Queue Manager to the system's trusted store using the commands provided above.
If your Queue Manger is in a local machine follow Configuring mutual TLS authentication for a messaging application this tutorial.
This sample is using a .NET managed client, then the underlying .NET runtime will carry out the TLS handshake with the MQ Server. Any exceptions generated in the .NET layer during the TLS handshake will surface as server or queue not found - 2059.
Import the certificate at either the user or the system level. Then in your app, set the key repository to either *USER or *SYSTEM depending on how you imported it.
Set KEY_REPOSITORY in your JSON file to
"KEY_REPOSITORY": "*USER",
or
"KEY_REPOSITORY": "*SYSTEM",
To find out how to import certificates on Windows, see How to: View certificates with the MMC snap-in and Import and Export Certificate - Microsoft Windows.