Properties associate an extensible set of property field names with values. The EMS server uses properties to attach ancillary information to messages.
Client applications can also use propertiesfor example, to customize message filtering; see Message Selectors.
Property names must conform to the syntax for message selector identifiers; see Identifiers.
Property values must not be null, nor the empty string.
Sending programs can set property values before sending a message.
Receiving programs cannot ordinarily set property values on inbound messages. However, tibemsMsg_ClearProperties
removes all existing the properties from a message, and lets the program set property values.
The JMS specification reserves the property name prefix JMS_
vendor_name
_
for provider-specific properties (for EMS, this prefix is JMS_TIBCO_
). Properties that begin with this prefix refer to features of EMS; client programs may use these properties to access those features, but not for communicating application-specific information among client programs.
Property
|
Description
|
---|---|
JMS_TIBCO_CM_PUBLISHER
|
Correspondent name of an RVCM sender for messages imported from TIBCO Rendezvous.
|
JMS_TIBCO_CM_SEQUENCE
|
Sequence number of an RVCM message imported from TIBCO Rendezvous.
|
JMS_TIBCO_COMPRESS
|
Senders may set this property to request that EMS compress the message before sending it to the server. The .NET client API does not support this feature at this time.
|
JMS_TIBCO_DISABLE_SENDER
|
Senders may set this property to prevent the EMS server from including the sender name in the message when the server sends it to consumers; see
JMS_TIBCO_SENDER .
|
JMS_TIBCO_IMPORTED
|
When the EMS server imports a message from an external message service (such as TIBCO Rendezvous or TIBCO SmartSockets), it sets this property to
true .
|
JMS_TIBCO_MSG_EXT
|
Producers can set this property to
true to indicate that a message uses EMS extensions to the JMS specification for messages.
The server sets this property to
true when importing a message from an external message service, since the message might use those extensions.
|
JMS_TIBCO_MSG_TRACE
|
When a producer sets this property, the EMS server generates trace output when the message arrives from the producer, and whenever a consumer receives it.
|
JMS_TIBCO_PRESERVE_UNDELIVERED
|
When this property is
true , the server preserves a record of undeliverable messages by delivering them to the undelivered message queue, $sys.undelivered .
|
JMS_TIBCO_SENDER
|
The EMS server fills this property with the user name (string) of the client that sent the message. This feature applies only when the
sender_name property of the message’s destination is non-null. The sender can disable this feature (overriding the destination property sender_name ) by setting a non-null value for the message property JMS_TIBCO_DISABLE_SENDER .
|
JMS_TIBCO_SS_SENDER
|
When the EMS server imports a message from TIBCO SmartSockets, it sets this property to the SmartSockets
sender header field (in SmartSockets syntax).
|
01 TIBEMS-PROPERTIES. 05 JMS-TIBCO-CM-PUBLISHER PIC X(23) VALUE Z'JMS_TIBCO_CM_PUBLISHER'. 05 JMS-TIBCO-CM-SEQUENCE PIC X(22) VALUE Z'JMS_TIBCO_CM_SEQUENCE'. 05 JMS-TIBCO-COMPRESS PIC X(19) VALUE Z'JMS_TIBCO_COMPRESS'. 05 JMS-TIBCO-DISABLE-SENDER PIC X(25) VALUE Z'JMS_TIBCO_DISABLE_SENDER'. 05 JMS-TIBCO-IMPORTED PIC X(19) VALUE Z'JMS_TIBCO_IMPORTED'. 05 JMS-TIBCO-MSG-EXT PIC X(19) VALUE Z'JMS_TIBCO_MSG_EXT'. 05 JMS-TIBCO-MSG-TRACE PIC X(20) VALUE Z'JMS_TIBCO_MSG_TRACE'. 05 JMS-TIBCO-PRESERVE-UNDELIVERED PIC X(31) VALUE Z'JMS_TIBCO_PRESERVE_UNDELIVERED'. 05 JMS-TIBCO-SENDER PIC X(17) VALUE Z'JMS_TIBCO_SENDER'. 05 JMS-TIBCO-SS-SENDER PIC X(20) VALUE Z'JMS_TIBCO_SS_SENDER'.
The JMS specification reserves the property name prefix JMSX
for properties defined by JMS. Client programs may use these properties to access those features, but not for communicating application-specific information among client programs.
For information about these properties, see the JMS specification.
TIBCO Enterprise Message Service™ C and COBOL Reference System Release 4.3, February 2006 Copyright © TIBCO Software Inc. All rights reserved www.tibco.com |