Contact Free trial Login

IBM MQ Connector Reference

Support Category: Select

IBM MQ Connector v1.2

Provides the main class of this connector, which is the entry point where configurations, connection providers, operations, and sources are declared.

Configurations


Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide to this configuration.

x

Encoding

String

The default encoding of the message body if the message doesn’t communicate it.

Content Type

String

The default content type of the message body is the message doesn’t communicate it.

/

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Whether to specify a correlationId when publishing messages. This applies both for custom correlation IDs specified at the operation level and for default correlation IDs taken from the current event.

AUTO

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • AUTO

  • MANUAL

  • DUPS_OK

The Session ACK mode to use when consuming a message.

AUTO

Consumer Type

One of:

Selector

String

Default JMS selector to use for filtering incoming messages.

Persistent Delivery

Boolean

If true, the message is sent using the PERSISTENT JMSDeliveryMode.

false

Priority

Number

The default JMSPriority value to use when sending the message.

4

Time To Live

Number

Defines the default time the message is in the broker before it expires and is discarded.

0

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the timeToLive configurations.

MILLISECONDS

Disable Message Id

Boolean

If true, the Message is flagged to avoid generating its MessageID.

false

Disable Message Timestamp

Boolean

If true, the Message is flagged to avoid generating its sent Timestamp.

false

Delivery Delay

Number

Only used by JMS 2.0: Sets the delivery delay to be applied to postpone the Message delivery.

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Only used by JMS 2.0: Time unit to use in the deliveryDelay configurations.

MILLISECONDS

Jms Type

String

The message type identifier to be set in the JMSType Header when a message is sent.

Connection Types

Connection
Parameters
Name Type Description Default Value Required

Connection Mode

One of:

x

Username

String

Username to use to connect to the IBM MQ Server.

Password

String

Password of the used username.

Client ID

String

ID of the JMS Client used to identify the current client.

CSS ID

Number

Number to use when connecting to the queue manager. The default value (819) is suitable in most situations.

Additional Properties

Object

Additional properties to configure the IBM MQ client.

Caching Strategy

One of:

The strategy to use for caching of sessions and connections.

Enable XA Transactions

Boolean

false

Specification

Enumeration, one of:

  • JMS_2_0

  • JMS_1_1

Version of the JMS specification for the JMS Client.

JMS_2_0

Target Client

Enumeration, one of:

  • JMS_COMPLIANT

  • NO_JMS_COMPLIANT

Describes the way to create the IBM MQ JMS Client. When using JMS_COMPLIANT, indicates that the RFH2 format is used to send information. The RFH2 header carries JMS-specific data that is associated with the message content. When not using JMS_COMPLIANT, features like User Properties and Media Type propagation stop working.

JMS_COMPLIANT

Application Name

String

Application name to be registered in the connection factory. By default this is the application name. Max 27 characters are allowed.

Read Message Descriptor (MD)

Enumeration, one of:

  • ENABLED

  • DISABLED

Indicates if this is enabled to read the message descriptor properties.

ENABLED

Write Message Descriptor (MD)

Enumeration, one of:

  • ENABLED

  • DISABLED

Indicates if this is enabled to write the message descriptor properties.

ENABLED

Message Context

Enumeration, one of:

  • DEFAULT

  • SET_ALL_CONTEXT

  • SET_IDENTITY_CONTEXT

Indicates the message context to configure message options.

  • DEFAULT: No options can be set.

  • SET_ALL_CONTEXT: Only Identity options can be set.

  • SET_IDENTITY_CONTEXT: All options can be set.

DEFAULT

Temporary Model

String

The name of the IBM MQ model queue that refers to a model queue that can be used to create a permanent dynamic queue.

Temporal Queue Prefix

String

The prefix to use when creating temporary queue names. The last non-black character must be an asterisk (*).

Temporal Topic Prefix

String

The prefix to use when creating temporary topic names. The last non-black character must be an asterisk (*).

Receive Exit Handler

String

The receive exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.

Receive Exit Handler Init

String

Initialization string for the receive exit.

Send Exit Handler

String

The send exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.

Send Exit Handler Init

String

Initialization string for the send exit.

Security Exit Handler

String

The security exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.

Security Exit Handler Init

String

Initialization string for the security exit.

IBM MQ CipherSpec Mapping

Enumeration, one of:

  • ORACLE_CIPHER_SUITES

  • IBM_CIPHER_SUITES

  • NONE

Defines which Cipher Suite Mapping to use. Oracle JDK or IBM JDK. Configure depending on the Host JDK. More information.

ORACLE_CIPHER_SUITES

IBM Cipher Suite

String

Cipher Suite to use to connect to the IBM MQ Server.

Reset Count

Number

This property represents the total number of bytes sent and received by a connection before the secret key that is used for encryption is renegotiated. Integer value between 0 (disabled) and 999999999.

Peer Name

String

Specifies a distinguished name pattern, to ensure that your JMS application connects to the correct queue manager.

FIPS Required

Boolean

Enable it if is required a connection to use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).

false

Cert Stores

String

Specifies a list of LDAP servers to use for certificate revocation list (CRL) checking.

TLS Context

TLS

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Supported Operations

Operations

Consume

<ibm-mq:consume>

Allows a user to consume a single message from a given destination.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Destination

String

The name of the destination from where the message should be consumed.

x

Consumer Type

One of:

The type of the MessageConsumer that is required for the given destination, along with any extra configurations that are required based on the destination type.

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • MANUAL

The ConsumerAckMode to configure over the message and session.

Selector

String

A custom JMS selector for filtering the messages.

Maximum Wait

Number

Maximum time to wait for a message before timing out.

10000

Maximum Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the maximumWaitTime configurations.

MILLISECONDS

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

Content Type

String

Sets the ContentType of the received message. If the message already have one, this one is overridden.

Encoding

String

Sets the Encoding of the received message. If the message already have one, this one is overridden.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • IBM-MQ:ACK

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:CONSUMING

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

  • IBM-MQ:TIMEOUT

Publish

<ibm-mq:publish>

Allows a user to send a Message to a JMS destination.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Destination

String

The name of the Destination where the Message should be sent

x

Destination Type

Enumeration, one of:

  • QUEUE

  • TOPIC

The MQDestinationType of the destination.

QUEUE

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

Transactional Action for the operation. Indicates if the publish must be executed or not in a transaction.

JOIN_IF_POSSIBLE

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Options on whether to include an outbound correlation ID or not.

Body

Any

The body of the Message

#[payload]

JMS Type

String

The JMSType identifier header of the Message.

Correlation ID

String

The JMSCorrelationID header of the Message.

Send Content Type

Boolean

Whether or not the body content type should be sent as a property

true

Content Type

String

The content type of the message’s body.

Send Encoding

Boolean

Whether or not the body outboundEncoding should be sent as a Message property.

true

Encoding

String

The encoding of the message’s body.

Reply To

The destination where a reply to this Message should be sent

User Properties

Object

The custom user properties that should be set to this Message.

JMSX Properties

The JMSX properties that should be set to this Message.

Persistent Delivery

Boolean

If true, the Message is sent using the PERSISTENT JMSDeliveryMode.

Priority

Number

The default JMSPriority value to use when sending the message.

Time To Live

Number

Defines the default time the message is in the broker before it expires and is discarded.

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the timeToLive configurations

Disable Message Id

Boolean

If true, the Message is flagged to avoid generating its MessageID.

Disable Message Timestamp

Boolean

If true, the Message is flagged to avoid generating its sent Timestamp.

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery.

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the deliveryDelay configurations.

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:ILLEGAL_BODY

  • IBM-MQ:PUBLISHING

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

Publish Consume

<ibm-mq:publish-consume>

Allows a user to send a message to a JMS destination and wait for a response either to the provided ReplyTo destination or to a temporary destination created dynamically.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Destination

String

The name of the Destination where the Message should be sent

x

Send Correlation Id

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Options on whether to include an outbound correlation ID or not.

Body

Any

The body of the Message.

#[payload]

JMS Type

String

The JMSType identifier header of the Message.

Correlation ID

String

The JMSCorrelationID header of the Message.

Send Content Type

Boolean

Whether or not the body content type should be sent as a property.

true

Content Type

String

The content type of the message’s body.

Send Encoding

Boolean

Whether or not the body outboundEncoding should be sent as a Message property.

true

Encoding

String

The encoding of the message’s body

Reply To

The destination where a reply to this Message should be sent.

User Properties

Object

The custom user properties that should be set to this Message

JMSX Properties

The JMSX properties that should be set to this Message

Persistent Delivery

Boolean

If true, the Message is sent using the PERSISTENT JMSDeliveryMode.

Priority

Number

The default JMSPriority value to use when sending the message.

Time To Live

Number

Defines the default time the message is in the broker before it expires and is discarded

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the timeToLive configurations

Disable Message Id

Boolean

If true, the Message is flagged to avoid generating its MessageID.

Disable Message Timestamp

Boolean

If true, the Message is flagged to avoid generating its sent Timestamp

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the deliveryDelay configurations

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • MANUAL

The Session ACK mode to use when consuming the message

Maximum Wait

Number

Maximum time to wait for a message to arrive before timeout

10000

Maximum Wait Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the maximumWaitTime configuration

MILLISECONDS

Content Type

String

The content type of the message body to be consumed.

Encoding

String

The encoding of the message body to be consumed.

Target Variable

String

The name of a variable to store the operation’s output.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

For Configurations

Throws

  • IBM-MQ:ACK

  • IBM-MQ:CONNECTIVITY

  • IBM-MQ:CONSUMING

  • IBM-MQ:DESTINATION_NOT_FOUND

  • IBM-MQ:ILLEGAL_BODY

  • IBM-MQ:PUBLISHING

  • IBM-MQ:RETRY_EXHAUSTED

  • IBM-MQ:SECURITY

  • IBM-MQ:TIMEOUT

Ack

<ibm-mq:ack>

Allows the user to perform an ACK when the AckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing an ACK over a single Message automatically works as an ACK for all the Messages produced in the same JmsSession.

Parameters

Name Type Description Default Value Required

Ack Id

String

The AckId of the Message to ACK.

x

Throws

  • IBM-MQ:ACK

Recover Session

<ibm-mq:recover-session>

Allows a user to perform a session recover when the AckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing a session recover automatically redelivers all the consumed messages that had not being acknowledged before this recover.

Parameters

Name Type Description Default Value Required

Ack Id

String

The AckId of the Message Session to recover.

x

Throws

  • IBM-MQ:SESSION_RECOVER

Sources

On New Message

<ibm-mq:listener>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Destination

String

The name of the Destination from where the Message should be consumed.

x

Consumer Type

One of:

The Type of the Consumer that should be used for the provided destination.

Ack Mode

Enumeration, one of:

  • IMMEDIATE

  • AUTO

  • MANUAL

  • DUPS_OK

The Session ACK mode to use when consuming a message.

Selector

String

JMS selector to use for filtering incoming messages.

Number Of Consumers

Number

The number of concurrent consumers to use to receive JMS Messages

4

Transactional Action

Enumeration, one of:

  • ALWAYS_BEGIN

  • NONE

The type of beginning action that sources can take regarding transactions.

NONE

Transaction Type

Enumeration, one of:

  • LOCAL

  • XA

The type of transaction to create. Availability depends on the runtime version.

LOCAL

Primary Node Only

Boolean

Whether this source should only be executed on the primary node when running in a cluster.

true

Redelivery Policy

Defines a policy for processing the redelivery of the same message.

Content Type

String

Sets the ContentType of the received message. If the message already have one, this one is overridden.

Encoding

String

Sets the Encoding of the received message. If the message already have one, this one is overridden.

Reconnection Strategy

A retry strategy in case of connectivity errors.

Body

Any

The body of the Message

#[payload]

JMS Type

String

The JMSType identifier header of the Message.

Correlation ID

String

The JMSCorrelationID header of the Message.

Send Content Type

Boolean

Whether or not the body content type should be sent as a property.

true

Content Type

String

The content type of the message’s body.

Send Encoding

Boolean

Whether or not the body outboundEncoding should be sent as a Message property.

true

Encoding

String

The encoding of the message’s body

Reply To

The destination where a reply to this Message should be sent

User Properties

Object

The custom user properties that should be set to this Message

JMSX Properties

The JMSX properties that should be set to this Message.

Persistent Delivery

Boolean

Whether or not the delivery should be done with a persistent configuration.

Priority

Number

The default JMSPriority value to use when sending the message.

Time To Live

Number

Defines the default time the message is in the broker before it expires and is discarded.

Time To Live Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the timeToLive configurations,

Disable Message Id

Boolean

If true, the Message is flagged to avoid generating its MessageID.

Disable Message Timestamp

Boolean

If true, the Message is flagged to avoid generating its sent Timestamp.

Delivery Delay

Number

Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery.

Delivery Delay Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit to use in the deliveryDelay configurations.

Send Correlation ID

Enumeration, one of:

  • AUTO

  • ALWAYS

  • NEVER

Options on whether to include an outbound correlation ID or not.

Output

Type

Any

Attributes Type

For Configurations

Types

TLS

Field Type Description Default Value Required

Enabled Protocols

String

A comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

A comma-separated list of cipher suites enabled for this context.

Trust Store

Key Store

Revocation Check

Trust Store

Field Type Description Default Value Required

Path

String

The location of the trust store which resolves relative to the current classpath and file system, if possible.

Password

String

The password used to protect the trust store.

Type

String

The type of store used.

Algorithm

String

The algorithm used by the trust store.

Insecure

Boolean

If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.

Key Store

Field Type Description Default Value Required

Path

String

The location of the key store which resolves relative to the current classpath and file system, if possible.

Type

String

The type of store used.

Alias

String

When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.

Key Password

String

The password used to protect the private key.

Password

String

The password used to protect the key store.

Algorithm

String

The algorithm used by the key store.

Standard Revocation Check

Field Type Description Default Value Required

Only End Entities

Boolean

Only verify the last element of the certificate chain.

Prefer Crls

Boolean

Try CRL instead of OCSP first.

No Fallback

Boolean

Do not use the secondary checking method (the one not selected before).

Soft Fail

Boolean

Avoid verification failure when the revocation server cannot be reached or is busy.

Custom OCSP Responder

Field Type Description Default Value Required

Url

String

The URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response (must be in the trust store), if present.

CRL File

Field Type Description Default Value Required

Path

String

The path to the CRL file.

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

true

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

IBM MQ Attributes

Field Type Description Default Value Required

Properties

Headers

Any

x

Ack Id

String

JMS Message Properties

Field Type Description Default Value Required

All

Any

x

User Properties

Any

x

Jms Properties

Any

x

Jmsx Properties

JMSX Properties

Field Type Description Default Value Required

Jmsx User ID

String

Jmsx App ID

String

Jmsx Delivery Count

Number

Jmsx Group ID

String

Jmsx Group Seq

Number

Jmsx Producer TXID

String

Jmsx Consumer TXID

String

Jmsx Rcv Timestamp

Number

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.

Object Store

Object Store

The object store where the redelivery counter for each message is going to be stored.

MQ JMS Destination

Field Type Description Default Value Required

Destination

String

The name that identifies the destination where a message should be sent.

x

Destination Type

Enumeration, one of:

  • QUEUE

  • TOPIC

The type of this destination.

QUEUE

MQ JMSX Properties

Field Type Description Default Value Required

Jmsx User ID

String

Jmsx App ID

String

Jmsx Delivery Count

Number

Jmsx Group ID

String

Jmsx Group Seq

Number

Jmsx Producer TXID

String

Jmsx Consumer TXID

String

Jmsx Rcv Timestamp

Number

Topic Consumer

Field Type Description Default Value Required

Durable

Boolean

false

Shared

Boolean

false

No Local

Boolean

false

Subscription Name

String

Binding

Field Type Description Default Value Required

Queue Manager

String

The queue manager name.

Client

Field Type Description Default Value Required

Host

String

Host where the IBM MQ Broker is.

x

Port

Number

Queue Manager listener port.

1414

Queue Manager

String

The queue manager which is used when selecting a channel definition.

Channel

String

Name of the channel to connect to.

Connection Name List

String

Hosts to which the client attempts to reconnect to after its connection is broken. The connection name list is a comma-separated list of host and IP port pairs.

Default Caching

Field Type Description Default Value Required

Session Cache Size

Number

Cache Producers

Boolean

true

Cache Consumers

Boolean

true

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.