Skip to content
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.

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

docs(java-client): add announcement of zeebe java client deprecation #4051

Merged
merged 5 commits into from
Aug 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions docs/apis-tools/java-client/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, visit [announcements](../../reference/announcements.md#zeebe-java-client).
:::

## Dependencies

To use the Java client library, declare the following Maven dependency in your project:
Expand Down
20 changes: 20 additions & 0 deletions docs/reference/announcements.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,26 @@ 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 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 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.

:::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` 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`.

### Camunda 8 SaaS - Required cluster update

:::caution
Expand Down
Loading