Configuring Java CAPS Project Components for Application Adapters

Inbound WebSphere MQ Adapter Settings with GetMessageOptions and options

The Inbound Adapter Settings with GetMessageOptions and options section of the WebSphere MQ Adapter Connectivity Map properties contains the top-level parameters displayed in the following table.

Table 1–23 Connectivity Map - Inbound Adapter Settings with GetMessageOptions and options

Name 

Description 

Required Value 

MQGMO_ACCEPT_TRUNCATED_MSG

Specifies whether a truncated message is accepted as a complete message. If the message buffer is too small to hold the complete message, this option allows the MQGET call to fill the buffer with as much as it can hold and complete its processing. Without this option, in the given situation, the MQGET call will still be filled to capacity, but the processing will not be considered completed. The values are: 

  • True: Indicates that a truncated message is accepted as a complete message.

  • False: Indicates that a truncated message is not considered as a complete message.

True or False.

The configured default is True.

MQGMO_FAIL_IF_QUIESCING

Forces the MQGET call to fail if the queue manager is in the quiescing state. The values are: 

  • True: Indicates that calling MQGET fails if the queue manager is in the quiescing state.

  • False: Indicates that calling MQGET does not fail if the queue manager is in the quiescing state.

True or False.

The configured default is True.

MQGMO_SYNCPOINT

Forces the MQGET call to get the message under syncpoint control; the message is marked as being unavailable to other applications, but it is deleted from the queue only when the unit of work is committed. The message is made available again if the unit of work is backed out. The values are: 

  • True: Indicates that calling MQGET gets the message under syncpoint control.

  • False: Indicates that MQGET, when called does not get the message under syncpoint control.

True or False.

The configured default is False.

MQGMO_SYNCPOINT_IF_PERSISTENT

Forces the MQGET call to get the message under syncpoint control if the message is persistent. The values are: 

  • True: Indicates that calling MQGET gets the message under syncpoint control if the message is persistent.

  • False: Indicates that MQGET, when called does not get the message under syncpoint control if the message is persistent.

True or False.

The configured default is False.

MQGMO_COMPLETE_MSG

Specifies that only a complete logical message can be returned by calling MQGET. If the logical message is segmented, the queue manager reassembles the segments and returns the complete logical message to the application; the fact that the logical message was segmented is not apparent to the Adapter. The values are: 

  • True: Indicates that only a complete logical message can be returned by calling MQGET.

  • False: Indicates that a complete logical message is not required.

True or False.

The configured default is False.

MQGMO_WAIT

Specifies that an MQ GET call waits (block and/or suspend) until a message becomes available in the queue. The values are: 

  • True: Indicates that an MQ GET call waits until a message becomes available in the queue.

  • False: Indicates that an MQ GET call does not wait until a message becomes available in the queue.

True or False.

The configured default is False.

waitInterval

Specifies how long (in milliseconds) an MQ GET call waits for a message to become available in the queue. This parameter is used in conjunction with MQGMO_WAIT. If MQGMO_WAIT is set to false, waitInterval is not used.

Specifying a negative value indicates that the wait will last indefinitely. 

Setting this value to a negative number causes the polling Adapter to execute MQ GET calls with a wait interval of MQWI_UNLIMITED. With this type of get call, the Adapter will block indefinitely until a suitable message is available. If the Integration Server (in association with the Application Server) is commanded to shut down or restart while the Adapter is still blocked, the Integration Server will not be able to proceed until the Adapter is unblocked by the availability of a suitable MQ message.

The same limitation affects the non-polling use of the Adapter. The WebSphere MQ Adapter’s OTD GMO structure exposes a method named setUnlimitedWait() to Java Collaborations that, when used, sets the waitInterval to the value MQWI_UNLIMITED. If using setUnlimitedWait() causes the Adapter to block indefinitely during a subsequent get call, the Integration Server will be unable to shut down until the Adapter is unblocked.

A number indicating the period of time, in milliseconds, that an MQ GET call waits for a message to become available in the queue. 

The configured default is 0.