JMS Message Properties - Oracle Java CAPS JMS Reference

Skip Navigation Links
Exit Print View
	Oracle Java CAPS JMS Reference Java CAPS Documentation

Oracle Technology Network

Document Information

Java CAPS JMS Reference

Introduction to JMS

JMS and Java CAPS

Java Message Service

JMS Message Servers

JMS Message Destinations

JMS Object Type Definitions

JMS Library File

Implementing JMS in Java CAPS Projects

Integration Model

To Implement JMS Following the Java CAPS Model

Creating and Configuring Message Destinations

Creating OTDs and Collaborations

Configuring JMS Clients

Configuring Message Servers

Creating Component Mappings

Using the JMS OTD in Collaboration Definitions

Using JMS Messages in Collaboration Definitions

Inside the JMS IQ Manager

JMS Messaging Features

Message Delivery Order

Message Producer Priorities

Distributed Transactions

Runtime Management

JMS IQ Manager Database

Database Location

Database Configuration and Operation

Message Processing Order

JMS IQ Manager Delivery Modes

Fully Concurrent Processing

Protected Concurrent Processing

Fully Serialized Processing

Serial Processing Across a Destination Group

JMS Client Delivery Modes

Message Producer Priorities

Message Redelivery and Redirection

Redelivery Options

Progressive Delay

Delay and Redirect

Delay and Delete

Specifying Redelivery Options in the JMS IQ Manager

Specifying Redelivery Options in a JMS Client

Enqueued Message Properties

Sequence Number

Performance Issues

Throttling Producers

Example of Producer Throttling and Unthrottling

JMS Object Type Definitions

JMS Message Properties

JMS Message Header Properties

Additional JMS Message Properties

JMS OTD Methods

createBytesMessage()

createBytesMessage(msg)

createMapMessage()

createMessage()

createMessage(msg)

createStreamMessage()

createTextMessage()

createTextMessage(msg)

getDeliveryMode()

getDestination()

Also Accessible From

getMessageServerURL()

getTimeToLive()

receive(timeout)

receive(timeout, destination)

receiveNoWait()

receiveNoWait(destination)

requestReply(message)

requestReply(timeout, message)

requestReplyTo(message, destName)

requestReplyTo(timeout, message, destName)

send(message, deliveryMode, priority, timeToLive)

sendBytes(payload)

sendBytes(payload, deliveryMode, priority, timeToLive)

sendBytesTo(payload, destination)

sendBytesTo(payload, destination, deliveryMode, priority, timeToLive)

sendText(payload)

sendText(payload, deliveryMode, priority, timeToLive)

sendTextTo(payload, destination)

sendTextTo(payload, destination, deliveryMode, priority, timeToLive)

sendTo(message, destination)

sendTo(message, destination, deliveryMode, priority, timeToLive)

setDeliveryMode(arg0)

setDestination(arg0)

Also Accessible From

setMessageServerURL(arg0)

setPriority(arg0)

setTimeToLive(arg0)

JMS Message Methods

countMapMessage()

countStreamMessage()

countUserProperty()

getBytesMessage()

getJMSMessageType()

getMapMessage()

getMapMessage(arg0)

getMessageProperties()

getStreamMessage()

getStreamMessage(arg0)

getTextMessage()

getUserProperty()

getUserProperty(arg0)

retrieveBytesFromMessage()

retrieveBytesFromMessage(arg0)

retrieveMapMessage(arg0)

retrieveMapMessageList()

retrieveStringFromMessage()

retrieveStringFromMessage(arg0)

retrieveUserProperty(arg0)

retrieveUserPropertyList()

setBytesMessage(arg0)

setJMSMessageType(arg0)

setStreamMessage(arg0, arg1)

setTextMessage(arg0)

storeMapMessage(arg0, arg1)

storeUserProperty(arg0, arg1)

getTimeToWait()

setTimeToWait(arg0)

JMS Client Configuration

Durable Subscriber Name

Message Selector

Move/Delete After N Times

Move to Queue/Topic

Move to Destination Name

Server Session Batch Size

Server Session Pool Size

Maximum Pool Size

Maximum Wait Time

Steady Pool Size

Transaction Mode

JMS IQ Manager Runtime Configuration

Accessing the Configuration Properties

Configuration Properties Interface

Stable Storage Page

Segment Properties

Default Location

Minimum Number of Segments

Maximum Number of Segments

Default Condition

Journaling and Expiration Properties

Enable Message Expiration

Maximum Lifetime

Default Condition

Journaling Maximum Lifetime

Journal Directory

Messaging Behavior Page

Throttling Properties

Per-Destination Throttling Threshold

Server Throttling Threshold

Special FIFO Mode Properties

Fully Serialized Queues

Protected Concurrent Queues

FIFO Expiration Time

Time Dependency Properties

Access Control Page

Security Options

Default Condition

Diagnostics Page

Diagnostic Properties

Default Setting

Logging Level of Journaler

Default Condition

Maximum Log File Size

Number of Backup Log Files

Miscellaneous Page

Enable Alert Option

Default Condition

JMS Provider Management

Overview of MS Control Utility Features

MS Control Utility Details

Flags and Arguments

Using the MS Control Utility

To Change Message Contents

To Create a Backup Archive File

To Access an Archive File

To Set the MS Control Utility Timeout Period

To Shut the Server Down

Command/Response Examples

Message Server Example

Message Destination (Queue) Examples

Message Destination (Topic) Examples

Message Examples

Troubleshooting

Timestamp Errors

JMS Message Properties

You can set specific message properties in the JMS OTD using the property nodes that are exposed by expanding the appropriate nodes in the Collaboration Definition Editor.

JMS Message Header Properties

You can set the message header properties for both inbound or outbound JMS messages. These property nodes are shown in the following figure, as they appear in the user interface. These same properties are also available for the output node in the receiveWait operation. When you set these properties in a Java based Collaboration Definition, they are used only by the Collaboration that uses that specific Collaboration Definition.

Figure 13 JMS Message Property Nodes (receive operation)

image:Screen capture showing JMS message property nodes in OTD tree.

The following table shows the allowed values for the properties and the JMS methods used when you set a property in a Collaboration Definition. The methods that are exposed for your use are cross-referenced to the appropriate description. The methods that are not cross-referenced are automatically assigned, and not exposed.

Property	Values	Equivalent JMS Methods
`CorrelationID`	Correlation ID	`getJMSCorrelationID()` `setJMSCorrelationID(string)`
`CorrelationIDAsBytes`	Correlation ID	`getCorrelationIDAsBytes` `setCorrelationIDAsBytes(byte[])`
`DeliveryMode`	Persistent, nonpersistent (default = persistent)	getDeliveryMode() setDeliveryMode(arg0)
`Destination`	Destination (default = message destination as configured in Connectivity Map)	getDestination() setDestination(arg0)
`Expiration`	Number in milliseconds (default = 0 ms = never expire)	getTimeToLive() setTimeToLive(arg0)
`MessageID`	Message ID	`getJMSMessageID()` `setJMSMessageID(string)`
`Priority`	0 - 9 where 9 is the highest priority (default = 4)	getPriority() setPriority(arg0)
`Redelivered`	True, false	`getJMSRedelivered()` `setJMSRedelivered(boolean)`
`ReplyTo`	Destination	`getJMSReplyTo()` `setJMSReplyTo(destination)`
`Timestamp`	Number in milliseconds	`getJMSTimestamp()` `setJMSTimestamp(long)`
`Type`	Text, Bytes, Map, Stream	getJMSMessageType() setJMSMessageType(arg0)

Additional JMS Message Properties

You can also set the message properties for outbound JMS messages. These property nodes are shown in the following figure, as they appear in the user interface. These properties determine only how the message is sent. When you set these properties in a Java based Collaboration Definition, they override the corresponding JMS client message properties, and are used only by the Collaboration that uses that specific Collaboration Definition. For information on setting these properties in the JMS clients, see Configuring JMS Clients.

Figure 14 JMS OTD Outbound Property Nodes

image:Screen capture showing JMS outbound property nodes in OTD tree.

The following table shows the allowed values for the outbound JMS message properties and the JMS methods used when you set a property in a Collaboration.

Property	Allowed Values	Equivalent JMS Methods
`deliveryMode`	Persistent, nonpersistent	getDeliveryMode() setDeliveryMode(arg0)
`priority`	0 - 9 where 9 is the highest priority	getPriority() setPriority(arg0)
`timeToLive`	Number in milliseconds	getTimeToLive() setTimeToLive(arg0)
`destination`	Destination	getDestination() setDestination(arg0)
`MessageServerURL`	A valid URL	getMessageServerURL() setMessageServerURL(arg0)

For more information about these properties, refer to the equivalent JMS method description in the indicated locations.

Copyright © 2009, 2011, Oracle and/or its affiliates. All rights reserved. Legal Notices

Previous

Next