Package io.axoniq.framework.workflow.annotation

Annotation Interface Workflow

@Documented @Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) public @interface Workflow
Annotation to mark the workflow definition method.
Since:
5.4.0
Author:
Simon Zambrovski

  • Field Details

  • Element Details

    • workflowName

      String workflowName
      Specifies the name of the workflow.
      Returns:
      workflow name, defaults to empty string, meaning that the full-qualified name and method name of the class is used.
      Default:
      ""

    • workflowNamespace

      String workflowNamespace
      Specifies the namespace for workflow events.
      Returns:
      namespace for all workflow events, defaults to empty string.
      Default:
      ""

    • startOnEventName

      String startOnEventName
      Specifies the qualified name of the event to be used as a starting trigger. If this property is set, the startOnEventClass() property must not be set.
      Returns:
      qualified name of the event, defaults to empty string.
      Default:
      ""

    • startOnEventClass

      Class<?> startOnEventClass
      Specifies the class of the event to be used as a starting trigger. If this property is set, the startOnEventName() property must not be set.
      Returns:
      class of the event, defaults to Void.class.
      Default:
      java.lang.Void.class

    • startOnConditions

      String[] startOnConditions
      List of start conditions expressed as associations.
      Returns:
      array of value associations.
      Default:
      {}

    • idProperty

      String idProperty
      Specifies the property of the trigger event defining the workflow id.

      Either this property or idPropertyProvider() must be specified.

      Returns:
      name of the property, defaults to empty string.
      Default:
      ""

    • idPropertyProvider

      Class<? extends WorkflowIdProvider> idPropertyProvider
      Specifies the type of id property provider.

      Either this property or idProperty() must be specified.

      Returns:
      id property provider type.
      Default:
      io.axoniq.framework.workflow.runtime.execution.PayloadPropertyWorkflowIdProvider.class

    • workflowVersion

      String workflowVersion
      Workflow definition version (semver, e.g. "0.0.2"). New instances start on the highest registered version; in-flight instances replay on the version they were started under.

      Defaults to Version.DEFAULT_VERSION ("0.0.1").

      Returns:
      workflow definition version.
      Default:
      "0.0.1"