Package io.camunda.zeebe.client.impl.command

Class DeployResourceCommandImpl

java.lang.Object

io.camunda.zeebe.client.impl.command.DeployResourceCommandImpl

All Implemented Interfaces:

CommandWithTenantStep<DeployResourceCommandStep1.DeployResourceCommandStep2>, DeployResourceCommandStep1, DeployResourceCommandStep1.DeployResourceCommandStep2, FinalCommandStep<DeploymentEvent>

public final class DeployResourceCommandImpl
extends Object
implements DeployResourceCommandStep1, DeployResourceCommandStep1.DeployResourceCommandStep2

Nested Class Summary

Nested classes/interfaces inherited from interface io.camunda.zeebe.client.api.command.DeployResourceCommandStep1

DeployResourceCommandStep1.DeployResourceCommandStep2

Field Summary

Fields inherited from interface io.camunda.zeebe.client.api.command.CommandWithTenantStep

DEFAULT_TENANT_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
DeployResourceCommandImpl(GatewayGrpc.GatewayStub asyncStub, ZeebeClientConfiguration config, Predicate<Throwable> retryPredicate)
DeployResourceCommandImpl(GatewayGrpc.GatewayStub asyncStub, Duration requestTimeout, Predicate<Throwable> retryPredicate)	Deprecated. since 8.3.0, use DeployResourceCommandImpl(GatewayStub asyncStub, ZeebeClientConfiguration config, Predicate retryPredicate)

Method Summary

Modifier and Type	Method	Description
DeployResourceCommandStep1.DeployResourceCommandStep2	addProcessModel(BpmnModelInstance processDefinition, String resourceName)	Add the given process as resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceBytes(byte[] resource, String resourceName)	Add the given resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceFile(String filename)	Add the given resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceFromClasspath(String classpathResource)	Add the given resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceStream(InputStream resourceStream, String resourceName)	Add the given resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceString(String resource, Charset charset, String resourceName)	Add the given resource to the deployment.
DeployResourceCommandStep1.DeployResourceCommandStep2	addResourceStringUtf8(String resourceString, String resourceName)	Add the given resource to the deployment.
FinalCommandStep<DeploymentEvent>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
ZeebeFuture<DeploymentEvent>	send()	Sends the command to the Zeebe broker.
DeployResourceCommandStep1.DeployResourceCommandStep2	tenantId(String tenantId)	Experimental: This method is under development, and as such using it may have no effect on the command builder when called.

Methods inherited from class java.lang.Object

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

Constructor Details

DeployResourceCommandImpl

public DeployResourceCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 ZeebeClientConfiguration config,
 Predicate<Throwable> retryPredicate)

DeployResourceCommandImpl

@Deprecated
public DeployResourceCommandImpl(GatewayGrpc.GatewayStub asyncStub,
 Duration requestTimeout,
 Predicate<Throwable> retryPredicate)

Deprecated.

since 8.3.0, use DeployResourceCommandImpl(GatewayStub asyncStub, ZeebeClientConfiguration config, Predicate retryPredicate)

A constructor that provides an instance with the tenantId set.

From version 8.3.0, the java client supports multi-tenancy for this command, which requires the tenantId property to be defined. This constructor is only intended for backwards compatibility in tests.

Method Details

addResourceBytes

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceBytes(byte[] resource,
 String resourceName)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceBytes in interface DeployResourceCommandStep1

Parameters:

resource - the resource content as byte array

resourceName - the name of the resource (e.g. "process.bpmn" or "decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addResourceString

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceString(String resource,
 Charset charset,
 String resourceName)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceString in interface DeployResourceCommandStep1

Parameters:

resource - the resource content as String

charset - the charset of the String

resourceName - the name of the resource (e.g. "process.bpmn" or "decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addResourceStringUtf8

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceStringUtf8(String resourceString,
 String resourceName)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceStringUtf8 in interface DeployResourceCommandStep1

Parameters:

resourceString - the resource content as UTF-8-encoded String

resourceName - the name of the resource (e.g. "process.bpmn" or "decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addResourceStream

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceStream(InputStream resourceStream,
 String resourceName)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceStream in interface DeployResourceCommandStep1

Parameters:

resourceStream - the resource content as stream

resourceName - the name of the resource (e.g. "process.bpmn" or "decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addResourceFromClasspath

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceFromClasspath(String classpathResource)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceFromClasspath in interface DeployResourceCommandStep1

Parameters:

classpathResource - the path of the resource file in the classpath (e.g. "wf/process.bpmn" or "dmn/decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addResourceFile

public DeployResourceCommandStep1.DeployResourceCommandStep2 addResourceFile(String filename)

Description copied from interface: DeployResourceCommandStep1

Add the given resource to the deployment.

Specified by:

addResourceFile in interface DeployResourceCommandStep1

Parameters:

filename - the absolute path of the resource file (e.g. "~/wf/process.bpmn" or "~/dmn/decision.dmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

addProcessModel

public DeployResourceCommandStep1.DeployResourceCommandStep2 addProcessModel(BpmnModelInstance processDefinition,
 String resourceName)

Description copied from interface: DeployResourceCommandStep1

Add the given process as resource to the deployment.

Specified by:

addProcessModel in interface DeployResourceCommandStep1

Parameters:

processDefinition - the process as model

resourceName - the name of the resource (e.g. "process.bpmn")

Returns:

the builder for this command. Call #send() to complete the command and send it to the broker.

requestTimeout

public FinalCommandStep<DeploymentEvent> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

Sets the request timeout for the command. The default request timeout can be configured using ZeebeClientBuilder.defaultRequestTimeout(Duration).

Specified by:

requestTimeout in interface FinalCommandStep<DeploymentEvent>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public ZeebeFuture<DeploymentEvent> send()

Description copied from interface: FinalCommandStep

Sends the command to the Zeebe broker. This operation is asynchronous. In case of success, the future returns the event that was generated by the Zeebe broker in response to the command.

Call ZeebeFuture.join() to wait until the response is available.

 Future<JobEvent&#62 future = command.send();
 JobEvent event = future.join();
 

Specified by:

send in interface FinalCommandStep<DeploymentEvent>

Returns:

a future tracking state of success/failure of the command.

tenantId

public DeployResourceCommandStep1.DeployResourceCommandStep2 tenantId(String tenantId)

Description copied from interface: CommandWithTenantStep

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.

Specified by:

tenantId in interface CommandWithTenantStep<DeployResourceCommandStep1.DeployResourceCommandStep2>

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