Imixs-Workflow Adapter API

The Imixs-Workflow Adapter API is an extension mechanism of the Imixs-Workflow engine. An adapter can provide business logic to adapt or extend a process instance. For example, an adapter can exchange data with an external Microservice API.

In different to the Plugin API the Adapter API is bound to a single Event within a BPMN 2.0 model. This allows a more fine grained configuration.

Adapters are defined as BPMN Signal-Events. The signal definition contains the adapter class name to be called by the Imixs Workflow engine:

The Adapter Interface

The Imixs Adapter-API defines an Interface with the call-back method ‘execute’. This method is called by the WorkflowKernel for each matching signal event.

public ItemCollection execute(ItemCollection document,ItemCollection event) throws AdapterException;

CDI Support

The Imixs-Workflow Adapter API also supports CDI. In this way an EJB or Resource can be injected into an adapter class by the corresponding CDI annotation. See the following example:

public class DemoAdapter implements org.imixs.workflow.Adapter {
    // inject services...
    ModelService modelService;
    public ItemCollection execute(ItemCollection document, ItemCollection event) throws AdapterException {
       List<String> versions = modelService.getVersions();

In this example the adapter injects the Imixs ModelService to ask for available model versions.

Exception Handling

An adapter can also interrupt the processing phase by throwing an AdapterException. For example in case of a communication error.

See the following example handling a jax-rs client communication:

    public ItemCollection execute(ItemCollection workitem, ItemCollection event) throws AdapterException {
       // call external Rest API....
       try {
         Response response =
          .post(Entity.entity(data, MediaType.APPLICATION_XML));
       } catch (ResponseProcessingException e) {
         throw new AdapterException(
              MyAdapter.class.getSimpleName(),ERROR_API_COMMUNICATION,"Failed to call rest api!");

In this example a Adapter throws an AdapterException when the rest api call failed. The Exception contains the Adapter name, an Error Code, and a Error Message. A running transaction will be automatically rolled back.