Property definitions

This topic provides a definition of each object property.

Each property definition includes the following information:

• The data type of the property
• The types of object that have the property
• For a property of Destination, the name that can be used in a uniform resource identifier (URI)
• A more detailed description of the property
• The valid values of the property
• The default value of the property

Properties whose names commence with one of the following prefixes are relevant only for the specified type of connection:

XMSC_RTT

The properties are relevant only for a real-time connection to a broker. The names of the properties are defined as named constants in the header file xmsc_rtt.h.

XMSC_WMQ

The properties are relevant only when an application connects to a WebSphere MQ queue manager. The names of the properties are defined as named constants in the header file xmsc_wmq.h.

XMSC_WPM

The properties are relevant only when an application connects to a WebSphere service integration bus. The names of the properties are defined as named constants in the header file xmsc_wpm.h.

Unless stated otherwise in their definitions, the remaining properties are relevant for all types of connection. The names of the properties are defined as named constants in the header file xmsc.h. Properties whose names commence with the prefix JMSX are JMS defined properties of a message, and properties whose names commence with the prefix JMS_IBM are IBM® defined properties of a message. For more information about the properties of messages, see Properties of an XMS message.

Unless stated otherwise in its definition, each property is relevant in both the point-to-point and publish/subscribe domains.

An application can get and set the value of any property, unless the property is designated as read-only.

The following properties are defined:

• JMS_IBM_CHARACTER_SET
• JMS_IBM_ENCODING
• JMS_IBM_EXCEPTIONMESSAGE
• JMS_IBM_EXCEPTIONPROBLEMDESTINATION
• JMS_IBM_EXCEPTIONREASON
• JMS_IBM_EXCEPTIONTIMESTAMP
• JMS_IBM_FEEDBACK
• JMS_IBM_FORMAT
• JMS_IBM_LAST_MSG_IN_GROUP
• JMS_IBM_MSGTYPE
• JMS_IBM_PUTAPPLTYPE
• JMS_IBM_PUTDATE
• JMS_IBM_PUTTIME
• JMS_IBM_REPORT_COA
• JMS_IBM_REPORT_COD
• JMS_IBM_REPORT_DISCARD_MSG
• JMS_IBM_REPORT_EXCEPTION
• JMS_IBM_REPORT_EXPIRATION
• JMS_IBM_REPORT_NAN
• JMS_IBM_REPORT_PAN
• JMS_IBM_REPORT_PASS_CORREL_ID
• JMS_IBM_REPORT_PASS_MSG_ID
• JMS_IBM_SYSTEM_MESSAGEID
• JMSX_APPID
• JMSX_DELIVERY_COUNT
• JMSX_GROUPID
• JMSX_GROUPSEQ
• JMSX_USERID
• XMSC_CLIENT_ID
• XMSC_CONNECTION_TYPE
• XMSC_DELIVERY_MODE
• XMSC_IC_PROVIDER_URL
• XMSC_IC_SECURITY_AUTHENTICATION
• XMSC_IC_SECURITY_CREDENTIALS
• XMSC_IC_SECURITY_PRINCIPAL
• XMSC_IC_SECURITY_PROTOCOL
• XMSC_IC_URL
• XMSC_IS_SUBSCRIPTION_MULTICAST
• XMSC_IS_SUBSCRIPTION_RELIABLE_MULTICAST
• XMSC_JMS_MAJOR_VERSION
• XMSC_JMS_MINOR_VERSION
• XMSC_JMS_VERSION
• XMSC_MAJOR_VERSION
• XMSC_MINOR_VERSION
• XMSC_PASSWORD
• XMSC_PRIORITY
• XMSC_PROVIDER_NAME
• XMSC_RTT_BROKER_PING_INTERVAL
• XMSC_RTT_CONNECTION_PROTOCOL
• XMSC_RTT_HOST_NAME
• XMSC_RTT_LOCAL_ADDRESS
• XMSC_RTT_MULTICAST
• XMSC_RTT_PORT
• XMSC_TIME_TO_LIVE
• XMSC_USERID
• XMSC_VERSION
• XMSC_WMQ_BROKER_CONTROLQ
• XMSC_WMQ_BROKER_PUBQ
• XMSC_WMQ_BROKER_QMGR
• XMSC_WMQ_BROKER_SUBQ
• XMSC_WMQ_BROKER_VERSION
• XMSC_WMQ_CCDTURL
• XMSC_WMQ_CCSID
• XMSC_WMQ_CHANNEL
• XMSC_WMQ_CONNECTION_MODE
• XMSC_WMQ_DUR_SUBQ
• XMSC_WMQ_ENCODING
• XMSC_WMQ_FAIL_IF_QUIESCE
• XMSC_WMQ_HOST_NAME
• XMSC_WMQ_LOCAL_ADDRESS
• XMSC_WMQ_MESSAGE_SELECTION
• XMSC_WMQ_MSG_BATCH_SIZE
• XMSC_WMQ_POLLING_INTERVAL
• XMSC_WMQ_PORT
• XMSC_WMQ_PUB_ACK_INTERVAL
• XMSC_WMQ_QMGR_CCSID
• XMSC_WMQ_QUEUE_MANAGER
• XMSC_WMQ_RECEIVE_EXIT
• XMSC_WMQ_RECEIVE_EXIT_INIT
• XMSC_WMQ_SECURITY_EXIT
• XMSC_WMQ_SECURITY_EXIT_INIT
• XMSC_WMQ_SEND_EXIT
• XMSC_WMQ_SEND_EXIT_INIT
• XMSC_WMQ_SYNCPOINT_ALL_GETS
• XMSC_WMQ_TARGET_CLIENT
• XMSC_WMQ_TEMP_Q_PREFIX
• XMSC_WMQ_TEMPORARY_MODEL
• XMSC_WPM_BUS_NAME
• XMSC_WPM_CONNECTION_PROTOCOL
• XMSC_WPM_CONNECTION_PROXIMITY
• XMSC_WPM_DUR_SUB_HOME
• XMSC_WPM_HOST_NAME
• XMSC_WPM_LOCAL_ADDRESS
• XMSC_WPM_ME_NAME
• XMSC_WPM_NON_PERSISTENT_MAP
• XMSC_WPM_PERSISTENT_MAP
• XMSC_WPM_PORT
• XMSC_WPM_PROVIDER_ENDPOINTS
• XMSC_WPM_TARGET_GROUP
• XMSC_WPM_TARGET_SIGNIFICANCE
• XMSC_WPM_TARGET_TRANSPORT_CHAIN
• XMSC_WPM_TARGET_TYPE
• XMSC_WPM_TEMP_Q_PREFIX
• XMSC_WPM_TEMP_TOPIC_PREFIX
• XMSC_WPM_TOPIC_SPACE