Add @Configuration to classes with @EnableXXXSecurity annotations

org.openrewrite.java.spring.boot3.ConfigurationOverEnableSecurity

Prior to Spring Security 6, @EnableXXXSecurity implicitly had @Configuration. Configuration was removed from the definitions of the @EnableSecurity definitions in Spring Security 6. Consequently classes annotated with @EnableXXXSecurity coming from pre-Boot 3 should have @Configuration annotation added.

Recipe source

GitHub, Issue Tracker, Maven Central

  • groupId: org.openrewrite.recipe

  • artifactId: rewrite-spring

  • version: 5.8.0

Options

TypeNameDescriptionExample

boolean

forceAddConfiguration

Force add @Configuration regardless current Boot version.

true

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.ConfigurationOverEnableSecurityExample. Here's how you can define and customize such a recipe within your rewrite.yml:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ConfigurationOverEnableSecurityExample
displayName: Add `@Configuration` to classes with `@EnableXXXSecurity` annotations example
recipeList:
  - org.openrewrite.java.spring.boot3.ConfigurationOverEnableSecurity:
      forceAddConfiguration: false

Now that com.yourorg.ConfigurationOverEnableSecurityExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:5.8.0 in your build file:

  1. Add the following to your build.gradle file:

build.gradle
plugins {
    id("org.openrewrite.rewrite") version("6.12.0")
}

rewrite {
    activeRecipe("com.yourorg.ConfigurationOverEnableSecurityExample")
}

repositories {
    mavenCentral()
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-spring:5.8.0")
}
  1. Run gradle rewriteRun to run the recipe.

See how this recipe works across multiple open-source repositories

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Contributors

Alex Boyko, Sam Snyder, Knut Wannheden, Kun Li, Jonathan Schnéider

Last updated