From 53dc3e4339a88f93097f45fdb465019592b75a07 Mon Sep 17 00:00:00 2001 From: Jonathan Robie Date: Fri, 23 Apr 2010 17:28:54 +0000 Subject: Checking in dummy table for Java JMS message properties so Rajith can fill in. git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@937423 13f79535-47bb-0310-9956-ffa450edef68 --- doc/book/src/High-Level-API.xml | 99 ++++++++++++++++++++++++++++++++++------- 1 file changed, 82 insertions(+), 17 deletions(-) (limited to 'doc') diff --git a/doc/book/src/High-Level-API.xml b/doc/book/src/High-Level-API.xml index 224eab04f7..c4ad0cbb65 100644 --- a/doc/book/src/High-Level-API.xml +++ b/doc/book/src/High-Level-API.xml @@ -67,9 +67,9 @@
- Using the Qpid messaging API + Using the Qpid Messaging API - The Qpid messaging API is quite simple, consisting of only a + The Qpid Messaging API is quite simple, consisting of only a handful of core classes. @@ -214,7 +214,7 @@ finally:
-
+
Addresses An address is the name of a message @@ -230,7 +230,7 @@ finally: An address resolves to a node. The - Qpid messaging API recognises two kinds of nodes, + Qpid Messaging API recognises two kinds of nodes, queues and topics. The terms queue and @@ -240,7 +240,7 @@ finally: and publish-subscribe. AMQP 0-10 has an exchange type called a topic exchange. When the term topic occurs alone, it refers to a - messaging API topic, not the topic + Messaging API topic, not the topic exchange.. A queue stores each message until it has been received and @@ -260,11 +260,11 @@ finally: queues map to AMQP queues, and topics map to AMQP exchanges. In AMQP 0-10, messages are sent to - exchanges, and read from queues. The messaging API also + exchanges, and read from queues. The Messaging API also allows a sender to send messages to a queue; internally, Qpid implements this by sending the message to the default exchange, with the name of the queue as the routing key. The - messaging API also allows a receiver to receive messages + Messaging API also allows a receiver to receive messages from a topic; internally, Qpid implements this by setting up a private subscription queue for the receiver and binding the subscription queue to the exchange that corresponds to @@ -759,7 +759,7 @@ Message(properties={spout-id:ea75d64d-ea37-47f9-96a9-d38e01c97925:0}, content='t --> - Address Options + Address String Options @@ -1061,8 +1061,10 @@ options := map ]]> - The address string options map supports the following parameters: - + + Address String Options + The address string options map supports the following parameters: + [ / ] ; { @@ -1095,7 +1097,7 @@ options := map always: the action will be performed by any messaging client sender: the action will only be performed by a sender receiver: the action will only be performed by a receiver - never: the action will never be performed (this is the default) + never: the action will never be performed (this is the default) @@ -1205,7 +1207,7 @@ options := map This section describes the AMQP 0-10 mapping for the Qpid - messaging API. + Messaging API. The interaction with the broker triggered by creating a sender @@ -1309,7 +1311,7 @@ options := map exchange is not a standard AMQP exchange type. It is a Qpid extension and is currently only supported by the C++ broker. if a subject is specified it is - used as the bidning key and an xquery is defined that will + used as the binding key and an XQuery is defined that will match any message with that value for qpid.subject. Again this means that only messages whose subject exactly match that specified in the source address will be received. For @@ -1347,7 +1349,7 @@ options := map Python API C++ API - AMQP 0-10 PropertyIn these entries, mp> refers to an AMQP message property, and dp refers to an AMQP delivery property. + AMQP 0-10 PropertyIn these entries, mp refers to an AMQP message property, and dp refers to an AMQP delivery property. @@ -1397,9 +1399,11 @@ options := map A Simple Messaging Program in Java JMSThe following program shows how to use address strings and - JNDI for Qpid programs that use Java JMS. + JNDI for Qpid programs that use Java JMS. - This program uses a JNDI file that defines a connection + The Qpid JMS client uses to identify sources and + targets. This program uses a JNDI file that defines a connection factory for the broker we are using, and the address of the topic exchange node that we will bind the sender and receiver to. (The syntax of a ConnectionURL is given in brokerlist='tcp://localhost:5672' - + + +
+ Java JMS Message Properties + + The following table shows how Qpid Messaging API message + properties are mapped to AMQP 0-10 message properties and + delivery properties. In this table msg + refers to the Message class defined in the Qpid Messaging API, + mp refers to an AMQP 0-10 + message-properties struct, and + dp refers to an AMQP 0-10 + delivery-properties struct. + +
+ Java JMS Mapping to AMQP 0-10 Message Properties + + + + Java JMS Message Property + AMQP 0-10 PropertyIn these entries, mp refers to an AMQP message property, and dp refers to an AMQP delivery property. + + + + + + msg.idmp.message_id + + + msg.subjectmp.application_headers["qpid.subject"] + + + msg.user_idmp.user_id + + + msg.reply_tomp.reply_toThe reply_to is converted from the protocol representation into an address. + + + msg.correlation_idmp.correlation_id + + + msg.durabledp.delivery_mode == delivery_mode.persistentNote that msg.durable is a boolean, not an enum. + + + msg.prioritydp.priority + + + msg.ttldp.ttl + + + msg.redelivereddp.redelivered + + mp.application_headers + + + msg.content_typemp.content_type + + + +
+ +
-- cgit v1.2.1