← All recipes
Moderne licensed

Use TLS for JDBC connection strings

Recipe IDorg.openrewrite.java.spring.data.UseTlsJdbcConnectionString
Artifactorg.openrewrite.recipe:rewrite-spring

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.

Single recipeMSAL

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.java.spring.data.UseTlsJdbcConnectionString --recipe-option "propertyKey=spring.datasource.url" --recipe-option "oldPort=1234" --recipe-option "port=1234" --recipe-option "attribute=sslConnection=true"

If the recipe isn’t available locally, install it with:

mod config recipes jar install org.openrewrite.recipe:rewrite-spring:6.36.0

Options

NameTypeDescription
propertyKeyrequiredStringThe 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.
e.g. spring.datasource.url
oldPortrequiredIntegerThe 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.
e.g. 1234
portrequiredIntegerThe TLS-enabled port to use.
e.g. 1234
attributerequiredStringA connection attribute, if any, indicating to the JDBC provider that this is a TLS connection.
e.g. sslConnection=true

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats