Skip to content

Document cli-*'s currently provided by the project and explain helper maven modules #573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 25, 2023
Merged

Document cli-*'s currently provided by the project and explain helper maven modules #573

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 30 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,36 @@ bash build_docker.sh $(date '+%Y-%m-%d')

## List of Java clis

* qpid-jms (AMQP 1.0)
* activemq-client (OpenWire)
* artemis-jms-client (Artemis Core)
| maven module | messaging library | protocol (JMS version) | notes |
|------------------|--------------------------------------------------------------------------------------------------------|------------------------|------------------|
| cli-activemq | [activemq-client](https://deps.dev/maven/org.apache.activemq%3Aactivemq-client) | OpenWire (JMS v1.1) | javax.jms API |
| cli-activemq-jmx | [artemis-core-client](https://deps.dev/maven/org.apache.activemq%3Aartemis-core-client) | JMX management | |
| cli-artemis-jms | [artemis-jms-client](https://deps.dev/maven/org.apache.activemq%3Aartemis-jms-client) | Artemis Core | javax.jms API |
| cli-paho-java | [eclipse.paho.client.mqttv3](https://deps.dev/maven/org.eclipse.paho%3Aorg.eclipse.paho.client.mqttv3) | MQTT v3 | |
| cli-protonj2 | [protonj2-client](https://deps.dev/maven/org.apache.qpid%3Aprotonj2-client) | AMQP 1.0 | "imperative API" |
| 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 |

## Additional maven modules

| maven module | |
|--------------|-----------------------------------------------------------------------------|
| parent | common maven configuration for child modules, parent of all other modules |
| bom | contains dependencyManagement pom section with dependency versions |
| broker | embedded artemis-server broker for use in selftests |
| tests | test dependency of cli-* projects, contains shared test code |
| lib | shared code that does not depend on JMS |
| jmslib | shared code that depends on javax.jms API |
| jakartalib | shared code that depends on jakarta.jmx API |
| cli | the ClientListener interface for use in client selftests (messages as Maps) |

## Directories

| directory | |
|-----------|------------------------------------------------------------|
| .github | GitHub Actions CI configurations, dependabot.yml file |
| image | helper scripts for Dockerfile/Containerfile to build image |
| scripts | helper scripts for CI jobs |


## Related projects

Expand Down