Package io.camunda.client.impl.command

Class CorrelateMessageCommandImpl

java.lang.Object

io.camunda.client.impl.command.CommandWithVariables<CorrelateMessageCommandImpl>

io.camunda.client.impl.command.CorrelateMessageCommandImpl

All Implemented Interfaces:

CommandWithTenantStep<CorrelateMessageCommandStep1.CorrelateMessageCommandStep3>, CorrelateMessageCommandStep1, CorrelateMessageCommandStep1.CorrelateMessageCommandStep2, CorrelateMessageCommandStep1.CorrelateMessageCommandStep3, FinalCommandStep<CorrelateMessageResponse>

public class CorrelateMessageCommandImpl
extends CommandWithVariables<CorrelateMessageCommandImpl>
implements CorrelateMessageCommandStep1, CorrelateMessageCommandStep1.CorrelateMessageCommandStep2, CorrelateMessageCommandStep1.CorrelateMessageCommandStep3

Nested Class Summary

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

CorrelateMessageCommandStep1.CorrelateMessageCommandStep2, CorrelateMessageCommandStep1.CorrelateMessageCommandStep3

Field Summary

Fields inherited from class io.camunda.client.impl.command.CommandWithVariables

objectMapper

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

DEFAULT_TENANT_IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
CorrelateMessageCommandImpl(HttpClient httpClient, JsonMapper jsonMapper)

Method Summary

Modifier and Type	Method	Description
CorrelateMessageCommandStep1.CorrelateMessageCommandStep3	correlationKey(String correlationKey)	Set the value of the correlation key of the message.
CorrelateMessageCommandStep1.CorrelateMessageCommandStep2	messageName(String messageName)	Set the name of the message.
FinalCommandStep<CorrelateMessageResponse>	requestTimeout(Duration requestTimeout)	Sets the request timeout for the command.
CamundaFuture<CorrelateMessageResponse>	send()	Sends the command to the Camunda gateway.
protected CorrelateMessageCommandImpl	setVariablesInternal(String variables)
CorrelateMessageCommandStep1.CorrelateMessageCommandStep3	tenantId(String tenantId)	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.
CorrelateMessageCommandStep1.CorrelateMessageCommandStep3	withoutCorrelationKey()	Skip specifying a correlation key for the message.

Methods inherited from class io.camunda.client.impl.command.CommandWithVariables

variable, variables, variables, variables, variables

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.camunda.client.api.command.CorrelateMessageCommandStep1.CorrelateMessageCommandStep3

variable, variables, variables, variables, variables

Constructor Details

CorrelateMessageCommandImpl

public CorrelateMessageCommandImpl(HttpClient httpClient,
 JsonMapper jsonMapper)

Method Details

messageName

public CorrelateMessageCommandStep1.CorrelateMessageCommandStep2 messageName(String messageName)

Description copied from interface: CorrelateMessageCommandStep1

Set the name of the message.

Specified by:

messageName in interface CorrelateMessageCommandStep1

Parameters:

messageName - the name of the message

Returns:

the builder for this command

tenantId

public CorrelateMessageCommandStep1.CorrelateMessageCommandStep3 tenantId(String tenantId)

Description copied from interface: CommandWithTenantStep

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 Camunda 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 Camunda 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<CorrelateMessageCommandStep1.CorrelateMessageCommandStep3>

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

correlationKey

public CorrelateMessageCommandStep1.CorrelateMessageCommandStep3 correlationKey(String correlationKey)

Description copied from interface: CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

Set the value of the correlation key of the message.

This value will be used together with the message name to find matching message subscriptions.

Specified by:

correlationKey in interface CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

Parameters:

correlationKey - the correlation key value of the message

Returns:

the builder for this command

withoutCorrelationKey

public CorrelateMessageCommandStep1.CorrelateMessageCommandStep3 withoutCorrelationKey()

Description copied from interface: CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

Skip specifying a correlation key for the message.

This method allows the message to be correlated without a correlation key, making it suitable for scenarios where the correlation key is not necessary (e.g. for the message start event). When used, this will create a new process instance without checking for an active instance with the same correlation key.

Specified by:

withoutCorrelationKey in interface CorrelateMessageCommandStep1.CorrelateMessageCommandStep2

Returns:

the builder for this command, continuing to the next step without a correlation key.

requestTimeout

public FinalCommandStep<CorrelateMessageResponse> requestTimeout(Duration requestTimeout)

Description copied from interface: FinalCommandStep

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

Specified by:

requestTimeout in interface FinalCommandStep<CorrelateMessageResponse>

Parameters:

requestTimeout - the request timeout

Returns:

the configured command

send

public CamundaFuture<CorrelateMessageResponse> send()

Description copied from interface: FinalCommandStep

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

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

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

Specified by:

send in interface FinalCommandStep<CorrelateMessageResponse>

Returns:

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

setVariablesInternal

protected CorrelateMessageCommandImpl setVariablesInternal(String variables)

Specified by:

setVariablesInternal in class CommandWithVariables<CorrelateMessageCommandImpl>