From 98a39e65fe6772a9dd1b5c7802b3116602ccfaa8 Mon Sep 17 00:00:00 2001 From: Nicola Puppa Date: Fri, 19 Jul 2024 11:10:15 +0200 Subject: [PATCH 1/4] docs(java-client): add announcement of java client restructure --- docs/reference/announcements.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md index ded374b1a2..ed6234908e 100644 --- a/docs/reference/announcements.md +++ b/docs/reference/announcements.md @@ -10,6 +10,22 @@ Scheduled release date: 8th of Oct 2024 Scheduled end of maintenance: 14th of April 2026 +### Zeebe Java Client + +Starting with 8.7 the Zeebe Java Client will become the new Camunda Java Client. This transition brings a new Java client structure designed to enhance user experience and introduce new features while maintaining compatibility with existing codebases. + +The primary goal of those changes is to enable users to interact with Camunda clusters with one consolidated client instead of multiple ones. The `CamundaClient` will replace the `ZeebeClient`, offering the same functionality and adding new capabilities. If you need to continue using the old `ZeebeClient`, you can use the version 8.6 artifact without any issues with newer cluster versions as the client is forward-compatible. Please note that the Zeebe Java Client will not be developed further and will only receive bug fixes for as long as version 8.6 is officially supported. + +#### Key changes: + +- **New package structure**: + - Package `io.camunda.client`: this package contains the new CamundaClient along with all the features slated for release in version 8.7. +- **Properties and Environment Variables Refactoring**: + - All old Java client property names will be refactored to more general ones. For instance: `zeebe.client.tenantId` will become `camunda.client.tenantId`. + - Similarly, environment variables will be renamed following the same concept: `ZEEBE_REST_ADDRESS` will become `CAMUNDA_REST_ADDRESS`. +- **Artifact ID Change**: + - The artifactId will change from `zeebe-client-java` to `camunda-client-java`. + ### Camunda 8 SaaS - Required cluster update :::caution From 01c13155d87d1047b9cf0e119dad72bdf185d787 Mon Sep 17 00:00:00 2001 From: Christina Ausley Date: Wed, 31 Jul 2024 08:34:48 -0400 Subject: [PATCH 2/4] style(formatting): grammatical adjustments --- docs/reference/announcements.md | 22 +++++++++++++--------- 1 file changed, 13 insertions(+), 9 deletions(-) diff --git a/docs/reference/announcements.md b/docs/reference/announcements.md index ed6234908e..512904eb3e 100644 --- a/docs/reference/announcements.md +++ b/docs/reference/announcements.md @@ -10,21 +10,25 @@ Scheduled release date: 8th of Oct 2024 Scheduled end of maintenance: 14th of April 2026 -### Zeebe Java Client +### Zeebe Java client -Starting with 8.7 the Zeebe Java Client will become the new Camunda Java Client. This transition brings a new Java client structure designed to enhance user experience and introduce new features while maintaining compatibility with existing codebases. +Starting with 8.7, the Zeebe Java client will become the new Camunda Java client. This transition brings a new Java client structure designed to enhance the user experience and introduce new features while maintaining compatibility with existing codebases. -The primary goal of those changes is to enable users to interact with Camunda clusters with one consolidated client instead of multiple ones. The `CamundaClient` will replace the `ZeebeClient`, offering the same functionality and adding new capabilities. If you need to continue using the old `ZeebeClient`, you can use the version 8.6 artifact without any issues with newer cluster versions as the client is forward-compatible. Please note that the Zeebe Java Client will not be developed further and will only receive bug fixes for as long as version 8.6 is officially supported. +The primary goal of those changes is to enable users to interact with Camunda clusters with one consolidated client rather than multiple. The `CamundaClient` will replace the `ZeebeClient`, offering the same functionality and adding new capabilities. If you need to continue using the old `ZeebeClient`, you can use the version 8.6 artifact without any issues with newer cluster versions as the client is forward-compatible. -#### Key changes: +:::note +The Zeebe Java client will not be developed further and will only receive bug fixes for as long as version 8.6 is officially supported. +::: + +#### Key changes - **New package structure**: - - Package `io.camunda.client`: this package contains the new CamundaClient along with all the features slated for release in version 8.7. -- **Properties and Environment Variables Refactoring**: - - All old Java client property names will be refactored to more general ones. For instance: `zeebe.client.tenantId` will become `camunda.client.tenantId`. + - Package `io.camunda.client`: This package contains the new `CamundaClient` and all the features slated for release in version 8.7. +- **Properties and environment variables refactoring**: + - All old Java client property names will be refactored to more general ones. For instance, `zeebe.client.tenantId` will become `camunda.client.tenantId`. - Similarly, environment variables will be renamed following the same concept: `ZEEBE_REST_ADDRESS` will become `CAMUNDA_REST_ADDRESS`. -- **Artifact ID Change**: - - The artifactId will change from `zeebe-client-java` to `camunda-client-java`. +- **Artifact ID change**: + - The `artifactId` will change from `zeebe-client-java` to `camunda-client-java`. ### Camunda 8 SaaS - Required cluster update From efd372483de1f03a3ab0dfccde71a74c9d29ccfb Mon Sep 17 00:00:00 2001 From: Nicola Puppa Date: Fri, 2 Aug 2024 06:51:49 +0200 Subject: [PATCH 3/4] docs(java-client): add heads up in the java client section --- docs/apis-tools/java-client/index.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/apis-tools/java-client/index.md b/docs/apis-tools/java-client/index.md index 34f258e7e4..e24bed2020 100644 --- a/docs/apis-tools/java-client/index.md +++ b/docs/apis-tools/java-client/index.md @@ -5,6 +5,11 @@ sidebar_label: "Quick reference" description: "Provide a job worker that handles polling for available jobs, use SLF4J for logging useful notes, and more." --- +:::info +Starting with 8.7, the Zeebe Java client will become the new Camunda Java client. This transition brings a new Java client structure designed to enhance the user experience and introduce new features while maintaining compatibility with existing codebases. +For more information, take a look at the [announcement](../../reference/announcements.md#zeebe-java-client) +::: + ## Dependencies To use the Java client library, declare the following Maven dependency in your project: From aa72f90cda4b2909bdfe7d72fe133728b7d3a495 Mon Sep 17 00:00:00 2001 From: christinaausley <84338309+christinaausley@users.noreply.github.com> Date: Fri, 2 Aug 2024 08:29:50 -0600 Subject: [PATCH 4/4] style(formatting): minor grammatical fix --- docs/apis-tools/java-client/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/apis-tools/java-client/index.md b/docs/apis-tools/java-client/index.md index e24bed2020..0768a607df 100644 --- a/docs/apis-tools/java-client/index.md +++ b/docs/apis-tools/java-client/index.md @@ -7,7 +7,7 @@ description: "Provide a job worker that handles polling for available jobs, use :::info Starting with 8.7, the Zeebe Java client will become the new Camunda Java client. This transition brings a new Java client structure designed to enhance the user experience and introduce new features while maintaining compatibility with existing codebases. -For more information, take a look at the [announcement](../../reference/announcements.md#zeebe-java-client) +For more information, visit [announcements](../../reference/announcements.md#zeebe-java-client). ::: ## Dependencies