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.
Recipe source
GitHub, Issue Tracker, Maven Central
groupId: org.openrewrite.recipe
artifactId: rewrite-spring
version: 5.8.0
Options
Type | Name | Description | Example |
---|---|---|---|
| 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 |
|
| 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. |
|
| port | The TLS-enabled port to use. |
|
| 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:
Now that com.yourorg.UseTlsJdbcConnectionStringExample
has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-spring:5.8.0 in your build file:
Add the following to your
build.gradle
file:
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
Shannon Pamperl, Jonathan Schneider, Knut Wannheden, Sam Snyder, Kun Li
Last updated