Skip to content

Commit e6fc58c

Browse files
authored
Document cli-*'s currently provided by the project and explain helper maven modules (#573)
1 parent c33ad29 commit e6fc58c

File tree

1 file changed

+30
-3
lines changed

1 file changed

+30
-3
lines changed

README.md

+30-3
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,36 @@ bash build_docker.sh $(date '+%Y-%m-%d')
5151

5252
## List of Java clis
5353

54-
* qpid-jms (AMQP 1.0)
55-
* activemq-client (OpenWire)
56-
* artemis-jms-client (Artemis Core)
54+
| maven module | messaging library | protocol (JMS version) | notes |
55+
|------------------|--------------------------------------------------------------------------------------------------------|------------------------|------------------|
56+
| cli-activemq | [activemq-client](https://deps.dev/maven/org.apache.activemq%3Aactivemq-client) | OpenWire (JMS v1.1) | javax.jms API |
57+
| cli-activemq-jmx | [artemis-core-client](https://deps.dev/maven/org.apache.activemq%3Aartemis-core-client) | JMX management | |
58+
| cli-artemis-jms | [artemis-jms-client](https://deps.dev/maven/org.apache.activemq%3Aartemis-jms-client) | Artemis Core | javax.jms API |
59+
| cli-paho-java | [eclipse.paho.client.mqttv3](https://deps.dev/maven/org.eclipse.paho%3Aorg.eclipse.paho.client.mqttv3) | MQTT v3 | |
60+
| cli-protonj2 | [protonj2-client](https://deps.dev/maven/org.apache.qpid%3Aprotonj2-client) | AMQP 1.0 | "imperative API" |
61+
| cli-qpid-jms | [qpid-jms-client](https://deps.dev/maven/org.apache.qpid%3Aqpid-jms-client) | AMQP 1.0 (JMS v2.0) | jakarta.jms API |
62+
63+
## Additional maven modules
64+
65+
| maven module | |
66+
|--------------|-----------------------------------------------------------------------------|
67+
| parent | common maven configuration for child modules, parent of all other modules |
68+
| bom | contains dependencyManagement pom section with dependency versions |
69+
| broker | embedded artemis-server broker for use in selftests |
70+
| tests | test dependency of cli-* projects, contains shared test code |
71+
| lib | shared code that does not depend on JMS |
72+
| jmslib | shared code that depends on javax.jms API |
73+
| jakartalib | shared code that depends on jakarta.jmx API |
74+
| cli | the ClientListener interface for use in client selftests (messages as Maps) |
75+
76+
## Directories
77+
78+
| directory | |
79+
|-----------|------------------------------------------------------------|
80+
| .github | GitHub Actions CI configurations, dependabot.yml file |
81+
| image | helper scripts for Dockerfile/Containerfile to build image |
82+
| scripts | helper scripts for CI jobs |
83+
5784

5885
## Related projects
5986

0 commit comments

Comments
 (0)