This page describes the requirements and initial design of the new Qpid JMS Client that supports AMQP 1.0 (simply referred to as the "Qpid JMS Client" below).
![]() Table of Contents |
Requirements
Functional requirements
...
- Synchronous, Auto-Ack style 'simple client'
- All Message types.
- Main operations on JMS Connections, Sessions, Consumers, Producers, Queues, Message (Text?).
- Include closing/stopping/deleting where applicable.
- Configuration
- Ability to configure settings such as pre-fetch etc
- TODO per connection or per consumer or both? If the latter then not sure how to pass this setting in (address options?), given that JMS API doesn't offer an obvious way to do it.
TODO define how JNDI configuration will work
- Basic JNDI
- SASL
- Correct handling of non-happy path scenarios, namely:
- Unexpected errors
- Failures that are nevertheless AMQP-compliant, e.g. the Broker spontaneously sends a Close or End frame.
- Timeouts due to connectivity failure etc. Necessary because of the asynchronous nature of AMQP.
- Interruption of application-owned threads.
...
- SSL
- Transactions
- Client Ack
- Selectors
- JNDI
- MessageListener.onMessage()
- Durable Subscriptions
- JMS 2.0 features:
- Asynchronous send
- Shared Topic Subscriptions
- Enhanced JNDI
Non-functional requirements
...
- AMQP 0-x
- ADDR and BURL addressing formats
- Failover. Instead, this will be implemented in the future either entirely below or entirely above the client code.
- Accepting legacy system properties (unelss they happen to match what we would choose now).
Design
Layers
![]() No Format |
+================================+
|
| JMS
|
| Implementations of javax.jms
|
+================================+
|
|
\|/
+================================+
|
| AMQP
|
| Wrappers around Proton's engine
| classes, primarily to add locking
|
+================================+
| |
| |
\|/ |
+======================+ |
| Proton | |
| | |
| Message | Engine | |
| | | |
+=========+============+ |
/|\ |
| |
| \|/
+====================
|
| JMS Driver interface
|
+=====================
/|\
|
+--------------+
| |
| |
| |
+===========+ +==============
| |
| Socket |
| driver | Another driver,
| (might use | e.g. in-VM
| Proton's Driver) |
| |
+===========+ +==============
|
| TCP/IP
|
\|/
+================================+
|
| Broker
|
+================================+
|
...
The following diagram shows how module tests will work:
![]() No Format |
+================================+
|
| JUnit test
|
| 1. Create an in-process TestAmqpPeer
| 2. Set up TestAmqpPeer behaviour and expectations
| 3. Call some JMS methods
|
+================================+
| | |
| | |
| | \|/
| | +================================+
| | |
| | | JMS client
| | |
| | +================================+
| | | |
| latch/ | |
| unlatch etc | |
| | \|/ |
| | +======================+ |
| | | Proton | |
expect/ | | | |
assert | | Message | Engine | |
| | | | | |
| | +=========+============+ |
| | /|\ |
| | | |
| \|/ \|/ \|/
| +=======================================
| |
| | In-process Driver
| |
| +=======================================
| /|\
| |
| | Bytes
| |
\|/ \|/
+===================================+
|
| TestAmqpPeer
|
+===================================+
|
...
AMQP 1.0 JMS Client Requirements and Design 