Package org.camunda.community.bpmndt.api

Class SignalEventHandler

java.lang.Object
org.camunda.community.bpmndt.api.SignalEventHandler
public class SignalEventHandler extends Object
Fluent API to handle signal catch events. Please note: a signal is broadcasted by default.

  • Constructor Details

  • Method Details

    • broadcast

      public void broadcast()
      Broadcasts a signal, when the process instance is waiting at the corresponding element.

    • customize

      public SignalEventHandler customize(Consumer<SignalEventHandler> customizer)
      Customizes the handler, using the given Consumer function. This method can be used to apply a common customization needed for different test cases. 
       tc.handleSignalCatchEvent().customize(this::prepare);
      Parameters:
      customizer - A function that accepts a SignalEventHandler.
      Returns:
      The handler.

    • execute

      public void execute(BiConsumer<io.camunda.zeebe.client.ZeebeClient,String> action)
      Broadcasts a signal using a custom action, when the process instance is waiting at the corresponding element.
      Parameters:
      action - A specific action that accepts a ZeebeClient and the signal name.
      See Also:
      • ZeebeClient.newBroadcastSignalCommand()

    • verify

      public SignalEventHandler verify(Consumer<io.camunda.zeebe.process.test.assertions.ProcessInstanceAssert> verifier)
      Verifies the signal event's waiting state.
      Parameters:
      verifier - Verifier that accepts an ProcessInstanceAssert instance.
      Returns:
      The handler.

    • verifySignalName

      public SignalEventHandler verifySignalName(String expectedSignalName)
      Verifies that the signal event has a specific signal name.
      Parameters:
      expectedSignalName - The expected signal name.
      Returns:
      The handler.

    • verifySignalName

      public SignalEventHandler verifySignalName(Consumer<String> signalNameConsumer)
      Verifies that the signal event has a specific signal name, using a consumer.
      Parameters:
      signalNameConsumer - A consumer asserting the signal name.
      Returns:
      The handler.

    • verifySignalNameExpression

      public SignalEventHandler verifySignalNameExpression(Consumer<String> signalNameExpressionConsumer)
      Verifies that the signal event has a specific signal name FEEL expression (see "Signal" section), using a consumer function.
      Parameters:
      signalNameExpressionConsumer - A consumer asserting the signal name expression.
      Returns:
      The handler.