Index

A B C D E F G I M N P R S T U V W X 
All Classes and Interfaces|All Packages

A

abortElementInstance(UUID) - Method in class io.taktx.client.TaktClient
Terminates a process instance.
abortElementInstance(UUID, List<Long>) - Method in class io.taktx.client.ProcessInstanceProducer
Aborts a specific element instance within a process instance by sending an AbortTriggerDTO to the configured Kafka topic.
abortElementInstance(UUID, List<Long>) - Method in class io.taktx.client.TaktClient
Aborts a specific element instance within a process instance.
abortProcessInstance(UUID) - Method in class io.taktx.client.ProcessInstanceProducer
Aborts a process instance by sending an AbortTriggerDTO to the configured Kafka topic.
accept(UserTaskTriggerDTO) - Method in interface io.taktx.client.UserTaskTriggerConsumer
Accepts a UserTaskTriggerDTO object for processing.
acceptBatch(List<ExternalTaskTriggerDTO>) - Method in class io.taktx.client.AnnotationScanningExternalTaskTriggerConsumer
 
acceptBatch(List<ExternalTaskTriggerDTO>) - Method in interface io.taktx.client.ExternalTaskTriggerConsumer
Accepts a batch of ExternalTaskTriggerDTOs for processing.
AnnotationScanner - Class in io.taktx.client
Utility class for scanning classes and methods annotated with specific annotations using ClassGraph.
AnnotationScanningExternalTaskTriggerConsumer - Class in io.taktx.client
An ExternalTaskTriggerConsumer that scans for methods annotated with @TaktWorkerMethod and invokes them when an external task is received.
AnnotationScanningExternalTaskTriggerConsumer(TaktParameterResolverFactory, ProcessInstanceResponder) - Constructor for class io.taktx.client.AnnotationScanningExternalTaskTriggerConsumer
Constructor
autoComplete() - Element in annotation interface io.taktx.client.annotation.TaktWorkerMethod
Whether the task should be auto-completed after execution.

B

build() - Method in class io.taktx.client.TaktClient.TaktClientBuilder
Builds and returns a TaktClient instance.

C

completeUserTask(UserTaskTriggerDTO) - Method in class io.taktx.client.TaktClient
Completes a user task.
create(Parameter) - Method in class io.taktx.client.DefaultTaktParameterResolverFactory
 
create(Parameter) - Method in interface io.taktx.client.TaktParameterResolverFactory
Creates a TaktParameterResolver for the given method parameter.

D

DefaultTaktParameterResolverFactory - Class in io.taktx.client
Default implementation of TaktParameterResolverFactory that creates parameter resolvers based on parameter types and annotations.
DefaultTaktParameterResolverFactory(ProcessInstanceResponder) - Constructor for class io.taktx.client.DefaultTaktParameterResolverFactory
Constructor for DefaultTaktParameterResolverFactory.
deployInputStream(String) - Method in class io.taktx.client.ProcessDefinitionDeployer
Deploys a BPMN XML string by parsing it and sending the parsed definitions to a Kafka topic.
Deployment - Annotation Interface in io.taktx.client.annotation
Marks a class whose referenced BPMN resources should be deployed automatically at client startup.
deployProcessDefinition(InputStream) - Method in class io.taktx.client.TaktClient
Deploys a process definition from an InputStream.
deployResource(String) - Method in class io.taktx.client.ProcessDefinitionDeployer
 
deployTaktDeploymentAnnotatedClasses() - Method in class io.taktx.client.TaktClient
Deploys all classes annotated with @TaktDeployment found in the classpath.

E

ExternalTaskInstanceResponder - Class in io.taktx.client
A responder for handling external task instances, allowing to send success, error, escalation, or promise responses back to the process engine via Kafka.
ExternalTaskInstanceResponder(KafkaProducer<UUID, ContinueFlowElementTriggerDTO>, String, UUID, List<Long>) - Constructor for class io.taktx.client.ExternalTaskInstanceResponder
Constructs an ExternalTaskInstanceResponder.
ExternalTaskInstanceResponderParameterResolver - Class in io.taktx.client
A parameter resolver that provides an ExternalTaskInstanceResponder for handling external task instances.
ExternalTaskInstanceResponderParameterResolver(ProcessInstanceResponder) - Constructor for class io.taktx.client.ExternalTaskInstanceResponderParameterResolver
Constructor for ExternalTaskInstanceResponderParameterResolver.
ExternalTaskTriggerConsumer - Interface in io.taktx.client
An interface for consuming batches of ExternalTaskTriggerDTOs associated with specific job IDs.
ExternalTaskTriggerDTOParameterResolver - Class in io.taktx.client
A parameter resolver that directly provides the ExternalTaskTriggerDTO.
ExternalTaskTriggerDTOParameterResolver() - Constructor for class io.taktx.client.ExternalTaskTriggerDTOParameterResolver
Constructs a new ExternalTaskTriggerDTOParameterResolver.
ExternalTaskTriggerJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for ExternalTaskTriggerDTO objects.
ExternalTaskTriggerJsonDeserializer() - Constructor for class io.taktx.client.serdes.ExternalTaskTriggerJsonDeserializer
Constructor for ExternalTaskTriggerJsonDeserializer.
ExternalTaskTriggerTopicConsumer - Class in io.taktx.client
A Kafka consumer that subscribes to external task trigger topics and processes incoming messages using the provided ExternalTaskTriggerConsumer.

F

findClassesWithAnnotatedMethods(Class<?>) - Static method in class io.taktx.client.AnnotationScanner
Finds all classes that have at least one method annotated with the specified annotation.
findTaktDeployments() - Static method in class io.taktx.client.AnnotationScanner
Finds all classes annotated with the @TaktDeployment annotation, excluding proxy classes.

G

getDeployedProcessDefinitionbyHash(String, String) - Method in class io.taktx.client.ProcessDefinitionConsumer
Retrieves a deployed process definition by its process definition ID and hash.
getDeployedProcessDefinitions() - Method in class io.taktx.client.ProcessDefinitionConsumer
Retrieves the map of deployed process definitions.
getDeployedProcessDefinitions(String) - Method in class io.taktx.client.ProcessDefinitionConsumer
Retrieves the deployed process definitions for a specific process definition ID.
getFileSystemResources(String) - Static method in class io.taktx.client.ResourceScanner
 
getInstance(Class<T>) - Static method in class io.taktx.client.InstanceProvider
Get an instance of the specified class based on the runtime environment.
getJobIds() - Method in class io.taktx.client.AnnotationScanningExternalTaskTriggerConsumer
 
getJobIds() - Method in interface io.taktx.client.ExternalTaskTriggerConsumer
Retrieves the set of job IDs that this consumer is interested in.
getProcessDefinitionByHash(String, String) - Method in class io.taktx.client.TaktClient
Retrieves a deployed process definition by its ID and hash.
getProcessDefinitionXml(ProcessDefinitionKey) - Method in class io.taktx.client.TaktClient
Retrieves the XML of a process definition by its key.
getProcessDefinitionXml(ProcessDefinitionKey) - Method in class io.taktx.client.XmlByProcessDefinitionIdConsumer
Retrieves the process definition XML for the given process definition key.
getResources(String) - Static method in class io.taktx.client.ResourceScanner
 

I

InstanceProvider - Class in io.taktx.client
A utility class to provide instances of classes based on the runtime environment (Quarkus, Spring, or plain Java).
InstanceUpdateJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for InstanceUpdateDTO objects.
InstanceUpdateJsonDeserializer() - Constructor for class io.taktx.client.serdes.InstanceUpdateJsonDeserializer
Constructor for InstanceUpdateJsonDeserializer.
InstanceUpdateRecord - Class in io.taktx.client
A record representing an update to a process instance scope or flow node instance, including the timestamp of the update,the ID of the process instance, and the details of the update.
InstanceUpdateRecord(long, UUID, InstanceUpdateDTO) - Constructor for class io.taktx.client.InstanceUpdateRecord
Create a new InstanceUpdateRecord.
io.taktx.client - package io.taktx.client
 
io.taktx.client.annotation - package io.taktx.client.annotation
 
io.taktx.client.serdes - package io.taktx.client.serdes
 

M

MapParameterResolver - Class in io.taktx.client
A parameter resolver that converts the variables of an ExternalTaskTriggerDTO into a Map.
MapParameterResolver(ObjectMapper) - Constructor for class io.taktx.client.MapParameterResolver
Constructor for MapParameterResolver.
MessageEventKeySerializer - Class in io.taktx.client.serdes
A JSON serializer for MessageEventKeyDTO objects.
MessageEventKeySerializer() - Constructor for class io.taktx.client.serdes.MessageEventKeySerializer
Constructor for MessageEventKeySerializer.
MessageEventSender - Class in io.taktx.client
A sender for message events, responsible for producing and sending MessageEventDTO objects to a Kafka topic.
MessageEventSender(TaktPropertiesHelper) - Constructor for class io.taktx.client.MessageEventSender
Constructor for MessageEventSender.
MessageEventSerializer - Class in io.taktx.client.serdes
A JSON serializer for MessageEventDTO objects.
MessageEventSerializer() - Constructor for class io.taktx.client.serdes.MessageEventSerializer
Constructor for MessageEventSerializer.

N

newClientBuilder() - Static method in class io.taktx.client.TaktClient
Creates a new TaktClientBuilder instance to create a new TaktClient.

P

ProcessDefinitionConsumer - Class in io.taktx.client
A consumer that subscribes to process definition activation records from a Kafka topic, maintains a map of deployed process definitions, and notifies registered consumers of updates.
ProcessDefinitionDeployer - Class in io.taktx.client
A deployer for process definitions, responsible for parsing BPMN XML and sending the parsed definitions to a Kafka topic.
ProcessDefinitionJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for ProcessDefinitionDTO objects.
ProcessDefinitionJsonDeserializer() - Constructor for class io.taktx.client.serdes.ProcessDefinitionJsonDeserializer
Constructor for ProcessDefinitionJsonDeserializer.
ProcessDefinitionKeyJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for ProcessDefinitionKey objects.
ProcessDefinitionKeyJsonDeserializer() - Constructor for class io.taktx.client.serdes.ProcessDefinitionKeyJsonDeserializer
Constructor for ProcessDefinitionKeyJsonDeserializer.
ProcessInstanceProducer - Class in io.taktx.client
A producer for process instance triggers, responsible for producing and sending ProcessInstanceTriggerDTO objects to a Kafka topic.
ProcessInstanceProducer(TaktPropertiesHelper) - Constructor for class io.taktx.client.ProcessInstanceProducer
Constructor for ProcessInstanceProducer.
ProcessInstanceResponder - Class in io.taktx.client
A responder for process instance triggers, responsible for creating responders for different types of flow element triggers.
ProcessInstanceResponder(TaktPropertiesHelper) - Constructor for class io.taktx.client.ProcessInstanceResponder
Constructor for ProcessInstanceResponder.
ProcessInstanceTriggerSerializer - Class in io.taktx.client.serdes
A JSON serializer for ProcessInstanceTriggerDTO objects.
ProcessInstanceTriggerSerializer() - Constructor for class io.taktx.client.serdes.ProcessInstanceTriggerSerializer
Constructor for ProcessInstanceTriggerSerializer.
ProcessInstanceUpdateConsumer - Class in io.taktx.client
This class is responsible for managing the subscription to external tasks for all process definitions.
ProcessInstanceUpdateConsumer(TaktPropertiesHelper, Executor) - Constructor for class io.taktx.client.ProcessInstanceUpdateConsumer
Constructor for ProcessInstanceUpdateConsumer.

R

registerExternalTaskConsumer(ExternalTaskTriggerConsumer, String) - Method in class io.taktx.client.TaktClient
Registers an external task consumer that will be notified of external task triggers.
registerInstanceUpdateConsumer(Consumer<InstanceUpdateRecord>) - Method in class io.taktx.client.ProcessInstanceUpdateConsumer
Registers a consumer that will be notified of instance update records.
registerInstanceUpdateConsumer(Consumer<InstanceUpdateRecord>) - Method in class io.taktx.client.TaktClient
Registers a consumer that will be notified of instance update records.
registerProcessDefinitionUpdateConsumer(BiConsumer<ProcessDefinitionKey, ProcessDefinitionDTO>) - Method in class io.taktx.client.ProcessDefinitionConsumer
Registers a consumer to be notified of process definition updates.
registerProcessDefinitionUpdateConsumer(BiConsumer<ProcessDefinitionKey, ProcessDefinitionDTO>) - Method in class io.taktx.client.TaktClient
Registers a consumer that will be notified of process definition updates.
registerUserTaskConsumer(UserTaskTriggerConsumer) - Method in class io.taktx.client.TaktClient
Registers a user task consumer that will be notified of user task triggers.
requestExternalTaskTopic(String, int, CleanupPolicy, short) - Method in class io.taktx.client.TaktClient
Requests the creation of a Kafka topic for an external task.
resolve(ExternalTaskTriggerDTO) - Method in class io.taktx.client.ExternalTaskInstanceResponderParameterResolver
 
resolve(ExternalTaskTriggerDTO) - Method in class io.taktx.client.ExternalTaskTriggerDTOParameterResolver
 
resolve(ExternalTaskTriggerDTO) - Method in class io.taktx.client.MapParameterResolver
 
resolve(ExternalTaskTriggerDTO) - Method in interface io.taktx.client.TaktParameterResolver
Resolves a method parameter from the given ExternalTaskTriggerDTO.
resolve(ExternalTaskTriggerDTO) - Method in class io.taktx.client.VariableParameterResolver
Resolves the parameter by extracting the variable from the ExternalTaskTriggerDTO and converting it to the specified type.
resources() - Element in annotation interface io.taktx.client.annotation.Deployment
The resource paths for the deployment.
ResourceScanner - Class in io.taktx.client
 
ResourceScanner() - Constructor for class io.taktx.client.ResourceScanner
 
responderForExternalTaskTrigger(ExternalTaskTriggerDTO) - Method in class io.taktx.client.ProcessInstanceResponder
Creates an ExternalTaskInstanceResponder for the given ExternalTaskTriggerDTO.
responderForUserTaskTrigger(UserTaskTriggerDTO) - Method in class io.taktx.client.ProcessInstanceResponder
Creates a UserTaskInstanceResponder for the given UserTaskTriggerDTO.
respondError(boolean, String, String) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with an error message.
respondError(boolean, String, String, VariablesDTO) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with an error message.
respondError(String, String) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends an error response with the provided code and message, and no variables.
respondError(String, String, VariablesDTO) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends an error response with the provided code and message, and optional variables.
respondEscalation(String, String) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with an escalation message without any variables.
respondEscalation(String, String) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends an escalation response with the provided code and message, and no variables.
respondEscalation(String, String, VariablesDTO) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with an escalation message including the provided variables.
respondEscalation(String, String, VariablesDTO) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends an escalation response with the provided code, message, and variables.
respondPromise(Duration) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with a promise message indicating the task will be completed after the specified duration.
respondSuccess() - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with a success message without any variables.
respondSuccess() - Method in class io.taktx.client.UserTaskInstanceResponder
Sends a success response with no variables.
respondSuccess(Object) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with a success message including the provided variables.
respondSuccess(Object) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends a success response with the provided variables.
respondSuccess(Map<String, JsonNode>) - Method in class io.taktx.client.ExternalTaskInstanceResponder
Responds with a success message including the provided variables map.
respondSuccess(Map<String, JsonNode>) - Method in class io.taktx.client.UserTaskInstanceResponder
Sends a success response with the provided variables map.
respondToExternalTask(ExternalTaskTriggerDTO) - Method in class io.taktx.client.TaktClient
Responds to an external task trigger.

S

sendMessage(MessageEventDTO) - Method in class io.taktx.client.MessageEventSender
Sends a message event to the configured Kafka topic.
sendMessage(MessageEventDTO) - Method in class io.taktx.client.TaktClient
Sends a message event to the engine.
sendMSignal(SignalDTO) - Method in class io.taktx.client.SignalSender
Sends a signal to the configured Kafka topic.
sendSignal(String) - Method in class io.taktx.client.TaktClient
Sends a signal event to the engine.
SignalSender - Class in io.taktx.client
A sender for message events, responsible for producing and sending MessageEventDTO objects to a Kafka topic.
SignalSender(TaktPropertiesHelper) - Constructor for class io.taktx.client.SignalSender
Constructor for MessageEventSender.
SignalSerializer - Class in io.taktx.client.serdes
A JSON serializer for MessageEventDTO objects.
SignalSerializer() - Constructor for class io.taktx.client.serdes.SignalSerializer
Constructor for MessageEventSerializer.
start() - Method in class io.taktx.client.TaktClient
Starts the TaktClient, which subscribes to process definition records and process definition updates.
StartCommandSerializer - Class in io.taktx.client.serdes
A JSON serializer for StartCommandDTO objects.
StartCommandSerializer() - Constructor for class io.taktx.client.serdes.StartCommandSerializer
Constructor for StartCommandSerializer.
startProcess(String, VariablesDTO) - Method in class io.taktx.client.ProcessInstanceProducer
Starts a new process instance by sending a StartCommandDTO to the configured Kafka topic.
startProcess(String, VariablesDTO) - Method in class io.taktx.client.TaktClient
Starts a new process instance.
stop() - Method in class io.taktx.client.ExternalTaskTriggerTopicConsumer
Stops all running consumers and waits for them to finish processing.
stop() - Method in class io.taktx.client.ProcessDefinitionConsumer
Stops the consumer from processing further records.
stop() - Method in class io.taktx.client.ProcessInstanceUpdateConsumer
Stops the consumer from processing further records.
stop() - Method in class io.taktx.client.TaktClient
Stops the TaktClient, which unsubscribes from process definition records and process
stop() - Method in class io.taktx.client.UserTaskTriggerTopicConsumer
Stops the consumer from processing further records.
stop() - Method in class io.taktx.client.XmlByProcessDefinitionIdConsumer
Stops the consumer from processing further records.
subscribeToDefinitionRecords() - Method in class io.taktx.client.ProcessDefinitionConsumer
Subscribes to the process definition activation topic and starts processing records.
subscribeToExternalTaskTriggerTopics(ExternalTaskTriggerConsumer, String) - Method in class io.taktx.client.ExternalTaskTriggerTopicConsumer
Subscribe to external task trigger topics based on job IDs from the provided consumer.
subscribeToTopic() - Method in class io.taktx.client.XmlByProcessDefinitionIdConsumer
Subscribes to the topic for XML by process definition ID and starts consuming messages asynchronously.
subscribeToUserTaskTriggerTopics(UserTaskTriggerConsumer) - Method in class io.taktx.client.UserTaskTriggerTopicConsumer
Subscribes to the user task trigger topic and starts consuming messages, passing them to the provided consumer.

T

TaktClient - Class in io.taktx.client
TaktClient is the main entry point for interacting with the TaktX BPMN engine.
TaktClient.TaktClientBuilder - Class in io.taktx.client
Builder class for creating TaktClient instances.
TaktParameterResolver - Interface in io.taktx.client
A resolver interface for resolving method parameters from ExternalTaskTriggerDTOs.
TaktParameterResolverFactory - Interface in io.taktx.client
A factory interface for creating TaktParameterResolver instances based on method parameters.
TaktWorkerMethod - Annotation Interface in io.taktx.client.annotation
Annotation to mark a method as a TaktX worker method with a specified task ID and auto-completion option.
taskId() - Element in annotation interface io.taktx.client.annotation.TaktWorkerMethod
The task ID associated with the worker method.
TopicMetaJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for TopicMetaDTO objects.
TopicMetaJsonDeserializer() - Constructor for class io.taktx.client.serdes.TopicMetaJsonDeserializer
Constructor for TopicMetaJsonDeserializer.

U

UserTaskInstanceResponder - Class in io.taktx.client
A responder for user task instances that allows sending success, escalation, or error responses back to the process instance via Kafka.
UserTaskInstanceResponder(KafkaProducer<UUID, ContinueFlowElementTriggerDTO>, String, UUID, List<Long>) - Constructor for class io.taktx.client.UserTaskInstanceResponder
Constructs a UserTaskInstanceResponder.
UserTaskTriggerConsumer - Interface in io.taktx.client
A consumer interface for handling UserTaskTriggerDTO objects.
UserTaskTriggerJsonDeserializer - Class in io.taktx.client.serdes
A JSON deserializer for UserTaskTriggerDTO objects.
UserTaskTriggerJsonDeserializer() - Constructor for class io.taktx.client.serdes.UserTaskTriggerJsonDeserializer
Constructor for UserTaskTriggerJsonDeserializer.
UserTaskTriggerTopicConsumer - Class in io.taktx.client
This class is responsible for consuming user task trigger events from a Kafka topic and passing them to a provided consumer.

V

value() - Element in annotation interface io.taktx.client.annotation.Variable
The name of the variable to inject.
Variable - Annotation Interface in io.taktx.client.annotation
Annotation to mark a method parameter as a variable to be injected.
VariableParameterResolver - Class in io.taktx.client
A parameter resolver that extracts a variable from the ExternalTaskTriggerDTO's variables map and converts it to the specified type using Jackson's ObjectMapper.
VariableParameterResolver(ObjectMapper, Class<?>, String) - Constructor for class io.taktx.client.VariableParameterResolver
Constructs a VariableParameterResolver.

W

withTaktParameterResolverFactory(TaktParameterResolverFactory) - Method in class io.taktx.client.TaktClient.TaktClientBuilder
 
withTaktProperties(Properties) - Method in class io.taktx.client.TaktClient.TaktClientBuilder
 

X

XmlByProcessDefinitionIdConsumer - Class in io.taktx.client
This class is responsible for managing the subscription to external tasks for all process definitions.
XmlByProcessDefinitionIdConsumer(TaktPropertiesHelper, Executor) - Constructor for class io.taktx.client.XmlByProcessDefinitionIdConsumer
Constructor for XmlByProcessDefinitionIdConsumer.
XmlDefinitionSerializer - Class in io.taktx.client.serdes
A JSON serializer for XmlDefinitionsDTO objects.
XmlDefinitionSerializer() - Constructor for class io.taktx.client.serdes.XmlDefinitionSerializer
Constructor for XmlDefinitionSerializer.
A B C D E F G I M N P R S T U V W X 
All Classes and Interfaces|All Packages