Skip to main content

Automatic Setup

Flamingock provides a convenient automatic integration with Spring Boot using the @Flamingock annotation. This setup is ideal when you want Flamingock to automatically detect and wire required components without writing explicit builder logic.

Import the springboot integration library​

Add the Flamingock Spring Boot integration dependency:

implementation("io.flamingock:flamingock-springboot-integration:$flamingockVersion")

Version Compatibility​

The flamingock-springboot-integration artifact is compatible with both Spring Boot 2.x and 3.x. See Version Compatibility for details.

Configure setup and activate integration​

To activate the integration, add @EnableFlamingock to any class in your application (commonly on your main class or a configuration class):

@EnableFlamingock(
    stages = {
        @Stage(location = "com.yourapp.changes")
    }
)
@SpringBootApplication
public class MyApplication {
  public static void main(String[] args) {
    SpringApplication.run(MyApplication.class, args);
  }
}

The @EnableFlamingock annotation enables automatic Spring Boot integration, which:

  • Detect and use Spring’s ApplicationContext and ApplicationEventPublisher
  • Loads Flamingock configuration directly from your Spring Boot config file
  • Automatically configures the runner (e.g., ApplicationRunner or InitializingBean)
  • Processes the setup configuration from the annotation

Bean registration requirements​

With automatic setup, Flamingock needs access to your target systems and (for Community Edition) audit stores. Since these aren't configured directly via the builder, they must be registered as Spring beans:

Example target system bean registration:

@Bean
public NonTransactionalTargetSystem redisTargetSystem() {
    return new NonTransactionalTargetSystem("redis-cache-id");
}

Flamingock will automatically detect and use these beans during execution.

Providing configuration​

Runtime configuration is defined using standard Spring Boot configuration files. Use the flamingock section for all core and edition-specific options.

flamingock:
  lockAcquiredForMillis: 1200
  runnerType: InitializingBean
  # other configuration...
info

If the runnerType property is not provided, Flamingock defaults to using ApplicationRunner.

Next steps​