Ultra Messaging® Configuration Guide
Prev	Chapter 4. Reference	Next

4.31. Ultra Messaging JMS Options

4.31.1. client_id (ConnectionFactory)

Unique identifier for a JMS Client.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

4.31.2. context_index (ConnectionFactory)

Optional. Normally a new Connection creates a new UM context, which means a ConnectionFactory using multiple Connections has that many corresponding contexts. This is the behavior if this option is NULL or simply not used. To force this ConnectionFactory to use the same context for all Connections it creates, set this string value to a desired identifier for the context.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

4.31.3. create_queue_browser_context (ConnectionFactory)

Create a secondary context per connection for queue browsing. If not using JMS queue browsing in the JMS application, set this option to false. Not creating the the queue browser context can improve application performance.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	Create a secondary context for queue browsing. Default for Unix.
`False`	`False`	Do not create a secondary, queue browsing context.

4.31.4. debug (ConnectionFactory)

Turns debugging on or off. Setting this to false has the same effect as setting com.latencybusters.jms.level = INFO in jmsclient/bin/logging.properties.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	True
`False`	`False`	False Default for Unix.

4.31.5. default_message_type (ConnectionFactory)

Determines what type of message Ultra Messaging JMS creates when it receives a message without an App Header. The message could be from a non-JMS source or a JMS application that has App Headers turned off (<Attribute name="USE_APP_HEADER" value="false"/>). Possible values are shown in the table below.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`TextMessage`	`TextMessage`	TextMessage
`BytesMessage`	`BytesMessage`	BytesMessage Default for Unix.
`MapMessage`	`MapMessage`	MapMessage
`StreamMessage`	`StreamMessage`	StreamMessage
`ObjectMessage`	`ObjectMessage`	ObjectMessage

4.31.6. default_temp_topic_type (ConnectionFactory)

Sets the default destination for Session.createTemporaryTopic(topicName).

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`UME`	`UME`	Used as the default by topics.
`LBM`	`LBM`	Setting this option to LBM increases performance. Default for Unix.

4.31.7. default_topic_type (ConnectionFactory)

Sets the default destination for Session.createTopic(topicName).

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`UME`	`UME`	Used as the default by topics.
`LBM`	`LBM`	Set to LBM to create a topic that uses basic streaming. Default for Unix.

4.31.8. DestType (Destination)

The DestType attribute determines which JMS destination type should be created.

Scope:	Destination
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`Queue`	`Queue`	Queue
`Topic`	`Topic`	Topic Default for Unix.
`Destination`	`Destination`	Destination Default for Unix.

4.31.9. queue_browser_creation_delay (ConnectionFactory)

When creating a JMS QueueBrowser, the delay to allow the underlying queue browser's context and receiver to register with the queue. Increasing this value may help if an exception returns from the call to getEnumeration indicating that the underlying receiver was not yet registered with the queue.

Scope:	ConnectionFactory
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	500
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.

4.31.10. queue_browser_timeout (ConnectionFactory)

The length of time (in milliseconds) to wait before giving up and returning after calling the JMS QueueBrowser's getEnumeration method. A value of 0 (zero) disables the timeout, allowing the method to wait an unlimited amount of time.

Scope:	ConnectionFactory
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	10000 (10 seconds)
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.

4.31.11. RECEIVER_CREATION_DELAY (ConnectionFactory)

When creating a consumer in JMS, the amount of additional time to wait after creating the underlying LBMReceiver. A value of 0 (zero) indicates no delay. When setting this option in a configuration file, it MUST be uppercase.

Scope:	ConnectionFactory
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	0
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.

4.31.12. regid (Destination)

The Registration ID assigned to the source sending to the Destination. Required for UMP.

Scope:	Destination
Type:	int
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

4.31.13. SOURCE_CREATION_DELAY (ConnectionFactory)

When creating a producer in JMS, the amount of additional time to wait after creating the underlying LBMSource. A value of 0 (zero) indicates no delay. When setting this option in a configuration file, it MUST be uppercase.

Scope:	ConnectionFactory
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	1000
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.

4.31.14. SOURCE_REGISTRATION_TIMEOUT (ConnectionFactory)

When wait_for_source_registration is set to true, the length of time (in milliseconds) to wait before throwing an exception to indicate the source could not register with the store or queue. A value of 0 (zero) disables the timeout, indicating the source should wait an unlimited amount of time. When setting this option in a configuration file, it MUST be uppercase.

Scope:	ConnectionFactory
Type:	lbm_ulong_t
Units:	milliseconds
Default value:	30000
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2.

4.31.15. Topic (Destination)

Sets the Topic Name. The maximum length for this string is 246 characters.

Scope:	Destination
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

4.31.16. Type (Destination)

Determines the type of destination. Overrides the value set for the ConnectionFactory option, default_topic_type for this Destination only. Queueing applications would use UMQ. Topics would use UME or LBM.

Scope:	Destination
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`UME`	`UME`	Set this option to UME for topics in UMP applications.
`LBM`	`LBM`	Set this option to LBM topics in UMS applications. Default for Unix.
`UMQ`	`UMQ`	Set this option to UMQ for UMP applications Default for Unix.

4.31.17. use_app_header (ConnectionFactory)

When set to true, this option enables Ultra Messaging JMS to transmit JMS message header and JMS message properties information (including message selectors) via a UM Message Properties object. See the Oracle JMS Specification for information on JMS message header fields and message properties. Setting this option to false causes Ultra Messaging JMS to use the default message type, and can greatly increase performance.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	True
`False`	`False`	False Default for Unix.

4.31.18. use_index_queuing (ConnectionFactory)

Allows you to turn on index queueing which can be used to simulate the behaviour of the JMSXGroupID flag in a JMS broker. UM JMS sends all of the message for a particular transaction to the same consumer. UMQ load balances the groups of messages across consumers.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	True
`False`	`False`	False Default for Unix.

4.31.19. use_ump_session_ids (ConnectionFactory)

Use this option (with UMP) to enable the use of UMP session IDs. If you use this option, do not set client_id. For more information, see UMP Session IDs in the UM JMS Guide.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.3

String value	Integer value	Description
`True`	`True`	True
`False`	`False`	False Default for Unix.

4.31.20. wait_for_source_registration (ConnectionFactory)

When creating a producer in JMS, the value that controls whether or not to wait for the underlying LBMSource to complete registration with the store or queue. If set to false, then it becomes the responsibility of the application to handle exceptions that occur during sending due to the source not yet being registered.

Scope:	ConnectionFactory
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	Wait for the underlying `LBMSource` to complete registration with the store or queue. Default for Unix.
`False`	`False`	Do not wait for the underlying `LBMSource` to complete registration.

4.31.21. Wildcard (Destination)

Indicates if the topic name is a wildcard pattern.

Scope:	Destination
Type:	string
When to Set:	Can only be set during object initialization.
Version:	This option was implemented in UMQ 5.2

String value	Integer value	Description
`True`	`True`	True
`False`	`False`	False Default for Unix.

Prev	Home	Next
Ultra Messaging Queuing Options	Up	Hot Failover Operation Options