Class JobWorkerBuilderImpl
- All Implemented Interfaces:
CommandWithOneOrMoreTenantsStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
,CommandWithTenantStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
,JobWorkerBuilderStep1
,JobWorkerBuilderStep1.JobWorkerBuilderStep2
,JobWorkerBuilderStep1.JobWorkerBuilderStep3
-
Nested Class Summary
Nested classes/interfaces inherited from interface io.camunda.zeebe.client.api.worker.JobWorkerBuilderStep1
JobWorkerBuilderStep1.JobWorkerBuilderStep2, JobWorkerBuilderStep1.JobWorkerBuilderStep3
-
Field Summary
Fields inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep
DEFAULT_TENANT_IDENTIFIER
-
Constructor Summary
ConstructorDescriptionJobWorkerBuilderImpl
(ZeebeClientConfiguration configuration, JobClient jobClient, ScheduledExecutorService executorService, List<Closeable> closeables) -
Method Summary
Modifier and TypeMethodDescriptionbackoffSupplier
(BackoffSupplier backoffSupplier) Sets the backoff supplier.fetchVariables
(String... fetchVariables) Set a list of variable names which should be fetch on job activation.fetchVariables
(List<String> fetchVariables) Set a list of variable names which should be fetch on job activation.handler
(JobHandler handler) Set the handler to process the jobs.Set the type of jobs to work on.maxJobsActive
(int maxJobsActive) Set the maximum number of jobs which will be exclusively activated for this worker at the same time.metrics
(JobWorkerMetrics metrics) Sets the job worker metrics implementation to use.Set the name of the worker owner.open()
Open the worker and start to work on available tasks.pollInterval
(Duration pollInterval) Set the maximal interval between polling for new jobs.requestTimeout
(Duration requestTimeout) Set the request timeout for activate job request used to poll for new job.streamEnabled
(boolean isStreamEnabled) Opt-in feature flag to enable job streaming.streamTimeout
(Duration timeout) If streaming is enabled, sets a maximum lifetime for a given stream.Experimental: This method is under development, and as such using it may have no effect on the command builder when called.Shorthand method forCommandWithOneOrMoreTenantsStep.tenantIds(List)
.Specifies the tenants that may own any entities (e.g.timeout
(long timeout) Set the time for how long a job is exclusively assigned for this worker.Set the time for how long a job is exclusively assigned for this worker.
-
Field Details
-
DEFAULT_BACKOFF_SUPPLIER
-
DEFAULT_STREAMING_TIMEOUT
-
-
Constructor Details
-
JobWorkerBuilderImpl
public JobWorkerBuilderImpl(ZeebeClientConfiguration configuration, JobClient jobClient, ScheduledExecutorService executorService, List<Closeable> closeables)
-
-
Method Details
-
jobType
Description copied from interface:JobWorkerBuilderStep1
Set the type of jobs to work on.- Specified by:
jobType
in interfaceJobWorkerBuilderStep1
- Parameters:
type
- the type of jobs (e.g. "payment")- Returns:
- the builder for this worker
-
handler
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep2
Set the handler to process the jobs. At the end of the processing, the handler should complete the job or mark it as failed;Example JobHandler implementation:
public final class PaymentHandler implements JobHandler { @Override public void handle(JobClient client, JobEvent jobEvent) { String json = jobEvent.getVariables(); // modify variables client .newCompleteCommand(jobEvent.getKey()) .variables(json) .send(); } };
The handler must be thread-safe.- Specified by:
handler
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep2
- Parameters:
handler
- the handle to process the jobs- Returns:
- the builder for this worker
-
timeout
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the time for how long a job is exclusively assigned for this worker.In this time, the job can not be assigned by other workers to ensure that only one worker work on the job. When the time is over then the job can be assigned again by this or other worker if it's not completed yet.
If no timeout is set, then the default is used from the configuration.
- Specified by:
timeout
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
timeout
- the time in milliseconds- Returns:
- the builder for this worker
-
timeout
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the time for how long a job is exclusively assigned for this worker.In this time, the job can not be assigned by other workers to ensure that only one worker work on the job. When the time is over then the job can be assigned again by this or other worker if it's not completed yet.
If no time is set then the default is used from the configuration.
- Specified by:
timeout
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
timeout
- the time as duration (e.g. "Duration.ofMinutes(5)")- Returns:
- the builder for this worker
-
name
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the name of the worker owner.This name is used to identify the worker to which a job is exclusively assigned to.
If no name is set then the default is used from the configuration.
- Specified by:
name
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
workerName
- the name of the worker (e.g. "payment-service")- Returns:
- the builder for this worker
-
maxJobsActive
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the maximum number of jobs which will be exclusively activated for this worker at the same time.This is used to control the backpressure of the worker. When the maximum is reached then the worker will stop activating new jobs in order to not overwhelm the client and give other workers the chance to work on the jobs. The worker will try to activate new jobs again when jobs are completed (or marked as failed).
If no maximum is set then the default, from the
ZeebeClientConfiguration
, is used.Considerations:
- A greater value can avoid situations in which the client waits idle for the broker to provide more jobs. This can improve the worker's throughput.
- The memory used by the worker is linear with respect to this value.
- The job's timeout starts to run down as soon as the broker pushes the job. Keep in mind
that the following must hold to ensure fluent job handling:
time spent in queue + time job handler needs until job completion < job timeout
- Specified by:
maxJobsActive
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
maxJobsActive
- the maximum jobs active by this worker- Returns:
- the builder for this worker
-
pollInterval
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the maximal interval between polling for new jobs.A job worker will automatically try to always activate new jobs after completing jobs. If no jobs can be activated after completing the worker will periodically poll for new jobs.
If no poll interval is set then the default is used from the
ZeebeClientConfiguration
- Specified by:
pollInterval
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
pollInterval
- the maximal interval to check for new jobs- Returns:
- the builder for this worker
-
requestTimeout
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set the request timeout for activate job request used to poll for new job.If no request timeout is set then the default is used from the
ZeebeClientConfiguration
NOTE: the request time out defined here is only applied to the activate jobs command, i.e. to polling for jobs, and is not applied to the job stream; use
JobWorkerBuilderStep1.JobWorkerBuilderStep3.streamTimeout(Duration)
for that.- Specified by:
requestTimeout
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
requestTimeout
- the request timeout for activate jobs request- Returns:
- the builder for this worker
-
fetchVariables
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set a list of variable names which should be fetch on job activation.The jobs which are activated by this worker will only contain variables from this list.
This can be used to limit the number of variables of the activated jobs.
- Specified by:
fetchVariables
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
fetchVariables
- list of variables names to fetch on activation- Returns:
- the builder for this worker
-
fetchVariables
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Set a list of variable names which should be fetch on job activation.The jobs which are activated by this worker will only contain variables from this list.
This can be used to limit the number of variables of the activated jobs.
- Specified by:
fetchVariables
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
fetchVariables
- list of variables names to fetch on activation- Returns:
- the builder for this worker
-
backoffSupplier
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Sets the backoff supplier. The supplier is called to determine the retry delay after each failed request; the worker then waits until the returned delay has elapsed before sending the next request. Note that this is used only for the polling mechanism - failures in theJobHandler
should be handled there, and retried there if need be.By default, the supplier uses exponential back off, with an upper bound of 5 seconds. The exponential backoff can be easily configured using
BackoffSupplier.newBackoffBuilder()
.- Specified by:
backoffSupplier
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
backoffSupplier
- supplies the retry delay after a failed request- Returns:
- the builder for this worker
-
streamEnabled
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Opt-in feature flag to enable job streaming. If set as enabled, the job worker will use a mix of streaming and polling to activate jobs. A long living stream will be opened onto which jobs will be eagerly pushed, and the polling mechanism will be used strictly to fetch jobs created before any streams were opened.If the stream is closed, e.g. the server closed the connection, was restarted, etc., it will be immediately recreated as long as the worker is opened.
NOTE: Job streaming is still under active development, and should be disabled if you notice any issues.
- Specified by:
streamEnabled
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Returns:
- the builder for this worker
-
streamTimeout
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
If streaming is enabled, sets a maximum lifetime for a given stream. Once this timeout is reached, the stream is closed, such that no more jobs are activated and received. If the worker is still open, then it will immediately open a new stream.With no timeout, the stream will live as long as the client, or until the server closes the connection.
It's recommended to set a relatively long timeout, to allow for streams to load balance properly across your gateways.
- Specified by:
streamTimeout
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
timeout
- a timeout, after which the stream is recreated- Returns:
- the builder for this worker
-
metrics
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Sets the job worker metrics implementation to use. SeeJobWorkerMetrics
for more. Defaults toJobWorkerMetrics.noop()
, an implementation which simply does nothing.- Specified by:
metrics
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Parameters:
metrics
- the implementation to use- Returns:
- the builder for this worker
-
open
Description copied from interface:JobWorkerBuilderStep1.JobWorkerBuilderStep3
Open the worker and start to work on available tasks.- Specified by:
open
in interfaceJobWorkerBuilderStep1.JobWorkerBuilderStep3
- Returns:
- the worker
-
tenantId
Description copied from interface:CommandWithOneOrMoreTenantsStep
Experimental: This method is under development, and as such using it may have no effect on the command builder when called. While unimplemented, it simply returns the command builder instance unchanged. This method already exists for software that is building support for multi-tenancy, and already wants to use this API during its development. As support for multi-tenancy is added to Zeebe, each of the commands that implement this method may start to take effect. Until this warning is removed, anything described below may not yet have taken effect, and the interface and its description are subject to change.Specifies the tenant that will own any entities (e.g. process definition, process instances, etc.) resulting from this command, or that owns any entities (e.g. jobs) referred to from this command.
Multi-tenancy
Multiple tenants can share a Zeebe cluster. Entities can be assigned to a specific tenant using an identifier. Only that tenant can access these entities.
Any entities created before multi-tenancy has been enabled in the Zeebe cluster, are assigned to the
CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER
.If no tenant is explicitly specified, then the command is rejected.
One or more tenants
This method can be called multiple times to specify multiple tenants.
This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.
- Specified by:
tenantId
in interfaceCommandWithOneOrMoreTenantsStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
- Specified by:
tenantId
in interfaceCommandWithTenantStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
- Parameters:
tenantId
- the identifier of the tenant to specify for this command, e.g."ACME"
- Returns:
- the builder for this command with the tenant specified
-
tenantIds
Description copied from interface:CommandWithOneOrMoreTenantsStep
Specifies the tenants that may own any entities (e.g. process definition, process instances, etc.) resulting from this command.One or more tenants
This can be useful when requesting jobs for multiple tenants at once. Each of the activated jobs will be owned by the tenant that owns the corresponding process instance.
- Specified by:
tenantIds
in interfaceCommandWithOneOrMoreTenantsStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
- Parameters:
tenantIds
- the identifiers of the tenants to specify for this command, e.g.["ACME", "OTHER"]
- Returns:
- the builder for this command with the tenants specified
- See Also:
-
tenantIds
Description copied from interface:CommandWithOneOrMoreTenantsStep
Shorthand method forCommandWithOneOrMoreTenantsStep.tenantIds(List)
.- Specified by:
tenantIds
in interfaceCommandWithOneOrMoreTenantsStep<JobWorkerBuilderStep1.JobWorkerBuilderStep3>
- Parameters:
tenantIds
- the identifiers of the tenants to specify for this command, e.g.["ACME", "OTHER"]
- Returns:
- the builder for this command with the tenants specified
- See Also:
-