Package io.camunda.zeebe.client.impl

Class ZeebeClientBuilderImpl

java.lang.Object

io.camunda.zeebe.client.impl.ZeebeClientBuilderImpl

All Implemented Interfaces:

ZeebeClientBuilder, ZeebeClientConfiguration

public final class ZeebeClientBuilderImpl
extends Object
implements ZeebeClientBuilder, ZeebeClientConfiguration

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_GATEWAY_ADDRESS
static final URI	DEFAULT_GRPC_ADDRESS
static final String	DEFAULT_JOB_WORKER_NAME_VAR
static final Duration	DEFAULT_MESSAGE_TTL
static final URI	DEFAULT_REST_ADDRESS

Constructor Summary

Constructors

Constructor	Description
ZeebeClientBuilderImpl()

Method Summary

Modifier and Type	Method	Description
ZeebeClientBuilder	applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)	Allows to disable the mechanism to override some properties by ENVIRONMENT VARIABLES.
ZeebeClient	build()
ZeebeClientBuilder	caCertificatePath(String certificatePath)	Path to a root CA certificate to be used instead of the certificate in the default default store.
ZeebeClientBuilder	credentialsProvider(CredentialsProvider credentialsProvider)	A custom CredentialsProvider which will be used to apply authentication credentials to requests.
ZeebeClientBuilder	defaultJobPollInterval(Duration pollInterval)	The interval which a job worker is periodically polling for new jobs.
ZeebeClientBuilder	defaultJobTimeout(Duration timeout)	The timeout which is used when none is provided for a job worker.
ZeebeClientBuilder	defaultJobWorkerMaxJobsActive(int maxJobsActive)
ZeebeClientBuilder	defaultJobWorkerName(String workerName)	The name of the worker which is used when none is set for a job worker.
ZeebeClientBuilder	defaultJobWorkerStreamEnabled(boolean streamEnabled)	A custom streamEnabled allows the client to use job stream instead of job poll.
ZeebeClientBuilder	defaultJobWorkerTenantIds(List<String> tenantIds)
ZeebeClientBuilder	defaultMessageTimeToLive(Duration timeToLive)	The time-to-live which is used when none is provided for a message.
ZeebeClientBuilder	defaultRequestTimeout(Duration requestTimeout)	The request timeout used if not overridden by the command.
ZeebeClientBuilder	defaultTenantId(String tenantId)
ZeebeClientBuilder	gatewayAddress(String gatewayAddress)
String	getCaCertificatePath()
List<org.apache.hc.client5.http.async.AsyncExecChainHandler>	getChainHandlers()
CredentialsProvider	getCredentialsProvider()
Duration	getDefaultJobPollInterval()
Duration	getDefaultJobTimeout()
int	getDefaultJobWorkerMaxJobsActive()
String	getDefaultJobWorkerName()
boolean	getDefaultJobWorkerStreamEnabled()
List<String>	getDefaultJobWorkerTenantIds()
Duration	getDefaultMessageTimeToLive()
Duration	getDefaultRequestTimeout()
String	getDefaultTenantId()
String	getGatewayAddress()
URI	getGrpcAddress()
List<io.grpc.ClientInterceptor>	getInterceptors()
JsonMapper	getJsonMapper()
Duration	getKeepAlive()
int	getMaxMessageSize()
int	getMaxMetadataSize()
int	getNumJobWorkerExecutionThreads()
String	getOverrideAuthority()
URI	getRestAddress()
ZeebeClientBuilder	grpcAddress(URI grpcAddress)
boolean	isPlaintextConnectionEnabled()
ScheduledExecutorService	jobWorkerExecutor()
ZeebeClientBuilder	jobWorkerExecutor(ScheduledExecutorService executor, boolean takeOwnership)	Allows passing a custom executor service that will be shared by all job workers created via this client.
ZeebeClientBuilder	keepAlive(Duration keepAlive)	Time interval between keep alive messages sent to the gateway.
ZeebeClientBuilder	maxMessageSize(int maxMessageSize)	A custom maxMessageSize allows the client to receive larger or smaller responses from Zeebe.
ZeebeClientBuilder	maxMetadataSize(int maxMetadataSize)	A custom maxMetadataSize allows the client to receive larger or smaller response headers from Zeebe.
ZeebeClientBuilder	numJobWorkerExecutionThreads(int numSubscriptionThreads)
ZeebeClientBuilder	overrideAuthority(String authority)	Overrides the authority used with TLS virtual hosting.
boolean	ownsJobWorkerExecutor()
boolean	preferRestOverGrpc()
ZeebeClientBuilder	preferRestOverGrpc(boolean preferRestOverGrpc)	If true, will prefer to use REST over gRPC for calls which can be done over both REST and gRPC.
ZeebeClientBuilder	restAddress(URI restAddress)
String	toString()
boolean	useDefaultRetryPolicy()
ZeebeClientBuilder	useDefaultRetryPolicy(boolean useDefaultRetryPolicy)	If enabled, the client will make use of the default retry policy defined.
ZeebeClientBuilder	usePlaintext()	Use a plaintext connection between the client and the gateway.
ZeebeClientBuilder	withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)	Custom implementations of the Apache HttpClient AsyncExecChainHandler middleware API.
ZeebeClientBuilder	withInterceptors(io.grpc.ClientInterceptor... interceptors)	Custom implementations of the gRPC ClientInterceptor middleware API.
ZeebeClientBuilder	withJsonMapper(JsonMapper jsonMapper)
ZeebeClientBuilder	withProperties(Properties properties)	Sets all the properties from a Properties object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.camunda.zeebe.client.ZeebeClientBuilder

jobWorkerExecutor

Field Details

DEFAULT_GATEWAY_ADDRESS

public static final String DEFAULT_GATEWAY_ADDRESS

See Also:

• Constant Field Values

DEFAULT_GRPC_ADDRESS

public static final URI DEFAULT_GRPC_ADDRESS

DEFAULT_REST_ADDRESS

public static final URI DEFAULT_REST_ADDRESS

DEFAULT_JOB_WORKER_NAME_VAR

public static final String DEFAULT_JOB_WORKER_NAME_VAR

See Also:

• Constant Field Values

DEFAULT_MESSAGE_TTL

public static final Duration DEFAULT_MESSAGE_TTL

Constructor Details

ZeebeClientBuilderImpl

public ZeebeClientBuilderImpl()

Method Details

getGatewayAddress

public String getGatewayAddress()

Specified by:

getGatewayAddress in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.grpcAddress(URI)

getRestAddress

public URI getRestAddress()

Specified by:

getRestAddress in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.restAddress(URI)

getGrpcAddress

public URI getGrpcAddress()

Specified by:

getGrpcAddress in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.grpcAddress(URI)

getDefaultTenantId

public String getDefaultTenantId()

Specified by:

getDefaultTenantId in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultTenantId(String)

getDefaultJobWorkerTenantIds

public List<String> getDefaultJobWorkerTenantIds()

Specified by:

getDefaultJobWorkerTenantIds in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobWorkerTenantIds(List)

getNumJobWorkerExecutionThreads

public int getNumJobWorkerExecutionThreads()

Specified by:

getNumJobWorkerExecutionThreads in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.numJobWorkerExecutionThreads(int)

getDefaultJobWorkerMaxJobsActive

public int getDefaultJobWorkerMaxJobsActive()

Specified by:

getDefaultJobWorkerMaxJobsActive in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobWorkerMaxJobsActive(int)

getDefaultJobWorkerName

public String getDefaultJobWorkerName()

Specified by:

getDefaultJobWorkerName in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobWorkerName(String)

getDefaultJobTimeout

public Duration getDefaultJobTimeout()

Specified by:

getDefaultJobTimeout in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobTimeout(Duration)

getDefaultJobPollInterval

public Duration getDefaultJobPollInterval()

Specified by:

getDefaultJobPollInterval in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobPollInterval(Duration)

getDefaultMessageTimeToLive

public Duration getDefaultMessageTimeToLive()

Specified by:

getDefaultMessageTimeToLive in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultMessageTimeToLive(Duration)

getDefaultRequestTimeout

public Duration getDefaultRequestTimeout()

Specified by:

getDefaultRequestTimeout in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultRequestTimeout(Duration)

isPlaintextConnectionEnabled

public boolean isPlaintextConnectionEnabled()

Specified by:

isPlaintextConnectionEnabled in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.usePlaintext()

getCaCertificatePath

public String getCaCertificatePath()

Specified by:

getCaCertificatePath in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.caCertificatePath(String)

getCredentialsProvider

public CredentialsProvider getCredentialsProvider()

Specified by:

getCredentialsProvider in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.credentialsProvider(CredentialsProvider)

getKeepAlive

public Duration getKeepAlive()

Specified by:

getKeepAlive in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.keepAlive(Duration)

getInterceptors

public List<io.grpc.ClientInterceptor> getInterceptors()

Specified by:

getInterceptors in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.withInterceptors(ClientInterceptor...)

getChainHandlers

public List<org.apache.hc.client5.http.async.AsyncExecChainHandler> getChainHandlers()

Specified by:

getChainHandlers in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.withChainHandlers(AsyncExecChainHandler...)

getJsonMapper

public JsonMapper getJsonMapper()

Specified by:

getJsonMapper in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.withJsonMapper(JsonMapper)

getOverrideAuthority

public String getOverrideAuthority()

Specified by:

getOverrideAuthority in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.overrideAuthority(String)

getMaxMessageSize

public int getMaxMessageSize()

Specified by:

getMaxMessageSize in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.maxMessageSize(int)

getMaxMetadataSize

public int getMaxMetadataSize()

Specified by:

getMaxMetadataSize in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.maxMetadataSize(int)

jobWorkerExecutor

public ScheduledExecutorService jobWorkerExecutor()

Specified by:

jobWorkerExecutor in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.jobWorkerExecutor(ScheduledExecutorService)

ownsJobWorkerExecutor

public boolean ownsJobWorkerExecutor()

Specified by:

ownsJobWorkerExecutor in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.jobWorkerExecutor(ScheduledExecutorService, boolean)

getDefaultJobWorkerStreamEnabled

public boolean getDefaultJobWorkerStreamEnabled()

Specified by:

getDefaultJobWorkerStreamEnabled in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.defaultJobWorkerStreamEnabled(boolean)

useDefaultRetryPolicy

public boolean useDefaultRetryPolicy()

Specified by:

useDefaultRetryPolicy in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.useDefaultRetryPolicy(boolean)

preferRestOverGrpc

public boolean preferRestOverGrpc()

Specified by:

preferRestOverGrpc in interface ZeebeClientConfiguration

See Also:

• ZeebeClientBuilder.preferRestOverGrpc(boolean)

withProperties

public ZeebeClientBuilder withProperties(Properties properties)

Description copied from interface: ZeebeClientBuilder

Sets all the properties from a Properties object. Can be used to configure the client from a properties file.

See ClientProperties for valid property names.

Specified by:

withProperties in interface ZeebeClientBuilder

applyEnvironmentVariableOverrides

public ZeebeClientBuilder applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)

Description copied from interface: ZeebeClientBuilder

Allows to disable the mechanism to override some properties by ENVIRONMENT VARIABLES. This is useful if a client shall be constructed for test cases or in an environment that wants to fully control properties (like Spring Boot).

The default value is true.

Specified by:

applyEnvironmentVariableOverrides in interface ZeebeClientBuilder

gatewayAddress

public ZeebeClientBuilder gatewayAddress(String gatewayAddress)

Specified by:

gatewayAddress in interface ZeebeClientBuilder

Parameters:

gatewayAddress - the IP socket address of a gateway that the client can initially connect to. Must be in format host:port. The default value is 0.0.0.0:26500 .

restAddress

public ZeebeClientBuilder restAddress(URI restAddress)

Specified by:

restAddress in interface ZeebeClientBuilder

Parameters:

restAddress - the REST API address of a gateway that the client can connect to. The address must be an absolute URL, including the scheme.

The default value is https://0.0.0.0:8080.

grpcAddress

public ZeebeClientBuilder grpcAddress(URI grpcAddress)

Specified by:

grpcAddress in interface ZeebeClientBuilder

Parameters:

grpcAddress - the gRPC address of a gateway that the client can connect to. The address must be an absolute URL, including the scheme.

The default value is https://0.0.0.0:26500.

defaultTenantId

public ZeebeClientBuilder defaultTenantId(String tenantId)

Specified by:

defaultTenantId in interface ZeebeClientBuilder

Parameters:

tenantId - the tenant identifier which is used for tenant-aware commands when no tenant identifier is set. The default value is CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

defaultJobWorkerTenantIds

public ZeebeClientBuilder defaultJobWorkerTenantIds(List<String> tenantIds)

Specified by:

defaultJobWorkerTenantIds in interface ZeebeClientBuilder

Parameters:

tenantIds - the tenant identifiers which are used for job-activation commands when no tenant identifiers are set. The default value contains only CommandWithTenantStep.DEFAULT_TENANT_IDENTIFIER.

defaultJobWorkerMaxJobsActive

public ZeebeClientBuilder defaultJobWorkerMaxJobsActive(int maxJobsActive)

Specified by:

defaultJobWorkerMaxJobsActive in interface ZeebeClientBuilder

Parameters:

maxJobsActive - Default value for JobWorkerBuilderStep1.JobWorkerBuilderStep3.maxJobsActive(int). Default value is 32.

numJobWorkerExecutionThreads

public ZeebeClientBuilder numJobWorkerExecutionThreads(int numSubscriptionThreads)

Specified by:

numJobWorkerExecutionThreads in interface ZeebeClientBuilder

Parameters:

numSubscriptionThreads - The number of threads for invocation of job workers. Setting this value to 0 effectively disables subscriptions and workers. Default value is 1.

jobWorkerExecutor

public ZeebeClientBuilder jobWorkerExecutor(ScheduledExecutorService executor,
 boolean takeOwnership)

Description copied from interface: ZeebeClientBuilder

Allows passing a custom executor service that will be shared by all job workers created via this client.

Polling and handling jobs (e.g. via JobHandler will all be invoked on this executor.

When non-null, this setting override ZeebeClientBuilder.numJobWorkerExecutionThreads(int).

Specified by:

jobWorkerExecutor in interface ZeebeClientBuilder

Parameters:

executor - an executor service to use when invoking job workers

takeOwnership - if true, the executor will be closed when the client is closed. otherwise, it's up to the caller to manage its lifecycle

defaultJobWorkerName

public ZeebeClientBuilder defaultJobWorkerName(String workerName)

Description copied from interface: ZeebeClientBuilder

The name of the worker which is used when none is set for a job worker. Default is 'default'.

Specified by:

defaultJobWorkerName in interface ZeebeClientBuilder

defaultJobTimeout

public ZeebeClientBuilder defaultJobTimeout(Duration timeout)

Description copied from interface: ZeebeClientBuilder

The timeout which is used when none is provided for a job worker. Default is 5 minutes.

Specified by:

defaultJobTimeout in interface ZeebeClientBuilder

defaultJobPollInterval

public ZeebeClientBuilder defaultJobPollInterval(Duration pollInterval)

Description copied from interface: ZeebeClientBuilder

The interval which a job worker is periodically polling for new jobs. Default is 100 milliseconds.

Specified by:

defaultJobPollInterval in interface ZeebeClientBuilder

defaultMessageTimeToLive

public ZeebeClientBuilder defaultMessageTimeToLive(Duration timeToLive)

Description copied from interface: ZeebeClientBuilder

The time-to-live which is used when none is provided for a message. Default is 1 hour.

Specified by:

defaultMessageTimeToLive in interface ZeebeClientBuilder

defaultRequestTimeout

public ZeebeClientBuilder defaultRequestTimeout(Duration requestTimeout)

Description copied from interface: ZeebeClientBuilder

The request timeout used if not overridden by the command. Default is 10 seconds.

Specified by:

defaultRequestTimeout in interface ZeebeClientBuilder

usePlaintext

public ZeebeClientBuilder usePlaintext()

Description copied from interface: ZeebeClientBuilder

Use a plaintext connection between the client and the gateway.

Specified by:

usePlaintext in interface ZeebeClientBuilder

caCertificatePath

public ZeebeClientBuilder caCertificatePath(String certificatePath)

Description copied from interface: ZeebeClientBuilder

Path to a root CA certificate to be used instead of the certificate in the default default store.

Specified by:

caCertificatePath in interface ZeebeClientBuilder

credentialsProvider

public ZeebeClientBuilder credentialsProvider(CredentialsProvider credentialsProvider)

Description copied from interface: ZeebeClientBuilder

A custom CredentialsProvider which will be used to apply authentication credentials to requests.

Specified by:

credentialsProvider in interface ZeebeClientBuilder

keepAlive

public ZeebeClientBuilder keepAlive(Duration keepAlive)

Description copied from interface: ZeebeClientBuilder

Time interval between keep alive messages sent to the gateway. The default is 45 seconds.

Specified by:

keepAlive in interface ZeebeClientBuilder

withInterceptors

public ZeebeClientBuilder withInterceptors(io.grpc.ClientInterceptor... interceptors)

Description copied from interface: ZeebeClientBuilder

Custom implementations of the gRPC ClientInterceptor middleware API. The interceptors will be applied to every gRPC call that the client makes. More details can be found at invalid input: '{@link https://grpc.io/docs/guides/interceptors/'}.

Specified by:

withInterceptors in interface ZeebeClientBuilder

withChainHandlers

public ZeebeClientBuilder withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)

Description copied from interface: ZeebeClientBuilder

Custom implementations of the Apache HttpClient AsyncExecChainHandler middleware API. The middleware implementations will be called on every REST API call that the client makes.

Specified by:

withChainHandlers in interface ZeebeClientBuilder

withJsonMapper

public ZeebeClientBuilder withJsonMapper(JsonMapper jsonMapper)

Specified by:

withJsonMapper in interface ZeebeClientBuilder

overrideAuthority

public ZeebeClientBuilder overrideAuthority(String authority)

Description copied from interface: ZeebeClientBuilder

Overrides the authority used with TLS virtual hosting. Specifically, to override hostname verification in the TLS handshake. It does not change what host is actually connected to.

This method is intended for testing, but may safely be used outside of tests as an alternative to DNS overrides.

This setting does nothing if a plaintext connection is used.

Specified by:

overrideAuthority in interface ZeebeClientBuilder

Parameters:

authority - The alternative authority to use, commonly in the form host or host:port

maxMessageSize

public ZeebeClientBuilder maxMessageSize(int maxMessageSize)

Description copied from interface: ZeebeClientBuilder

A custom maxMessageSize allows the client to receive larger or smaller responses from Zeebe. Technically, it specifies the maxInboundMessageSize of the gRPC channel. The default is 5242880 = 5MB.

Specified by:

maxMessageSize in interface ZeebeClientBuilder

maxMetadataSize

public ZeebeClientBuilder maxMetadataSize(int maxMetadataSize)

Description copied from interface: ZeebeClientBuilder

A custom maxMetadataSize allows the client to receive larger or smaller response headers from Zeebe. Technically, it specifies the maxInboundMetadataSize of the gRPC channel. The default is 16384 = 16KB .

Specified by:

maxMetadataSize in interface ZeebeClientBuilder

defaultJobWorkerStreamEnabled

public ZeebeClientBuilder defaultJobWorkerStreamEnabled(boolean streamEnabled)

Description copied from interface: ZeebeClientBuilder

A custom streamEnabled allows the client to use job stream instead of job poll. The default value is set as enabled.

Specified by:

defaultJobWorkerStreamEnabled in interface ZeebeClientBuilder

useDefaultRetryPolicy

public ZeebeClientBuilder useDefaultRetryPolicy(boolean useDefaultRetryPolicy)

Description copied from interface: ZeebeClientBuilder

If enabled, the client will make use of the default retry policy defined. False by default.

NOTE: the default retry policy is taken from the gateway-service-config.json in the io.camunda:zeebe-gateway-protocol-impl JAR.

Specified by:

useDefaultRetryPolicy in interface ZeebeClientBuilder

preferRestOverGrpc

public ZeebeClientBuilder preferRestOverGrpc(boolean preferRestOverGrpc)

Description copied from interface: ZeebeClientBuilder

If true, will prefer to use REST over gRPC for calls which can be done over both REST and gRPC. This is an experimental API which is present while we migrate the bulk of the API from gRPC to REST. Once done, this will also be removed.

NOTE: not all calls can be done over REST (or HTTP/1) yet, this is also subject to change.

Specified by:

preferRestOverGrpc in interface ZeebeClientBuilder

Parameters:

preferRestOverGrpc - if true, the client will use REST instead of gRPC whenever possible

Returns:

this builder for chaining

build

public ZeebeClient build()

Specified by:

build in interface ZeebeClientBuilder

Returns:

a new ZeebeClient with the provided configuration options.

toString

public String toString()

Overrides:

toString in class Object