Creating Workflow Stubs

The Infinitic client manages workflows through stubs built from the workflow interface.

Here is an example of workflow interface from our Hello World app:

public interface HelloWorldWorkflow {
    String greet(String name);
}

interface HelloWorldWorkflow {
    fun greet(name: String): String
}

Using this interface, an Infinitic client can create stubs that behaves syntactically as instances of such workflow. Stubs are used to trigger actions such as:

• starting a new workflow
• cancelling running workflows
• sending a signal to running workflows
• starting a new method on running workflows

Stub of new workflow

The client has a newWorkflow method to create the stub of a new workflow:

HelloWorldWorkflow w = 
    client.newWorkflow(HelloWorldWorkflow.class);

val w : HelloWorldWorkflow = 
    client.newWorkflow(HelloWorldWorkflow::class.java)

We can also add tags to this stub. Those tags will be attached to workflow instances started with this stub.

HelloWorldWorkflow w = 
    client.newWorkflow(HelloWorldWorkflow.class, Set.of("foo", "bar"));

val w : HelloWorldWorkflow = 
    client.newWorkflow(HelloWorldWorkflow::class.java, tags = setOf("foo", "bar"))

The stub of new workflow can be used to start a new workflow instance. It can be used multiple times to start multiple instances.

Running workflow stub

A workflow is said running, as long as it is neither completed neither canceled.

We can create the stub of a running workflow from its id:

HelloWorldWorkflow w = 
    client.getWorkflowById(HelloWorldWorkflow.class, id);

val w : HelloWorldWorkflow = 
    client.getWorkflowById(HelloWorldWorkflow::class.java, id)

Alternatively, we can create a stub targeting all running workflow having a given tag:

HelloWorldWorkflow w =
    client.getWorkflowByTag(HelloWorldWorkflow.class, "foo");

val w: HelloWorldWorkflow = 
    client.getWorkflowByTag(HelloWorldWorkflow::class.java, tag = "foo")

The stub of running workflows can be used to apply actions to the targeted workflows:

• cancelling
• sending signals
• starting new methods