Links

Use TLS for JDBC connection strings

org.openrewrite.java.spring.data.UseTlsJdbcConnectionString Increasingly, for compliance reasons (e.g. NACHA), JDBC connection strings should be TLS-enabled. This recipe will update the port and optionally add a connection attribute to indicate that the connection is TLS-enabled.

Source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-spring
  • version: 4.32.0

Options

Type
Name
Description
String
propertyKey
The Spring property key to perform updates against. If this value is specified, the specified property will be used for searching, otherwise a default of spring.datasource.url will be used instead.
Integer
oldPort
The non-TLS enabled port number to replace with the TLS-enabled port. If this value is specified, no changes will be made to jdbc connection strings which do not contain this port number.
Integer
port
The TLS-enabled port to use.
String
attribute
A connection attribute, if any, indicating to the JDBC provider that this is a TLS connection.

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.UseTlsJdbcConnectionStringExample. 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.UseTlsJdbcConnectionStringExample
displayName: Use TLS for JDBC connection strings example
recipeList:
- org.openrewrite.java.spring.data.UseTlsJdbcConnectionString:
propertyKey: spring.datasource.url
oldPort: 1234
port: 1234
attribute: sslConnection=true
Now that com.yourorg.UseTlsJdbcConnectionStringExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:4.32.0 in your build file:
Gradle
Maven
build.gradle
plugins {
id("org.openrewrite.rewrite") version("5.34.0")
}
rewrite {
activeRecipe("com.yourorg.UseTlsJdbcConnectionStringExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-spring:4.32.0")
}
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>4.39.0</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.UseTlsJdbcConnectionStringExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-spring</artifactId>
<version>4.32.0</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
Recipes can also be activated directly from the command line by adding the argument -Drewrite.activeRecipes=com.yourorg.UseTlsJdbcConnectionStringExample

See how this recipe works across multiple open-source repositories

Moderne Link Image
The Moderne public SaaS instance 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.