ibm.ibmmq
Module ibm.ibmmq
API
Declarations
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_ibm.ibmmq_1.0.0.png)
ballerinax/ibm.ibmmq Ballerina library
Overview
IBM MQ is a powerful messaging middleware platform designed for facilitating reliable communication between disparate systems and applications. IBM MQ ensures the secure and orderly exchange of messages 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. The current connector is compatible with IBM MQ server versions up to 9.3.
Setup guide
To use the Ballerina IBM MQ connector, you need to have an IBM MQ instance running or possess an IBM MQ cloud account. For setting up IBM MQ locally, you can refer to the IBM MQ official documentation. Alternatively, to use IBM MQ on the cloud, sign up for an IBM MQ cloud account.
Create a queue
-
Log into IBM MQ console. If you are running an IBM MQ server locally you can navigate to
https://<host>:<port>/ibmmq/console
URL in your browser to access the IBM MQ console. -
Click on the
Create a queue
link. -
Select the queue type.
Create a topic
-
Go back to the home page and click on the
Manage
link on the sidebar. -
Navigate to
Events
tab. -
Click on
Create
.
Quickstart
To use the IBM MQ connector in your Ballerina application, modify the .bal
file as follows:
Step 1: Import the connector
Import ballerinax/ibm.ibmmq
module into your Ballerina project.
import ballerinax/ibm.ibmmq;
Step 2: Instantiate a new connector
Create an ibmmq:QueueManager
instance by giving IBM MQ configuration.
configurable string queueManagerName = ?; configurable string host = ?; configurable int port = ?; configurable string channel = ?; configurable string userID = ?; configurable string password = ?; ibmmq:QueueManager queueManager = check new ( name = queueManagerName, host = host, channel = channel, userID = userID, password = password );
Create an ibmmq:Queue
or ibmmq:Topic
using the ibmmq:QueueManager
instance with relevant configurations.
configurable string queueName = ?; ibmmq:Queue queue = check queueManager.accessQueue(queueName, ibmmq:MQOO_OUTPUT | ibmmq:MQOO_INPUT_AS_Q_DEF);
Create an ibmmq:Topic
using the ibmmq:QueueManager
instance with relevant configurations.
configurable string topicName = ?; configurable string topicString = ?; ibmmq:Topic topic = check queueManager.accessTopic( topicName, topicString, ibmmq:MQOO_OUTPUT | ibmmq:MQOO_INPUT_AS_Q_DEF );
Step 3: Invoke the connector operations
Now, utilize the available connector operations.
Produce messages to an IBM MQ queue
check queue->put({ payload: "This is a sample message to IBM MQ queue".toBytes() });
Produce messages to an IBM MQ topic
check topic->put({ payload: "This is a sample message to IBM MQ topic".toBytes() });
Retrieve messages from an IBM MQ queue
ibmmq:Message? message = check queue->get();
Retrieve messages from an IBM MQ topic
ibmmq:Message? message = check topic->get();
Step 4: Run the Ballerina application
bal run
Examples
The following example shows how to use the ibm.ibmmq
connector to produce and consume messages using an IBM MQ server.
-
Produce messages - Produce messages to an IBM MQ queue.
-
Consume messages - Consume messages from an IBM MQ queue.
-
Securing IBM MQ client - Initiate secure communication between an IBM MQ client and an IBM MQ server.
-
Produce MQIIH headers - Produce IBM MQ messages to an IBM MQ queue with the MQIIH headers.
-
Consume MQIIH headers - Consume messages with the MQIIH header from an IBM MQ queue.
-
Produce MQRFH2 headers - Produce IBM MQ messages to an IBM MQ queue with the MQRFH2 headers.
-
Consume MQRFH2 headers - Consume messages with the MQRFH2 header from an IBM MQ queue.
Classes![](/images/permalink.svg)
ibm.ibmmq: QueueManager![](/images/permalink.svg)
Represents an IBM MQ queue manager.
Constructor![](/images/permalink.svg)
Initialize an IBM MQ queue manager.
ibmmq:QueueManager queueManager = check new(name = "QM1", host = "localhost", channel = "DEV.APP.SVRCONN");
init (*QueueManagerConfiguration configurations)
- configurations *QueueManagerConfiguration - The configurations to be used when initializing the IBM MQ queue manager
accessQueue![](/images/permalink.svg)
Establishes access to an IBM MQ queue on this queue manager.
ibmmq:Queue queue = check queueManager.accessQueue("queue1", ibmmq:MQOO_OUTPUT);
Parameters
- queueName string - Name of the queue
- options int - The options which control the opening of the queue
accessTopic![](/images/permalink.svg)
function accessTopic(string topicName, string topicString, OPEN_TOPIC_OPTION openTopicOption, int options) returns Topic|Error
Establishes access to an IBM MQ topic on this queue manager.
ibmmq:Topic topic = check queueManager.accessTopic( "dev", "DEV.BASE.TOPIC", ibmmq:OPEN_AS_PUBLICATION, ibmmq:MQOO_OUTPUT );
Parameters
- topicName string - The topic string to publish or subscribe against
- topicString string - The name of the topic object as defined on the local queue manager
- openTopicOption OPEN_TOPIC_OPTION - Indicates whether the topic is being opened for either publication or subscription
- options int - Options that control the opening of the topic for either publication or subscription
disconnect![](/images/permalink.svg)
function disconnect() returns Error?
Ends the connection to the IBM MQ queue manager.
Return Type
- Error? - An
ibmmq:Error
if the operation fails or else()
Clients![](/images/permalink.svg)
ibm.ibmmq: Queue![](/images/permalink.svg)
IBM MQ Queue client.
put![](/images/permalink.svg)
Puts a message to an IBM MQ queue.
check queue->put({payload: "Hello World".toBytes()});
Parameters
- message Message - IBM MQ message
Return Type
- Error? - An
ibmmq:Error
if the operation fails or else()
get![](/images/permalink.svg)
function get(*GetMessageOptions getMessageOptions) returns Message|Error?
Retrieves a message from an IBM MQ queue.
ibmmq:Message? message = check queue->get();
Parameters
- getMessageOptions *GetMessageOptions - Options to control message retrieval
Return Type
close![](/images/permalink.svg)
function close() returns Error?
Closes the IBM MQ queue object. No further operations on this object are permitted after it is closed.
check queue->close();
Return Type
- Error? - An
ibmmq:Error
if the operation fails or else()
ibm.ibmmq: Topic![](/images/permalink.svg)
IBM MQ Topic client.
put![](/images/permalink.svg)
Puts a message to an IBM MQ topic.
check topic->put({payload: "Hello World".toBytes()});
Parameters
- message Message - IBM MQ message
Return Type
- Error? - An
ibmmq:Error
if the operation fails or else()
get![](/images/permalink.svg)
function get(*GetMessageOptions getMessageOptions) returns Message|Error?
Retrieves a message from an IBM MQ topic.
ibmmq:Message? message = check topic->get();
Parameters
- getMessageOptions *GetMessageOptions - Options to control message retrieval
Return Type
close![](/images/permalink.svg)
function close() returns Error?
Closes the IBM MQ topic object. No further operations on this object are permitted after it is closed.
check topic->close();
Return Type
- Error? - An
ibmmq:Error
if the operation fails or else()
Constants![](/images/permalink.svg)
ibm.ibmmq: ANY![](/images/permalink.svg)
Any supported SSL/TLS cipher suite.
ibm.ibmmq: MQGMO_ACCEPT_TRUNCATED_MSG![](/images/permalink.svg)
If the message buffer is too small to hold the complete message, allow the MQGET call to fill the buffer with as much of the message as the buffer can hold.
ibm.ibmmq: MQGMO_BROWSE_FIRST![](/images/permalink.svg)
When a queue is opened with the MQOO_BROWSE option, a browse cursor is established, positioned logically before the first message on the queue.
ibm.ibmmq: MQGMO_BROWSE_MSG_UNDER_CURSOR![](/images/permalink.svg)
Retrieve the message pointed to by the browse cursor nondestructively, regardless of the MQMO_* options specified in the MatchOptions field in MQGMO.
ibm.ibmmq: MQGMO_BROWSE_NEXT![](/images/permalink.svg)
Advance the browse cursor to the next message on the queue that satisfies the selection criteria specified on the MQGET call.
ibm.ibmmq: MQGMO_CONVERT![](/images/permalink.svg)
Requests the application data to be converted.
ibm.ibmmq: MQGMO_FAIL_IF_QUIESCING![](/images/permalink.svg)
Force the MQGET call to fail if the queue manager is in the quiescing state.
ibm.ibmmq: MQGMO_LOCK![](/images/permalink.svg)
Lock the message that is browsed, so that the message becomes invisible to any other handle open for the queue.
ibm.ibmmq: MQGMO_MSG_UNDER_CURSOR![](/images/permalink.svg)
Retrieve the message pointed to by the browse cursor, regardless of the MQMO_* options specified in the MatchOptions field in MQGMO.
ibm.ibmmq: MQGMO_NO_SYNCPOINT![](/images/permalink.svg)
The request is to operate outside the normal unit-of-work protocols.
ibm.ibmmq: MQGMO_NO_WAIT![](/images/permalink.svg)
The application does not wait if no suitable message is available.
ibm.ibmmq: MQGMO_SYNCPOINT![](/images/permalink.svg)
The request is to operate within the normal unit-of-work protocols.
ibm.ibmmq: MQGMO_UNLOCK![](/images/permalink.svg)
Unlock a message. The message to be unlocked must have been previously locked by an MQGET call with the MQGMO_LOCK option.
ibm.ibmmq: MQGMO_WAIT![](/images/permalink.svg)
The application waits until a suitable message arrives.
ibm.ibmmq: MQOO_ALTERNATE_USER_AUTHORITY![](/images/permalink.svg)
Enables the AlternateUserId field in the ObjDesc parameter contains a user identifier to use to validate this MQOPEN call.
ibm.ibmmq: MQOO_BIND_AS_Q_DEF![](/images/permalink.svg)
The local queue manager binds the queue handle in the way defined by the DefBind queue attribute.
ibm.ibmmq: MQOO_BROWSE![](/images/permalink.svg)
Open the queue to browse messages.
ibm.ibmmq: MQOO_FAIL_IF_QUIESCING![](/images/permalink.svg)
The MQOPEN call fails if the queue manager is in quiescing state. This option is valid for all types of object.
ibm.ibmmq: MQOO_INPUT_AS_Q_DEF![](/images/permalink.svg)
Open the queue to get messages using the queue-defined default.
ibm.ibmmq: MQOO_INPUT_EXCLUSIVE![](/images/permalink.svg)
Open the queue to get messages with exclusive access.
ibm.ibmmq: MQOO_INPUT_SHARED![](/images/permalink.svg)
Open the queue to get messages with shared access.
ibm.ibmmq: MQOO_OUTPUT![](/images/permalink.svg)
Open the queue to put messages.
ibm.ibmmq: MQOO_PASS_ALL_CONTEXT![](/images/permalink.svg)
This allows the MQPMO_PASS_ALL_CONTEXT option to be specified in the PutMsgOpts parameter when a message is put on a queue.
ibm.ibmmq: MQOO_PASS_IDENTITY_CONTEXT![](/images/permalink.svg)
This allows the MQPMO_PASS_IDENTITY_CONTEXT option to be specified in the PutMsgOpts parameter when a message is put on a queue.
ibm.ibmmq: MQOO_SET_ALL_CONTEXT![](/images/permalink.svg)
This allows the MQPMO_SET_ALL_CONTEXT option to be specified in the PutMsgOpts parameter when a message is put on a queue.
ibm.ibmmq: MQOO_SET_IDENTITY_CONTEXT![](/images/permalink.svg)
This allows the MQPMO_SET_IDENTITY_CONTEXT option to be specified in the PutMsgOpts parameter when a message is put on a queue.
ibm.ibmmq: MQSO_CREATE![](/images/permalink.svg)
Subscribe Option create
ibm.ibmmq: OPEN_AS_PUBLICATION![](/images/permalink.svg)
Open topic as a publication.
ibm.ibmmq: OPEN_AS_SUBSCRIPTION![](/images/permalink.svg)
Open topic as a subscription.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with 3DES encryption and SHA integrity.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with AES 128-bit encryption and SHA-256 integrity.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with AES 128-bit GCM encryption and SHA-256 integrity.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with AES 256-bit CBC encryption and SHA-384 integrity.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with AES 256-bit GCM encryption and SHA-384 integrity.
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_NULL_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with NULL encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: SSL_ECDHE_ECDSA_WITH_RC4_128_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-ECDSA for key exchange with RC4 128-bit encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: SSL_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with 3DES encryption and SHA integrity.
ibm.ibmmq: SSL_ECDHE_RSA_WITH_AES_128_CBC_SHA256![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with AES 128-bit encryption and SHA-256 integrity.
ibm.ibmmq: SSL_ECDHE_RSA_WITH_AES_128_GCM_SHA256![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with AES 128-bit GCM encryption and SHA-256 integrity.
ibm.ibmmq: SSL_ECDHE_RSA_WITH_AES_256_CBC_SHA384![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with AES 256-bit CBC encryption and SHA-384 integrity.
ibm.ibmmq: SSL_ECDHE_RSA_WITH_AES_256_GCM_SHA384![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with AES 256-bit GCM encryption and SHA-384 integrity.
ibm.ibmmq: SSL_ECDHE_RSA_WITH_NULL_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with NULL encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: SSL_ECDHE_RSA_WITH_RC4_128_SHA![](/images/permalink.svg)
SSL cipher suite using ECDHE-RSA for key exchange with RC4 128-bit encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: SSL_RSA_WITH_3DES_EDE_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with 3DES encryption and SHA integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_128_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 128-bit encryption and SHA integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_128_CBC_SHA256![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 128-bit encryption, SHA-256 integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_128_GCM_SHA256![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 128-bit GCM encryption, SHA-256 integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_256_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 256-bit CBC encryption and SHA integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_256_CBC_SHA256![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 256-bit CBC encryption, SHA-256 integrity.
ibm.ibmmq: SSL_RSA_WITH_AES_256_GCM_SHA384![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with AES 256-bit GCM encryption, SHA-384 integrity.
ibm.ibmmq: SSL_RSA_WITH_DES_CBC_SHA![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with DES encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: SSL_RSA_WITH_NULL_SHA256![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with NULL encryption and SHA-256 integrity (not recommended for production use).
ibm.ibmmq: SSL_RSA_WITH_RC4_128_SHA![](/images/permalink.svg)
SSL cipher suite using RSA for key exchange with RC4 128-bit encryption and SHA integrity (not recommended for production use).
ibm.ibmmq: TLS12![](/images/permalink.svg)
TLS 1.2 protocol version.
ibm.ibmmq: TLS12ORHIGHER![](/images/permalink.svg)
TLS 1.2 or higher protocol version.
ibm.ibmmq: TLS13![](/images/permalink.svg)
TLS 1.3 protocol version.
ibm.ibmmq: TLS13ORHIGHER![](/images/permalink.svg)
TLS 1.3 or higher protocol version.
ibm.ibmmq: TLS_AES_128_CCM_8_SHA256![](/images/permalink.svg)
SSL cipher suite using AES 128-bit CCM 8 encryption, SHA-256 integrity.
ibm.ibmmq: TLS_AES_128_CCM_SHA256![](/images/permalink.svg)
SSL cipher suite using AES 128-bit CCM encryption, SHA-256 integrity.
ibm.ibmmq: TLS_AES_128_GCM_SHA256![](/images/permalink.svg)
SSL cipher suite using AES 128-bit GCM encryption, SHA-256 integrity.
ibm.ibmmq: TLS_AES_256_GCM_SHA384![](/images/permalink.svg)
SSL cipher suite using AES 256-bit GCM encryption, SHA-384 integrity.
ibm.ibmmq: TLS_CHACHA20_POLY1305_SHA256![](/images/permalink.svg)
SSL cipher suite using ChaCha20-Poly1305 encryption, SHA-256 integrity.
Records![](/images/permalink.svg)
ibm.ibmmq: CertKey![](/images/permalink.svg)
Represents a combination of certificate, private key, and private key password if encrypted.
Fields
- certFile string - A file containing the certificate
- keyFile string - A file containing the private key in PKCS8 format
- keyPassword string? - Password of the private key if it is encrypted
ibm.ibmmq: ErrorDetails![](/images/permalink.svg)
The error details type for the IBM MQ module.
Fields
- reasonCode int? - The reason code for the error
- errorCode string? - The error code for the error
- completionCode int? - The completion code for the error
ibm.ibmmq: GetMessageOptions![](/images/permalink.svg)
IBM MQ get message options.
Fields
- options int(default MQGMO_NO_WAIT) - Get message option
- waitInterval int(default 10) - The maximum time (in seconds) that a
get
call waits for a suitable message to arrive. It is used in conjunction withibmmq.MQGMO_WAIT
.
ibm.ibmmq: Message![](/images/permalink.svg)
Represents an IBM MQ message.
Fields
- format string? - Format associated with the header
- messageId byte[]? - Message identifier
- correlationId byte[]? - Correlation identifier
- expiry int? - Message lifetime
- priority int? - Message priority
- persistence int? - Message persistence
- messageType int? - Message type
- putApplicationType int? - Type of application that put the message
- replyToQueueName string? - Name of reply queue
- replyToQueueManagerName string? - Name of reply queue manager
- headers Header[]? - Headers to be sent in the message
- payload byte[] - Message payload
ibm.ibmmq: MQCIH![](/images/permalink.svg)
Header record representing the MQCIH structure.
Fields
- flags int(default 0) - Flag of the header
- encoding int(default 0) - Numeric encoding of data that follows NameValueData
- codedCharSetId int(default 0) - Character set identifier of data that follows NameValueString
- format string(default DEFAULT_BLANK_VALUE) - MQ format name of data that follows MQCIH
- strucId string(default "CIH ") - Structure identifier
- strucLength int(default 180) - Length of the structure
- version int(default 2) - Structure version number
- returnCode int(default 0) - Return code from bridge
- compCode int(default 0) - MQ completion code or CICS EIBRESP
- reason int(default 0) - MQ reason or feedback code, or CICS EIBRESP2
- UOWControl int(default 273) - Unit-of-work control
- waitInterval int(default -2) - Wait interval for MQGET call issued by bridge task
- linkType int(default 1) - Link type
- facilityKeepTime int(default 0) - Bridge facility release time
- ADSDescriptor int(default 0) - Send/receive ADS descriptor
- conversationalTask int(default 0) - Whether task can be conversational
- taskEndStatus int(default 0) - Status at end of task
- facility byte[](default []) - Bridge facility token
- 'function string(default "") - MQ call name or CICS EIBFN function
- abendCode string(default "") - Abend code
- authenticator string(default "") - Password or passticket
- replyToFormat string(default "") - MQ format name of reply message
- remoteSysId string(default "") - Remote CICS system Id to use
- remoteTransId string(default "") - CICS RTRANSID to use
- transactionId string(default "") - Transaction to attach
- facilityLike string(default "") - Terminal emulated attributes
- attentionId string(default "") - AID key
- startCode string(default "") - Transaction start code
- cancelCode string(default "") - Abend transaction code
- nextTransactionId string(default "") - Next transaction to attach
- inputItem int(default 0) - Reserved
ibm.ibmmq: MQIIH![](/images/permalink.svg)
Header record representing the MQIIH structure.
Fields
- flags int(default 0) - Flag of the header
- encoding int(default 0) - Numeric encoding of data that follows NameValueString
- strucId string(default "IIH ") - Structure identifier
- strucLength int(default 84) - Length of the structure
- version int(default 1) - Structure version number
- codedCharSetId int(default 0) - Character set identifier of data that follows NameValueString
- format string(default DEFAULT_BLANK_VALUE) - Format name of data that follows NameValueString
- lTermOverride string(default DEFAULT_BLANK_VALUE) - The logical terminal override, placed in the IO PCB field
- mfsMapName string(default DEFAULT_BLANK_VALUE) - The message format services map name, placed in the IO PCB field
- replyToFormat string(default DEFAULT_BLANK_VALUE) - This is the MQ format name of the reply message that is sent in response to the current message
- authenticator string(default DEFAULT_BLANK_VALUE) - RACF password or passticket
- tranInstanceId byte[](default [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0]) - This is the transaction instance identifier
- tranState Char(default " ") - This indicates the IMS conversation state
- commitMode Char(default "0") - IMS commit mode
- securityScope Char(default "C") - This indicates the IMS security processing required
ibm.ibmmq: MQRFH![](/images/permalink.svg)
Header record representing the MQRFH structure.
Fields
- flags int(default 0) - Flag of the header
- encoding int(default 0) - Numeric encoding of data that follows NameValueString
- strucId string(default "RFH ") - Structure identifier
- strucLength int(default 32) - Length of the structure
- version int(default 1) - Structure version number
- codedCharSetId int(default 0) - Character set identifier of data that follows NameValueString
- format string(default DEFAULT_BLANK_VALUE) - Format name of data that follows NameValueString
ibm.ibmmq: MQRFH2![](/images/permalink.svg)
Header record representing the MQRFH2 structure.
Fields
- flags int(default 0) - Flag of the header
- encoding int(default 273) - Numeric encoding of data that follows NameValueData
- codedCharSetId int(default -2) - Character set identifier of data that follows NameValueData
- folderStrings string[](default []) - Contents of the variable part of the structure
- nameValueCCSID int(default 1208) - Coded character set for the NameValue data
- nameValueData byte[](default []) - NameValueData variable-length field
- nameValueLength int(default 0) - Length of NameValueData
- format string(default DEFAULT_BLANK_VALUE) - Format name of data that follows NameValueData.The name should be padded with
blanks to the length of the field.
- strucId string(default "RFH ") - Structure identifier
- strucLength int(default 36) - Length of the structure
- version int(default 2) - Structure version number
- fieldValues table<MQRFH2Field>(default table []) - Table containing all occurrences of field values matching
the specified field name in the folder
ibm.ibmmq: MQRFH2Field![](/images/permalink.svg)
Record defining a field in the MQRFH2 record.
Fields
- folder readonly string - The name of the folder containing the field
- 'field readonly string - The field name
ibm.ibmmq: Property![](/images/permalink.svg)
Represents an IBM MQ message property.
Fields
ibm.ibmmq: QueueManagerConfiguration![](/images/permalink.svg)
IBM MQ queue manager configurations.
Fields
- name string - Name of the queue manager
- host string - IBM MQ server host
- port int(default 1414) - IBM MQ server port
- channel string - IBM MQ channel
- userID string? - IBM MQ userId
- password string? - IBM MQ user password
- secureSocket SecureSocket? - Configurations related to SSL/TLS encryption
- sslCipherSuite SslCipherSuite? - Defines the combination of key exchange, encryption, and integrity algorithms used for establishing a secure SSL/TLS connection
ibm.ibmmq: SecureSocket![](/images/permalink.svg)
Configurations for secure communication with the IBM MQ server.
Fields
- cert TrustStore|string - Configurations associated with
crypto:TrustStore
or single certificate file that the client trusts
- provider string? - Name of the security provider used for SSL connections. The default value is the default security provider of the JVM
Errors![](/images/permalink.svg)
ibm.ibmmq: Error![](/images/permalink.svg)
Represents a IBM MQ distinct error.
Object types![](/images/permalink.svg)
ibm.ibmmq: Destination![](/images/permalink.svg)
IBM MQ destination client type.
put![](/images/permalink.svg)
Parameters
- message Message -
get![](/images/permalink.svg)
function get(*GetMessageOptions getMessageOptions) returns Message|Error?
Parameters
- getMessageOptions *GetMessageOptions -
close![](/images/permalink.svg)
function close() returns Error?
Union types![](/images/permalink.svg)
ibm.ibmmq: OPEN_TOPIC_OPTION![](/images/permalink.svg)
OPEN_TOPIC_OPTION
Options which can be provided when opening an IBM MQ topic.
ibm.ibmmq: Header![](/images/permalink.svg)
Header
Header types that are provided in the IBM MQ message.
ibm.ibmmq: SslCipherSuite![](/images/permalink.svg)
SslCipherSuite
The SSL Cipher Suite to be used for secure communication with the IBM MQ server.
Import
import ballerinax/ibm.ibmmq;
Metadata
Released date: 3 months ago
Version: 1.0.0
License: Apache-2.0
Compatibility
Platform: java17
Ballerina version: 2201.8.0
Pull count
Total: 0
Current verison: 0
Weekly downloads
Keywords
ibm.ibmmq
client
messaging
network
pubsub
Contributors
Other versions
1.0.0
Dependencies