Inquire Subscription (Response)

The response to the Inquire Subscription (MQCMD_INQUIRE_SUBSCRIPTION) command consists of the response header followed by the SubId and SubName structures, and the requested combination of attribute parameter structures (where applicable).

Always returned

SubID, SubName

Returned if requested

AlterationDate, AlterationTime, CreationDate, CreationTime, Destination, DestinationClass, DestinationCorrelId, DestinationQueueManager, Expiry, PublishedAccountingToken, PublishedApplicationIdentityData, PublishPriority, PublishSubscribeProperties, Requestonly, Selector, SelectorType, SubscriptionLevel, SubscriptionScope, SubscriptionType, SubscriptionUser, TopicObject, TopicString, Userdata, VariableUser, WildcardSchema

Response Data

AlterationDate (MQCFST)

The date of the most recent MQSUB or Change Subscription command that modified the properties of the subscription (parameter identifier: MQCA_ALTERATION_DATE).

AlterationTime (MQCFST)

The time of the most recent MQSUB or Change Subscription command that modified the properties of the subscription (parameter identifier: MQCA_ALTERATION_TIME).

CreationDate (MQCFST)

The creation date of the subscription, in the form yyyy-mm-dd (parameter identifier: MQCA_CREATION_DATE).

CreationTime (MQCFST)

The creation time of the subscription, in the form hh.mm.ss (parameter identifier: MQCA_CREATION_TIME).

Destination (MQCFST)

Destination (parameter identifier: MQCACF_DESTINATION).

Specifies the name of the alias, local, remote, or cluster queue to which messages for this subscription are put.

DestinationClass (MQCFIN)

Destination class (parameter identifier: MQIACF_DESTINATION_CLASS).

Whether the destination is managed.

The value can be any of the following values:

MQDC_MANAGED

The destination is managed.

MQDC_PROVIDED

The destination queue is as specified in the Destination field.

DestinationCorrelId (MQCFBS)

Destination correlation identifier (parameter identifier: MQBACF_DESTINATION_CORREL_ID).

A correlation identifier that is placed in the CorrelId field of the message descriptor for all the messages sent to this subscription.

The maximum length is MQ_CORREL_ID_LENGTH.

DestinationQueueManager (MQCFST)

Destination queue manager (parameter identifier: MQCACF_DESTINATION_Q_MGR).

Specifies the name of the destination queue manager, either local or remote, to which messages for the subscription are forwarded.

The maximum length of the string is MQ_Q_MGR_NAME_LENGTH.

DisplayType (MQCFIN)

The type of output requested for MQCA_TOPIC_STRING and MQCA_TOPIC_NAME is returned (parameter identifier: MQIA_DISPLAY_TYPE).

MQDOPT_RESOLVED

Returns the resolved (full) topic string in the MQCA_TOPIC_STRING attribute. The value of the MQCA_TOPIC_NAME attribute is also returned.

MQDOPT_DEFINED

The application portion of the topic string is returned in the MQCA_TOPIC_STRING attribute. MQCA_TOPIC_NAME contains the name of the TOPIC Object used when defining the subscription.

Durable (MQCFIN)

Whether this subscription is a durable subscription (parameter identifier: MQIACF_DURABLE_SUBSCRIPTION). The value can be any of the following values:

MQSUB_DURABLE_YES

The subscription persists, even if the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. The queue manager reinstates the subscription during restart.

MQSUB_DURABLE_NO

The subscription is non-durable. The queue manager removes the subscription when the creating application disconnects from the queue manager or issues an MQCLOSE call for the subscription. If the subscription has a destination class (DESTCLAS) of MANAGED, the queue manager removes any messages not yet consumed when it closes the subscription.

Expiry (MQCFIN)

The time, in tenths of a second, at which a subscription expires after its creation date and time (parameter identifier: MQIACF_EXPIRY).

A value of unlimited means that the subscription never expires.

After a subscription has expired it becomes eligible to be discarded by the queue manager and receives no further publications.

PublishedAccountingToken (MQCFBS)

Value of the accounting token used in the AccountingToken field of the message descriptor (parameter identifier: MQBACF_ACCOUNTING_TOKEN).

The maximum length of the string is MQ_ACCOUNTING_TOKEN_LENGTH.

PublishedApplicationIdentityData (MQCFST)

Value of the application identity data used in the ApplIdentityData field of the message descriptor (parameter identifier: MQCACF_APPL_IDENTITY_DATA.

The maximum length of the string is MQ_APPL_IDENTITY_DATA_LENGTH.

PublishPriority (MQCFIN)

The priority of messages sent to this subscription (parameter identifier: MQIACF_PUB_PRIORITY). The value can be any of the following values:

MQPRI_PRIORITY_AS_PUBLISHED

The priority of messages sent to this subscription is taken from that priority supplied to the published message. MQPRI_PRIORITY_AS_PUBLISHED is the supplied default value.

MQPRI_PRIORITY_AS_QDEF

The priority of messages sent to this subscription is determined by the default priority of the queue defined as a destination.

0-9

An integer value providing an explicit priority for messages sent to this subscription.

PublishSubscribeProperties (MQCFIN)

Specifies how publish/subscribe related message properties are added to messages sent to this subscription (parameter identifier: MQIACF_PUBSUB_PROPERTIES). The value can be any of the following values:

MQPSPROP_NONE

Publish/subscribe properties are not added to the messages. MQPSPROP_NONE is the supplied default value.

MQPSPROP_MSGPROP

Publish/subscribe properties are added as PCF attributes.

MQPSPROP_COMPAT

If the original publication is a PCF message, then the publish/subscribe properties are added as PCF attributes. Otherwise, publish/subscribe properties are added within an MQRFH version 1 header. This method is compatible with applications coded for use with previous versions of IBM MQ .

MQPSPROP_RFH2

Publish/subscribe properties are added within an MQRFH version 2 header. This method is compatible with applications coded for use with IBM Integration Bus brokers.

Requestonly (MQCFIN)

Indicates whether the subscriber polls for updates using the MQSUBRQ API call, or whether all publications are delivered to this subscription (parameter identifier: MQIACF_REQUEST_ONLY). The value can be:

MQRU_PUBLISH_ALL

All publications on the topic are delivered to this subscription.

MQRU_PUBLISH_ON_REQUEST

Publications are only delivered to this subscription in response to an MQSUBRQ API call.

Selector (MQCFST)

Specifies the selector applied to messages published to the topic (parameter identifier: MQCACF_SUB_SELECTOR).

Only those messages that satisfy the selection criteria are put to the destination specified by this subscription.

SelectorType (MQCFIN)

The type of selector string that has been specified (parameter identifier: MQIACF_SELECTOR_TYPE). The value can be any of the following values:

MQSELTYPE_NONE

No selector has been specified.

MQSELTYPE_STANDARD

The selector references only the properties of the message, not its content, using the standard IBM MQ selector syntax. Selectors of this type are to be handled internally by the queue manager.

MQSELTYPE_EXTENDED

The selector uses extended selector syntax, typically referencing the content of the message. Selectors of this type cannot be handled internally by the queue manager; extended selectors can be handled only by another program, such as IBM Integration Bus.

SubID (MQCFBS)

The internal, unique key identifying a subscription (parameter identifier: MQBACF_SUB_ID).

SubscriptionLevel (MQCFIN)

The level within the subscription interception hierarchy at which this subscription is made (parameter identifier: MQIACF_SUB_LEVEL). The value can be:

0 - 9

An integer in the range 0-9. The default value is 1. Subscribers with a subscription level of 9 will intercept publications before they reach subscribers with lower subscription levels.

SubscriptionScope (MQCFIN)

Determines whether this subscription is passed to other queue managers in the network (parameter identifier: MQIACF_SUBSCRIPTION_SCOPE). The value can be:

MQTSCOPE_ALL

The subscription is forwarded to all queue managers directly connected through a publish/subscribe collective or hierarchy. MQTSCOPE_ALL is the supplied default value.

MQTSCOPE_QMGR

The subscription only forwards messages published on the topic within this queue manager.

SubscriptionType (MQCFIN)

Indicates how the subscription was created (parameter identifier: MQIACF_SUB_TYPE).

MQSUBTYPE_PROXY

An internally created subscription used for routing publications through a queue manager.

MQSUBTYPE_ADMIN

Created using DEF SUB MQSC or PCF command. This SUBTYPE also indicates that a subscription has been modified using an administrative command.

MQSUBTYPE_API

Created using an MQSUB API request.

SubscriptionUser (MQCFST)

The userid that 'owns' this subscription. This parameter is either the userid associated with the creator of the subscription, or, if subscription takeover is permitted, the userid which last took over the subscription. (parameter identifier: MQCACF_SUB_USER_ID).

The maximum length of the string is MQ_USER_ID_LENGTH.

TopicObject (MQCFST)

The name of a previously defined topic object from which is obtained the topic name for the subscription (parameter identifier: MQCA_TOPIC_NAME).

The maximum length of the string is MQ_TOPIC_NAME_LENGTH.

TopicString (MQCFST)

The resolved topic string (parameter identifier: MQCA_TOPIC_STRING).

The maximum length of the string is MQ_TOPIC_STR_LENGTH.

Userdata (MQCFST)

User data (parameter identifier: MQCACF_SUB_USER_DATA).

Specifies the user data associated with the subscription

The maximum length of the string is MQ_USER_DATA_LENGTH.

VariableUser (MQCFIN)

Specifies whether a user other than the one who created the subscription, that is, the user shown in SubscriptionUser can take over the ownership of the subscription (parameter identifier: MQIACF_VARIABLE_USER_ID). The value can be any of the following values:

MQVU_ANY_USER

Any user can take over the ownership. MQVU_ANY_USER is the supplied default value.

MQVU_FIXED_USER

No other user can take over the ownership.

WildcardSchema (MQCFIN)

Specifies the schema to be used when interpreting any wildcard characters contained in the TopicString (parameter identifier: MQIACF_WILDCARD_SCHEMA). The value can be any of the following values:

MQWS_CHAR

Wildcard characters represent portions of strings; it is for compatibility with IBM MQ V6.0 broker.

MQWS_TOPIC

Wildcard characters represent portions of the topic hierarchy; this is for compatibility with IBM Integration Bus brokers. MQWS_TOPIC is the supplied default value.

Parent topic: Definitions of the Programmable Command Formats