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

refactor: expand java client limitation documentation #4466

Merged
merged 2 commits into from
Oct 17, 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
7 changes: 6 additions & 1 deletion docs/apis-tools/java-client/job-worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ keywords: ["backpressure", "back-pressure", "back pressure"]
The Java client provides a job worker that handles polling for available jobs. This allows you to focus on writing code to handle the activated jobs.

:::caution REST API limitation
The 8.6.0 Java client cannot maintain the long-lived polling connections required for job polling via the REST API. For example, this applies to performing long-polling job activation when activating jobs larger than the maximum message size, or receiving additional job activation requests while the long-polling connection is still open.
The 8.6.0 Java client cannot maintain the long-lived polling connections required for job polling via the REST API. For example, this applies when:

- Performing long-polling job activation when activating jobs larger than the maximum message size.
- Receiving additional job activation requests from the same Java client while the long-polling connection is still open.
- Receiving additional job activation requests from a Java client running on the same JVM while the long-polling connection is still open.
- Receiving additional job activation requests from a Java client running on a different JVM while the long-polling connection is still open.

If you encounter this issue, consider switching to the Zeebe gRPC protocol for job activation, or use job
activation via the REST API with long polling disabled.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@ keywords: ["backpressure", "back-pressure", "back pressure"]
The Java client provides a job worker that handles polling for available jobs. This allows you to focus on writing code to handle the activated jobs.

:::caution REST API limitation
The 8.6.0 Java client cannot maintain the long-lived polling connections required for job polling via the REST API. For example, this applies to performing long-polling job activation when activating jobs larger than the maximum message size, or receiving additional job activation requests while the long-polling connection is still open.
The 8.6.0 Java client cannot maintain the long-lived polling connections required for job polling via the REST API. For example, this applies when:

- Performing long-polling job activation when activating jobs larger than the maximum message size.
- Receiving additional job activation requests from the same Java client while the long-polling connection is still open.
- Receiving additional job activation requests from a Java client running on the same JVM while the long-polling connection is still open.
- Receiving additional job activation requests from a Java client running on a different JVM while the long-polling connection is still open.

If you encounter this issue, consider switching to the Zeebe gRPC protocol for job activation, or use job
activation via the REST API with long polling disabled.
Expand Down
Loading