Document Information
Java CAPS JMS Reference
Introduction to JMS
JMS and Java CAPS
Java Message Service
JMS Message Servers
JMS Message Destinations
JMS Clients
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
Security
Runtime Management
JMS IQ Manager Database
Database Files
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
Example 1
Example 2
Delay and Redirect
Example 3
Example 4
Delay and Delete
Example 5
Specifying Redelivery Options in the JMS IQ Manager
Specifying Redelivery Options in a JMS Client
Enqueued Message Properties
Enqueue Time
Sequence Number
Performance Issues
Throttling Producers
Example of Producer Throttling and Unthrottling
JMS Message Properties
JMS Message Header Properties
Additional JMS Message Properties
JMS OTD Methods
createBytesMessage()
Description
Parameters
Return Value
Exceptions
createBytesMessage(msg)
Description
Parameters
Return Value
Exceptions
createMapMessage()
Description
Parameters
Return Value
Exceptions
createMessage()
Description
Parameters
Return Value
Exceptions
createMessage(msg)
Description
Parameters
Return Value
Exceptions
createStreamMessage()
Description
Parameters
Return Value
Exceptions
createTextMessage()
Description
Parameters
Return Value
Exceptions
createTextMessage(msg)
Description
Parameters
Return Value
Exceptions
getDeliveryMode()
Description
Parameters
Return Value
Exceptions
getDestination()
Description
Parameters
Return Value
Exceptions
Also Accessible From
getMessageServerURL()
Description
Parameters
Return Value
Exceptions
getPriority()
Description
Parameters
Return Value
Exceptions
getTimeToLive()
Description
Parameters
Return Value
Exceptions
receive(timeout)
Description
Parameters
Return Value
Exceptions
receive(timeout, destination)
Description
Parameters
Return Value
Exceptions
receiveNoWait()
Description
Parameters
Return Value
Exceptions
receiveNoWait(destination)
Description
Parameters
Return Value
Exceptions
requestReply(message)
Description
Parameters
Return Value
Exceptions
requestReply(timeout, message)
Description
Parameters
Return Value
Exceptions
requestReplyTo(message, destName)
Description
Parameters
Return Value
Exceptions
requestReplyTo(timeout, message, destName)
Description
Parameters
Return Value
Exceptions
send(message)
Description
Parameters
Return Value
Exceptions
send(message, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
sendBytes(payload)
Description
Parameters
Return Value
Exceptions
sendBytes(payload, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
sendBytesTo(payload, destination)
Description
Parameters
Return Value
Exceptions
sendBytesTo(payload, destination, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
sendText(payload)
Description
Parameters
Return Value
Exceptions
sendText(payload, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
sendTextTo(payload, destination)
Description
Parameters
Return Value
Exceptions
sendTextTo(payload, destination, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
sendTo(message, destination)
Description
Parameters
Return Value
Exceptions
sendTo(message, destination, deliveryMode, priority, timeToLive)
Description
Parameters
Return Value
Exceptions
setDeliveryMode(arg0)
Description
Parameters
Return Value
Exceptions
setDestination(arg0)
Description
Parameters
Return Value
Exceptions
Also Accessible From
setMessageServerURL(arg0)
Description
Parameters
Return Value
Exceptions
setPriority(arg0)
Description
Parameters
Return Value
Exceptions
setTimeToLive(arg0)
Description
Parameters
Return Value
Exceptions
JMS Message Methods
countMapMessage()
Description
Parameters
Return Value
Exceptions
countStreamMessage()
Description
Parameters
Return Value
Exceptions
countUserProperty()
Description
Parameters
Return Value
Exceptions
getBytesMessage()
Description
Parameters
Return Value
Exceptions
getJMSMessageType()
Description
Parameters
Return Value
Exceptions
getMapMessage()
Description
Parameters
Return Value
Exceptions
getMapMessage(arg0)
Description
Parameters
Return Value
Exceptions
getMessageProperties()
Description
Parameters
Return Value
Exceptions
getStreamMessage()
Description
Parameters
Return Value
Exceptions
getStreamMessage(arg0)
Description
Parameters
Return Value
Exceptions
getTextMessage()
Description
Parameters
Return Value
Exceptions
getUserProperty()
Description
Parameters
Return Value
Exceptions
getUserProperty(arg0)
Description
Parameters
Return Value
Exceptions
retrieveBytesFromMessage()
Description
Parameters
Return Value
Exceptions
retrieveBytesFromMessage(arg0)
Description
Parameters
Return Value
Exceptions
retrieveMapMessage(arg0)
Description
Parameters
Return Value
Exceptions
retrieveMapMessageList()
Description
Parameters
Return Value
Exceptions
retrieveStringFromMessage()
Description
Parameters
Return Value
Exceptions
retrieveStringFromMessage(arg0)
Description
Parameters
Return Value
Exceptions
retrieveUserProperty(arg0)
Description
Parameters
Return Value
Exceptions
retrieveUserPropertyList()
Description
Parameters
Return Value
Exceptions
setBytesMessage(arg0)
Description
Parameters
Return Value
Exceptions
setJMSMessageType(arg0)
Description
Parameters
Return Value
Exceptions
setStreamMessage(arg0, arg1)
Description
Parameters
Return Value
Exceptions
setTextMessage(arg0)
Description
Parameters
Return Value
Exceptions
storeMapMessage(arg0, arg1)
Description
Parameters
Return Value
Exceptions
storeUserProperty(arg0, arg1)
Description
Parameters
Return Value
Exceptions
getTimeToWait()
Description
Parameters
Return Value
Exceptions
setTimeToWait(arg0)
Description
Parameters
Return Value
Exceptions
JMS Client Configuration
Categories
Consumers
Action
Allowed Values
Default Value
Concurrency
Default Value
Delay
Allowed Values
Default Value
Durable Subscriber Name
Durability
Allowed Values
Default Value
Message Selector
Move/Delete After N Times
Allowed Values
Default Value
Move to Queue/Topic
Allowed Values
Default Value
Move to Destination Name
Allowed Values
Default Value
Server Session Batch Size
Server Session Pool Size
Allowed Values
Default Value
Producers
Delivery Mode
Default Value
Idle Timeout
Default Value
Maximum Pool Size
Default Value
Maximum Wait Time
Default Value
Priority
Allowed Values
Default Value
Steady Pool Size
Default Value
Transaction Mode
Allowed Values
Default Value
JMS IQ Manager Runtime Configuration
Accessing the Configuration Properties
Configuration Properties Interface
Stable Storage Page
Segment Properties
Data Directory
Default Location
Block Size
Allowed Values
Default Value
Segment Size
Allowed Values
Default Value
Minimum Number of Segments
Allowed Values
Default Value
Maximum Number of Segments
Allowed Values
Default Value
Sync to Disk
Default Condition
Journaling and Expiration Properties
Enable Message Expiration
Maximum Lifetime
Default Value
Enable Journal
Default Condition
Journaling Maximum Lifetime
Default Value
Journal Directory
Allowed Values
Default Value
Messaging Behavior Page
Throttling Properties
Per-Destination Throttling Threshold
Allowed Values
Default Value
Server Throttling Threshold
Allowed Values
Default Value
Throttling Lag
Allowed Values
Default Value
Special FIFO Mode Properties
Fully Serialized Queues
Allowed Values
Protected Concurrent Queues
Allowed Values
FIFO Expiration Time
Default Value
Time Dependency Properties
Allowed Values
Access Control Page
Security Options
Default Condition
Diagnostics Page
Diagnostic Properties
Logging Level
Default Setting
Logging Level of Journaler
Default Condition
Maximum Log File Size
Allowed Values
Default value
Number of Backup Log Files
Allowed Values
Default value
Miscellaneous Page
Enable Alert Option
Default Condition
JMS Provider Management
Overview of MS Control Utility Features
MS Control Utility Details
Flags and Arguments
Syntax
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
Index
JMS Object Type Definitions
The JMS Object Type Definition (OTD) is a special type of OTD that
allows Collaborations to read from and write to topics or queues. It supplies
operators and Java methods for creating, sending, and receiving JMS messages (see JMS OTD Methods).
The JMS OTD is included with Oracle Java CAPS Enterprise Service Bus, and
is installed automatically. The template resides in the CAPS Components Library\Enterprise Service Bus folder under the NetBeans
Projects tab, as shown in the following figure.
Figure 12 Project Explorer - JMS OTD
The send, receive, and receiveWait nodes represent web service operations that are available in the
Collaboration Definition Wizard (Java) when you create a Java based Collaboration Definition implementing
an existing web service. The Message, sendInput, and receiveWaitInput nodes represent messages used with
these operations, as listed in the following table.
|
|
Message |
Message for receive operation |
sendInput |
Message for
send operation |
receiveWaitInput |
Message for receiveWait operation |
|
When you select one of the web service operations for a Java based
Collaboration Definition implementing an existing web service, the corresponding message becomes available in
the Collaboration Definition Editor as the input argument. When you create a Java based
Collaboration Definition implementing a new web service, the three messages become available
as both input and output arguments.
The send, receive, and receiveWait nodes can also be dragged and dropped
into the Oracle Java CAPS Business Process Editor as activities. The corresponding messages are
then displayed in the mapper while performing assigns. See Designing Oracle Java CAPS Business Process Manager Projects for additional information.
Message Types
The JMS OTD currently supports the following message types:
-
Message
A Message carries no payload, and is generally used for event notification. Java methods specifically available for use with this message type are:
BytesMessage
A BytesMessage carries a byte array as its payload, and is often used in cases where JMS is simply used as a transport between systems. Java methods specifically available for use with this message type are:
MapMessage
A MapMessage carries a set of name-value pairs as its payload, and is often used for delivering keyed data. Java methods specifically available for use with this message type are:
StreamMessage
A StreamMessage carries a stream of primitive Java types (such as char, double, and int) as its payload, and is often used when delivering primitive application data in a fixed order. Java methods specifically available for use with this message type are:
TextMessage
A TextMessage carries a string, of type java.lang.Stringas its payload, and is used for exchanging both text messages and XML documents. As such, it is the most often used message type. Java methods specifically available for use with this message type are: