Outbox

Dependencies

Valtimo contains an implementation of the transactional outbox pattern. To make use of this pattern, the outbox module needs to be added as a dependency. The following can be added to your project, depending on whether Maven or Gradle is used:

Backend

The samples below assume the valtimo-dependency-versions module is used. If not, please specify the artifact version as well.

Maven dependency:

<dependencies>
  <dependency>
    <groupId>com.ritense.valtimo</groupId>
    <artifactId>outbox</artifactId>
    <version>${valtimo_version}</version>
  </dependency>
</dependencies>

Gradle dependency:

dependencies {
    implementation("com.ritense.valtimo:outbox")
}

Configuration

The outbox can be configured to better match the environment:

application.yml

valtimo:
  outbox:
    publisher:
      polling.rate: "PT1M" # ISO 8601 duration format

Disabling the outbox

It is possible to disable the outbox functionality without having to remove the module. This is useful for environments where you might not want the overhead this module adds. When disabled, a no-operation OutboxService implementation bean will be used. This will be the only outbox bean available to the application.

The outbox will be disabled by setting the following application property:

valtimo.outbox.enabled: false