Package io.taktx.client

Class TaktClient

java.lang.Object

io.taktx.client.TaktClient

public class TaktClient
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TaktClient.TaktClientBuilder	Builder class for creating TaktClient instances.

Method Summary

Modifier and Type	Method	Description
UserTaskInstanceResponder	completeUserTask(io.taktx.dto.UserTaskTriggerDTO userTaskTriggerDTO)	Completes a user task.
io.taktx.dto.ParsedDefinitionsDTO	deployProcessDefinition(InputStream inputStream)	Deploys a process definition from an InputStream.
void	deployTaktDeploymentAnnotatedClasses()	Deploys process definitions from classes annotated with @TaktDeployment.
Optional<io.taktx.dto.ProcessDefinitionDTO>	getProcessDefinitionByHash(String processDefinitionId, String hash)	Retrieves a process definition by its ID.
static TaktClient.TaktClientBuilder	newClientBuilder()	Creates a new TaktClientBuilder instance to create a new TaktClient.
void	registerExternalTaskConsumer(ExternalTaskTriggerConsumer externalTaskTriggerConsumer)
void	registerInstanceUpdateConsumer(BiConsumer<UUID,io.taktx.dto.InstanceUpdateDTO> consumer)	Registers a consumer for process instance updates.
void	registerUserTaskConsumer(UserTaskTriggerConsumer userTaskTriggerConsumer)
String	requestExternalTaskTopic(String externalTaskId, int partitions, io.taktx.CleanupPolicy cleanupPolicy)
ExternalTaskInstanceResponder	respondToExternalTask(io.taktx.dto.ExternalTaskTriggerDTO externalTaskTriggerDTO)	Responds to an external task trigger.
void	sendMessage(io.taktx.dto.MessageEventDTO messageEventDTO)	Sends a message event to the engine.
void	start()	Starts the TaktClient, which subscribes to process definition records and process definition updates.
UUID	startProcess(String process, io.taktx.dto.VariablesDTO variables)	Starts a process instance with the given process definition ID and variables.
void	stop()	Stops the TaktClient, which unsubscribes from process definition records and process
void	terminateElementInstance(UUID processInstanceKey)	Terminates a process instance.
void	terminateElementInstance(UUID activeProcessInstanceKey, List<Long> elementInstanceIdPath)	Terminates an element instance within a process instance

Methods inherited from class java.lang.Object

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

Method Details

newClientBuilder

public static TaktClient.TaktClientBuilder newClientBuilder()

Creates a new TaktClientBuilder instance to create a new TaktClient.

Returns:

A new TaktClientBuilder instance.

start

public void start()

Starts the TaktClient, which subscribes to process definition records and process definition updates.

stop

public void stop()

Stops the TaktClient, which unsubscribes from process definition records and process

requestExternalTaskTopic

public String requestExternalTaskTopic(String externalTaskId,
 int partitions,
 io.taktx.CleanupPolicy cleanupPolicy)

deployProcessDefinition

public io.taktx.dto.ParsedDefinitionsDTO deployProcessDefinition(InputStream inputStream)
                                                          throws IOException

Deploys a process definition from an InputStream.

Parameters:

inputStream - The InputStream containing the process definition XML.

Returns:

The parsed definitions DTO.

Throws:

IOException - If an error occurs while reading the InputStream.

getProcessDefinitionByHash

public Optional<io.taktx.dto.ProcessDefinitionDTO> getProcessDefinitionByHash(String processDefinitionId,
 String hash)

Retrieves a process definition by its ID.

startProcess

public UUID startProcess(String process,
 io.taktx.dto.VariablesDTO variables)

Starts a process instance with the given process definition ID and variables.

sendMessage

public void sendMessage(io.taktx.dto.MessageEventDTO messageEventDTO)

Sends a message event to the engine.

registerInstanceUpdateConsumer

public void registerInstanceUpdateConsumer(BiConsumer<UUID,io.taktx.dto.InstanceUpdateDTO> consumer)

Registers a consumer for process instance updates.

deployTaktDeploymentAnnotatedClasses

public void deployTaktDeploymentAnnotatedClasses()

Deploys process definitions from classes annotated with @TaktDeployment.

respondToExternalTask

public ExternalTaskInstanceResponder respondToExternalTask(io.taktx.dto.ExternalTaskTriggerDTO externalTaskTriggerDTO)

Responds to an external task trigger.

completeUserTask

public UserTaskInstanceResponder completeUserTask(io.taktx.dto.UserTaskTriggerDTO userTaskTriggerDTO)

Completes a user task.

terminateElementInstance

public void terminateElementInstance(UUID processInstanceKey)

Terminates a process instance.

terminateElementInstance

public void terminateElementInstance(UUID activeProcessInstanceKey,
 List<Long> elementInstanceIdPath)

Terminates an element instance within a process instance

registerExternalTaskConsumer

public void registerExternalTaskConsumer(ExternalTaskTriggerConsumer externalTaskTriggerConsumer)

registerUserTaskConsumer

public void registerUserTaskConsumer(UserTaskTriggerConsumer userTaskTriggerConsumer)