From 174270fbc27b80ab62152c6bc6d4f418d744b482 Mon Sep 17 00:00:00 2001 From: Robbie Gemmell Date: Mon, 8 Aug 2022 15:45:19 +0100 Subject: [PATCH] ARTEMIS-3914: reorder and clarify some bits, use version placeholder to give specific version in example dependency declaration --- artemis-website/pom.xml | 10 ++--- docs/user-manual/en/client-classpath.md | 56 ++++++++++--------------- 2 files changed, 26 insertions(+), 40 deletions(-) diff --git a/artemis-website/pom.xml b/artemis-website/pom.xml index 893199cba1..5f39806c95 100644 --- a/artemis-website/pom.xml +++ b/artemis-website/pom.xml @@ -219,10 +219,9 @@ io.netty
#Artemis JMS Client Dependencies - -File | observation | package +File | package | observation ---|---|---
- X{fileMD}| X{detail} |X{package} + X{fileMD} | X{package} | X{detail} io.netty:netty-transport-native-epoll io.netty:netty-transport-classes-epoll @@ -255,9 +254,9 @@ File | observation | package io.netty
#Artemis Jakarta Client Dependencies -File | observation | package +File | package | observation ---|---|---
- X{fileMD}| X{detail} |X{package} + X{fileMD} | X{package} | X{detail} io.netty:netty-transport-native-epoll io.netty:netty-transport-classes-epoll @@ -292,6 +291,7 @@ File | observation | package + diff --git a/docs/user-manual/en/client-classpath.md b/docs/user-manual/en/client-classpath.md index 7a446eb96f..b04541c06f 100644 --- a/docs/user-manual/en/client-classpath.md +++ b/docs/user-manual/en/client-classpath.md @@ -1,23 +1,10 @@ # The Client Classpath -Apache ActiveMQ Artemis requires just a single jar on the *client classpath*. +## Maven dependencies -> **Warning** -> -> The client jar mentioned here can be found in the `lib/client` directory of -> the Apache ActiveMQ Artemis distribution. Be sure you only use the jar from -> the correct version of the release, you *must not* mix and match versions of -> jars from different Apache ActiveMQ Artemis versions. Mixing and matching -> different jar versions may cause subtle errors and failures to occur. +The recommended way to define a client dependency for your java application is through a Maven dependency declaration. - -## Maven Packages - -The best way to define a client dependency to your java application is through a maven dependency declaration. - -There are two packages you can choose from, org.apache.activemq:artemis-jms-client or org.apache.activemq:artemis-jakarta-client for both JMS and Jakarta APIs. - -Say you define artemis-version as '{{ config.version }}': +There are two dependencies you can choose from, `org.apache.activemq:artemis-jms-client` for JMS 2.0 or `org.apache.activemq:artemis-jakarta-client` for Jakarta Messaging 3.x. For JMS: ```xml @@ -25,7 +12,7 @@ For JMS: org.apache.activemq artemis-jms-client - ${artemis-version} + @PROJECT_VERSION_FILTER_TOKEN@ ... ``` @@ -36,33 +23,32 @@ For Jakarta: org.apache.activemq artemis-jakarta-client - ${artemis-version} + @PROJECT_VERSION_FILTER_TOKEN@ ... ``` -## All clients +## Individual client dependencies -Even though it is highly recommend using maven, in case this is not a possibility the all inclusive jars could be used. +If you dont wish to use a build tool such as Maven which manages the dependencies for you, you may also choose to add the specific dependency jars to your classpath, which are all included under ./lib on the main distribution. -These jars will be available under ./lib/client on the main distribution: +For more information of the clients individual dependencies, see: +- [JMS client dependencies](client-classpath-jms.md ) +- [Jakarta client dependencies](client-classpath-jakarta.md) -- artemis-jakarta-client-all-{{ config.version }}.jar -- artemis-jms-client-all-{{ config.version }}.jar +## Repackaged '-all' clients + +Even though it is highly recommend using maven, in cases this isnt a possibility and neither is using the individual dependencies detailed above, the all-inclusive repackaged jar could be used. + +These jars are available under `./lib/client` on the main distribution (or also as linked at Maven Central): +- [artemis-jms-client-all-{{ config.version }}.jar](https://repo.maven.apache.org/maven2/org/apache/activemq/artemis-jms-client-all/{{ config.version }}/) +- [artemis-jakarta-client-all-{{ config.version }}.jar](https://repo.maven.apache.org/maven2/org/apache/activemq/artemis-jakarta-client-all/{{ config.version }}/) Whether you are using JMS or just the Core API simply add the -`artemis-jms-client-all.jar` from the `lib/client` directory to your client -classpath. +`artemis-jms-client-all` jar from the `lib/client` directory to your client +classpath. For Jakarta Messaging add the `artemis-jakarta-client-all` jar instead. + +**Warning:**These repackaged jars include all the [client's dependencies](client-classpath-jms.md). Be careful with mixing other components jars in your application as they may clash with each other. -**Warning:**These jars will include all the [client's dependencies](client-classpath-jms.md). Be careful with mixing other jars in your application as they may clash with other. - -## Individual dependencies - -You may also choose to use the jars individually as they are all included under ./lib on the main distribution. - -For more information: - -- [client jms dependencies](client-classpath-jms.md ) -- [client jakarta dependencies](client-classpath-jakarta.md)