Package io.camunda.client.impl

Class CamundaClientCloudBuilderImpl

java.lang.Object

io.camunda.client.impl.CamundaClientCloudBuilderImpl

All Implemented Interfaces:

CamundaClientBuilder, CamundaClientCloudBuilderStep1, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4

public class CamundaClientCloudBuilderImpl
extends Object
implements CamundaClientCloudBuilderStep1, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3, CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.client.CamundaClientCloudBuilderStep1

CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2

Nested classes/interfaces inherited from interface io.camunda.client.CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2

CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3

Nested classes/interfaces inherited from interface io.camunda.client.CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3

CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4

Constructor Summary

Constructors

Constructor	Description
CamundaClientCloudBuilderImpl()

Method Summary

Modifier and Type	Method	Description
CamundaClientBuilder	applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)	Allows to disable the mechanism to override some properties by ENVIRONMENT VARIABLES.
CamundaClient	build()
CamundaClientBuilder	caCertificatePath(String certificatePath)	Path to a root CA certificate to be used instead of the certificate in the default default store.
CamundaClientBuilder	credentialsProvider(CredentialsProvider credentialsProvider)	A custom CredentialsProvider which will be used to apply authentication credentials to requests.
CamundaClientBuilder	defaultJobPollInterval(Duration pollInterval)	The interval which a job worker is periodically polling for new jobs.
CamundaClientBuilder	defaultJobTimeout(Duration timeout)	The timeout which is used when none is provided for a job worker.
CamundaClientBuilder	defaultJobWorkerMaxJobsActive(int maxJobsActive)
CamundaClientBuilder	defaultJobWorkerName(String workerName)	The name of the worker which is used when none is set for a job worker.
CamundaClientBuilder	defaultJobWorkerStreamEnabled(boolean streamEnabled)	A custom streamEnabled allows the client to use job stream instead of job poll.
CamundaClientBuilder	defaultJobWorkerTenantIds(List<String> tenantIds)
CamundaClientBuilder	defaultMessageTimeToLive(Duration timeToLive)	The time-to-live which is used when none is provided for a message.
CamundaClientBuilder	defaultRequestTimeout(Duration requestTimeout)	The request timeout used if not overridden by the command.
CamundaClientBuilder	defaultRequestTimeoutOffset(Duration requestTimeoutOffset)	The request timeout client offset is used in commands where the CamundaClientBuilder.defaultRequestTimeout(Duration) is also passed to the server.
CamundaClientBuilder	defaultTenantId(String tenantId)
CamundaClientBuilder	gatewayAddress(String gatewayAddress)
CamundaClientBuilder	grpcAddress(URI grpcAddress)
CamundaClientBuilder	jobWorkerExecutor(ScheduledExecutorService executor, boolean takeOwnership)	Allows passing a custom executor service that will be shared by all job workers created via this client.
CamundaClientBuilder	keepAlive(Duration keepAlive)	Time interval between keep alive messages sent to the gateway.
CamundaClientBuilder	maxMessageSize(int maxMessageSize)	A custom maxMessageSize allows the client to receive larger or smaller responses from Camunda.
CamundaClientBuilder	maxMetadataSize(int maxMetadataSize)	A custom maxMetadataSize allows the client to receive larger or smaller response headers from Camunda.
CamundaClientBuilder	numJobWorkerExecutionThreads(int numThreads)
CamundaClientBuilder	overrideAuthority(String authority)	Overrides the authority used with TLS virtual hosting.
CamundaClientBuilder	preferRestOverGrpc(boolean preferRestOverGrpc)	If true, will prefer to use REST over gRPC for calls which can be done over both REST and gRPC.
CamundaClientBuilder	restAddress(URI restAddress)
String	toString()
CamundaClientBuilder	useDefaultRetryPolicy(boolean useDefaultRetryPolicy)	If enabled, the client will make use of the default retry policy defined.
CamundaClientBuilder	usePlaintext()	Use a plaintext connection between the client and the gateway.
CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4	withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)	Custom implementations of the Apache HttpClient AsyncExecChainHandler middleware API.
CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3	withClientId(String clientId)	Sets the client id that will be used to authenticate against the Camunda Cloud cluster.
CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4	withClientSecret(String clientSecret)	Sets the client secret that will be used to authenticate against the Camunda Cloud cluster.
CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2	withClusterId(String clusterId)	Sets the cluster id of the Camunda Cloud cluster.
CamundaClientBuilder	withInterceptors(io.grpc.ClientInterceptor... interceptor)	Custom implementations of the gRPC ClientInterceptor middleware API.
CamundaClientBuilder	withJsonMapper(JsonMapper jsonMapper)
CamundaClientBuilder	withProperties(Properties properties)	Sets all the properties from a Properties object.
CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4	withRegion(String region)	Sets the region of the Camunda Cloud cluster.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.CamundaClientBuilder

jobWorkerExecutor

Constructor Details

CamundaClientCloudBuilderImpl

public CamundaClientCloudBuilderImpl()

Method Details

withClusterId

public CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2 withClusterId(String clusterId)

Description copied from interface: CamundaClientCloudBuilderStep1

Sets the cluster id of the Camunda Cloud cluster. This parameter is mandatory.

Specified by:

withClusterId in interface CamundaClientCloudBuilderStep1

Parameters:

clusterId - cluster id of the Camunda Cloud cluster.

withClientId

public CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3 withClientId(String clientId)

Description copied from interface: CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2

Sets the client id that will be used to authenticate against the Camunda Cloud cluster. This parameter is mandatory.

Specified by:

withClientId in interface CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2

Parameters:

clientId - client id that will be used in the authentication.

withClientSecret

public CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4 withClientSecret(String clientSecret)

Description copied from interface: CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3

Sets the client secret that will be used to authenticate against the Camunda Cloud cluster. This parameter is mandatory.

Specified by:

withClientSecret in interface CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3

Parameters:

clientSecret - client secret that will be used in the authentication.

withRegion

public CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4 withRegion(String region)

Description copied from interface: CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4

Sets the region of the Camunda Cloud cluster. Default is 'bru-2'.

Specified by:

withRegion in interface CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4

Parameters:

region - region of the Camunda Cloud cluster

withProperties

public CamundaClientBuilder withProperties(Properties properties)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

applyEnvironmentVariableOverrides

public CamundaClientBuilder applyEnvironmentVariableOverrides(boolean applyEnvironmentVariableOverrides)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

gatewayAddress

public CamundaClientBuilder gatewayAddress(String gatewayAddress)

Specified by:

gatewayAddress in interface CamundaClientBuilder

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 CamundaClientBuilder restAddress(URI restAddress)

Specified by:

restAddress in interface CamundaClientBuilder

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 CamundaClientBuilder grpcAddress(URI grpcAddress)

Specified by:

grpcAddress in interface CamundaClientBuilder

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

@ExperimentalApi("https://github.com/camunda/camunda/issues/14106")
public CamundaClientBuilder defaultTenantId(String tenantId)

Specified by:

defaultTenantId in interface CamundaClientBuilder

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

@ExperimentalApi("https://github.com/camunda/camunda/issues/14106")
public CamundaClientBuilder defaultJobWorkerTenantIds(List<String> tenantIds)

Specified by:

defaultJobWorkerTenantIds in interface CamundaClientBuilder

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 CamundaClientBuilder defaultJobWorkerMaxJobsActive(int maxJobsActive)

Specified by:

defaultJobWorkerMaxJobsActive in interface CamundaClientBuilder

Parameters:

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

numJobWorkerExecutionThreads

public CamundaClientBuilder numJobWorkerExecutionThreads(int numThreads)

Specified by:

numJobWorkerExecutionThreads in interface CamundaClientBuilder

Parameters:

numThreads - 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 CamundaClientBuilder jobWorkerExecutor(ScheduledExecutorService executor,
 boolean takeOwnership)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder.numJobWorkerExecutionThreads(int).

Specified by:

jobWorkerExecutor in interface CamundaClientBuilder

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 CamundaClientBuilder defaultJobWorkerName(String workerName)

Description copied from interface: CamundaClientBuilder

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

Specified by:

defaultJobWorkerName in interface CamundaClientBuilder

defaultJobTimeout

public CamundaClientBuilder defaultJobTimeout(Duration timeout)

Description copied from interface: CamundaClientBuilder

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

Specified by:

defaultJobTimeout in interface CamundaClientBuilder

defaultJobPollInterval

public CamundaClientBuilder defaultJobPollInterval(Duration pollInterval)

Description copied from interface: CamundaClientBuilder

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

Specified by:

defaultJobPollInterval in interface CamundaClientBuilder

defaultMessageTimeToLive

public CamundaClientBuilder defaultMessageTimeToLive(Duration timeToLive)

Description copied from interface: CamundaClientBuilder

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

Specified by:

defaultMessageTimeToLive in interface CamundaClientBuilder

defaultRequestTimeout

public CamundaClientBuilder defaultRequestTimeout(Duration requestTimeout)

Description copied from interface: CamundaClientBuilder

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

Specified by:

defaultRequestTimeout in interface CamundaClientBuilder

defaultRequestTimeoutOffset

public CamundaClientBuilder defaultRequestTimeoutOffset(Duration requestTimeoutOffset)

Description copied from interface: CamundaClientBuilder

The request timeout client offset is used in commands where the CamundaClientBuilder.defaultRequestTimeout(Duration) is also passed to the server. This ensures that the client timeout does not occur before the server timeout.

The client-side timeout for these commands is calculated as the sum of defaultRequestTimeout and defaultRequestTimeoutOffset.

Default is 1 second.

Specified by:

defaultRequestTimeoutOffset in interface CamundaClientBuilder

usePlaintext

public CamundaClientBuilder usePlaintext()

Description copied from interface: CamundaClientBuilder

Use a plaintext connection between the client and the gateway.

Specified by:

usePlaintext in interface CamundaClientBuilder

caCertificatePath

public CamundaClientBuilder caCertificatePath(String certificatePath)

Description copied from interface: CamundaClientBuilder

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

Specified by:

caCertificatePath in interface CamundaClientBuilder

credentialsProvider

public CamundaClientBuilder credentialsProvider(CredentialsProvider credentialsProvider)

Description copied from interface: CamundaClientBuilder

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

Specified by:

credentialsProvider in interface CamundaClientBuilder

keepAlive

public CamundaClientBuilder keepAlive(Duration keepAlive)

Description copied from interface: CamundaClientBuilder

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

Specified by:

keepAlive in interface CamundaClientBuilder

withInterceptors

public CamundaClientBuilder withInterceptors(io.grpc.ClientInterceptor... interceptor)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

withChainHandlers

public CamundaClientCloudBuilderStep1.CamundaClientCloudBuilderStep2.CamundaClientCloudBuilderStep3.CamundaClientCloudBuilderStep4 withChainHandlers(org.apache.hc.client5.http.async.AsyncExecChainHandler... chainHandler)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

withJsonMapper

public CamundaClientBuilder withJsonMapper(JsonMapper jsonMapper)

Specified by:

withJsonMapper in interface CamundaClientBuilder

overrideAuthority

public CamundaClientBuilder overrideAuthority(String authority)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

Parameters:

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

maxMessageSize

public CamundaClientBuilder maxMessageSize(int maxMessageSize)

Description copied from interface: CamundaClientBuilder

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

Specified by:

maxMessageSize in interface CamundaClientBuilder

maxMetadataSize

public CamundaClientBuilder maxMetadataSize(int maxMetadataSize)

Description copied from interface: CamundaClientBuilder

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

Specified by:

maxMetadataSize in interface CamundaClientBuilder

defaultJobWorkerStreamEnabled

public CamundaClientBuilder defaultJobWorkerStreamEnabled(boolean streamEnabled)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

useDefaultRetryPolicy

public CamundaClientBuilder useDefaultRetryPolicy(boolean useDefaultRetryPolicy)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

preferRestOverGrpc

public CamundaClientBuilder preferRestOverGrpc(boolean preferRestOverGrpc)

Description copied from interface: CamundaClientBuilder

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 CamundaClientBuilder

Parameters:

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

Returns:

this builder for chaining

build

public CamundaClient build()

Specified by:

build in interface CamundaClientBuilder

Returns:

a new CamundaClient with the provided configuration options.

toString

public String toString()

Overrides:

toString in class Object