Update changelog and bump version for 2.5.5

Author: joyc-bq

CHANGELOG.md

@@ -3,11 +3,25 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/#semantic-versioning-200).
 
+## [2.5.5] - 2025-03-06
 ### :bug: Fixed
+- Various reader failover fixes ([PR #1227](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1227)) & ([PR #1246](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1246)).
 - Avoid encoding MariaDB connection properties ([PR #1237](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1237)).
+- Custom domains during failover ([PR #1265](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1265))
+- Skip failover on interrupted thread ([Issue #1283](https://github.com/aws/aws-advanced-jdbc-wrapper/issues/1283))
+- Log message parameters ([PR #1303](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1303))
 
 ### :crab: Changed
-- Changed default value for `limitlessTransactionRouterMonitorIntervalMs` from 15s to 7.5s ([PR #1302](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1302)).
+- Revise default monitor poll rate from 15s to 7.5s for the Limitless Connection Plugin. For more information see the [docs](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/using-plugins/UsingTheLimitlessConnectionPlugin.md).
+- Consolidate cache clean-up in a single place ([PR #1234](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1234)).
+- Relocate custom handlers ([PR #1235](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1235)).
+- Improve forceConnect pipeline ([PR #1238](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1238)).
+- Update deprecated ConnectionProviderManager function calls ([PR #1256](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1256)).
+- Remove mysql-connector-j library dependency for MariaDb ([PR #1287](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1287)).
+- Refactor AuroraTestUtility ([PR #1252](https://github.com/aws/aws-advanced-jdbc-wrapper/pull/1252)).
+
+### :magic_wand: Added
+- Documentation for Fastest Response Strategy Plugin. See [List of Available Plugins](https://github.com/aws/aws-advanced-jdbc-wrapper/blob/main/docs/using-the-jdbc-driver/UsingTheJdbcDriver.md#list-of-available-plugins).
 
 ## [2.5.4] - 2024-12-23
 ### :bug: Fixed
@@ -410,6 +424,7 @@ The Amazon Web Services (AWS) Advanced JDBC Driver allows an application to take
 - The [AWS IAM Authentication Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheIamAuthenticationPlugin.md)
 - The [AWS Secrets Manager Connection Plugin](./docs/using-the-jdbc-driver/using-plugins/UsingTheAwsSecretsManagerPlugin.md)
 
+[2.5.5]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.4...2.5.5
 [2.5.4]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.3...2.5.4
 [2.5.3]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.2...2.5.3
 [2.5.2]: https://github.com/awslabs/aws-advanced-jdbc-wrapper/compare/2.5.1...2.5.2

Maintenance.md

@@ -1,35 +1,36 @@
 # Release Schedule
 
-| Release Date       | Release                                                                                  |
-|--------------------|------------------------------------------------------------------------------------------|
-| October 5, 2022    | [Release 1.0.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.0) |  
-| January 31, 2023   | [Release 1.0.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.1) | 
-| Mar 30, 2023       | [Release 1.0.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.2) |
-| April 28, 2023     | [Release 2.0.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.0.0) |  
-| May 11, 2023       | [Release 2.1.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.1.0) |
-| May 21, 2023       | [Release 2.1.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.1.1) |
-| June 14, 2023      | [Release 2.2.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.0) |
-| June 16, 2023      | [Release 2.2.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.1) |
-| July 5, 2023       | [Release 2.2.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.2) |
-| July 31, 2023      | [Release 2.2.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.3) |
-| August 25, 2023    | [Release 2.2.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.4) |
-| October 3, 2023    | [Release 2.2.5](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.5) |
-| November 15, 2023  | [Release 2.3.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.0) |
-| November 29, 2023  | [Release 2.3.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.1) |
-| December 18, 2023  | [Release 2.3.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.2) |
-| January 23, 2024   | [Release 2.3.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.3) |
-| March 1, 2024      | [Release 2.3.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.4) |
-| March 14, 2024     | [Release 2.3.5](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.5) |
-| May 01, 2024       | [Release 2.3.6](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.6) |
-| June 05, 2024      | [Release 2.3.7](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.7) |
-| July 31, 2024      | [Release 2.3.8](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.8) |
-| August 9, 2024     | [Release 2.3.9](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.9) |
-| September 25, 2024 | [Release 2.4.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.4.0) |
-| October 18, 2024   | [Release 2.5.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.0) |
-| October 24, 2024   | [Release 2.5.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.1) |
-| November 5, 2024   | [Release 2.5.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.2) |
-| November 29, 2024  | [Release 2.5.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.3) |
-| December 23, 2024  | [Release 2.5.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.4) |
+| Release Date       | Release                                                                                   |
+|--------------------|-------------------------------------------------------------------------------------------|
+| October 5, 2022    | [Release 1.0.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.0)  |  
+| January 31, 2023   | [Release 1.0.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.1)  | 
+| Mar 30, 2023       | [Release 1.0.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/1.0.2)  |
+| April 28, 2023     | [Release 2.0.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.0.0)  |  
+| May 11, 2023       | [Release 2.1.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.1.0)  |
+| May 21, 2023       | [Release 2.1.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.1.1)  |
+| June 14, 2023      | [Release 2.2.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.0)  |
+| June 16, 2023      | [Release 2.2.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.1)  |
+| July 5, 2023       | [Release 2.2.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.2)  |
+| July 31, 2023      | [Release 2.2.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.3)  |
+| August 25, 2023    | [Release 2.2.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.4)  |
+| October 3, 2023    | [Release 2.2.5](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.2.5)  |
+| November 15, 2023  | [Release 2.3.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.0)  |
+| November 29, 2023  | [Release 2.3.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.1)  |
+| December 18, 2023  | [Release 2.3.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.2)  |
+| January 23, 2024   | [Release 2.3.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.3)  |
+| March 1, 2024      | [Release 2.3.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.4)  |
+| March 14, 2024     | [Release 2.3.5](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.5)  |
+| May 01, 2024       | [Release 2.3.6](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.6)  |
+| June 05, 2024      | [Release 2.3.7](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.7)  |
+| July 31, 2024      | [Release 2.3.8](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.8)  |
+| August 9, 2024     | [Release 2.3.9](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.3.9)  |
+| September 25, 2024 | [Release 2.4.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.4.0)  |
+| October 18, 2024   | [Release 2.5.0](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.0)  |
+| October 24, 2024   | [Release 2.5.1](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.1)  |
+| November 5, 2024   | [Release 2.5.2](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.2)  |
+| November 29, 2024  | [Release 2.5.3](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.3)  |
+| December 23, 2024  | [Release 2.5.4](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.4)  |
+| March 6, 2025      | [Release 2.5.45](https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/tag/2.5.5) |
 
 `aws-advanced-jdbc-wrapper` [follows semver](https://semver.org/#semantic-versioning-200) which means we will only
 release breaking changes in major versions. Generally speaking patches will be released to fix existing problems without
@@ -83,4 +84,4 @@ from the updated source after the PRs are merged.
 | Major Version | Latest Minor Version | Status      | Initial Release | Maintenance Window Start | Maintenance Window End |
 |---------------|----------------------|-------------|-----------------|--------------------------|------------------------|
 | 1             | 1.0.2                | Maintenance | Oct 5, 2022     | Apr 28, 2023             | Apr 28, 2024           | 
-| 2             | 2.5.4                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 
+| 2             | 2.5.5                | Current     | Apr 28, 2023    | N/A                      | N/A                    | 

benchmarks/README.md

@@ -7,5 +7,5 @@ The benchmarks do not measure the performance of target JDBC drivers nor the per
 ## Usage
 1. Build the benchmarks with the following command `../gradlew jmhJar`.
     1. the JAR file will be outputted to `build/libs`
-2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.5.4-jmh.jar`.
+2. Run the benchmarks with the following command `java -jar build/libs/benchmarks-2.5.5-jmh.jar`.
     1. you may have to update the command based on the exact version of the produced JAR file

docs/GettingStarted.md

@@ -16,7 +16,7 @@ If you are using the AWS JDBC Driver as part of a Gradle project, include the wr
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.4'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.5'
     implementation group: 'org.postgresql', name: 'postgresql', version: '42.5.0'
 }
 ```
@@ -30,16 +30,16 @@ You can use pre-compiled packages that can be downloaded directly from [GitHub R
 For example, the following command uses wget to download the wrapper:
 
 ```bash
-wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.5.4/aws-advanced-jdbc-wrapper-2.5.4.jar
+wget https://github.com/awslabs/aws-advanced-jdbc-wrapper/releases/download/2.5.5/aws-advanced-jdbc-wrapper-2.5.5.jar
 ```
 
 Then, the following command adds the AWS JDBC Driver to the CLASSPATH:
 
 ```bash
-export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.5.4.jar
+export CLASSPATH=$CLASSPATH:/home/userx/libs/aws-advanced-jdbc-wrapper-2.5.5.jar
 ```
 
-> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.5.4.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar). 
+> **Note**: There is also a JAR suffixed with `-bundle-federated-auth`. It is an Uber JAR that contains the AWS JDBC Driver as well as all the dependencies needed to run the Federated Authentication Plugin. **Our general recommendation is to use the `aws-advanced-jdbc-wrapper-2.5.5.jar` for use cases unrelated to complex Federated Authentication environments**. To learn more, please check out the [Federated Authentication Plugin](./using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md#bundled-uber-jar). 
 
 ### As a Maven Dependency
 
@@ -50,7 +50,7 @@ You can use [Maven's dependency management](https://search.maven.org/search?q=g:
     <dependency>
         <groupId>software.amazon.jdbc</groupId>
         <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-        <version>2.5.4</version>
+        <version>2.5.5</version>
     </dependency>
 </dependencies>
 ```
@@ -61,15 +61,15 @@ You can use [Gradle's dependency management](https://search.maven.org/search?q=g
 
 ```gradle
 dependencies {
-    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.4'
+    implementation group: 'software.amazon.jdbc', name: 'aws-advanced-jdbc-wrapper', version: '2.5.5'
 }
 ```
 
 To add a Gradle dependency in a Kotlin syntax, use the following configuration:
 
 ```kotlin
 dependencies {
-    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.5.4")
+    implementation("software.amazon.jdbc:aws-advanced-jdbc-wrapper:2.5.5")
 }
 ```
 

docs/using-the-jdbc-driver/UsingTheJdbcDriver.md

@@ -227,7 +227,7 @@ If there is an unreleased feature you would like to try, it may be available in
   <dependency>
     <groupId>software.amazon.jdbc</groupId>
     <artifactId>aws-advanced-jdbc-wrapper</artifactId>
-    <version>2.5.5-SNAPSHOT</version>
+    <version>2.5.6-SNAPSHOT</version>
     <scope>system</scope>
     <systemPath>path-to-snapshot-jar</systemPath>
   </dependency>

docs/using-the-jdbc-driver/using-plugins/UsingTheFederatedAuthPlugin.md

@@ -32,7 +32,7 @@ This JAR is a drop-in ready solution and is **recommended for customers who do n
 As this plugin has a number of transitive dependencies, the goal of this JAR is to eliminate the need to manually source all the dependencies and avoid potential issues with managing them. 
 In that spirit, the dependencies in this JAR are shaded with the prefix `shaded` to avoid potential package conflicts with pre-existing packages in your environment.
 
-It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.5.4.jar`. So please take that into account when deciding if this solution is for you.
+It is important to note that the Uber JAR is bundled with the AWS Java RDS SDK and is larger (**15 MB**) than our `aws-advanced-jdbc-wrapper-2.5.5.jar`. So please take that into account when deciding if this solution is for you.
 
 If you would like to download and install the bundled Uber JAR, follow these [instructions](../../GettingStarted.md#direct-download-and-installation).
 

examples/SpringBootHikariExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using Hikari and the
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.5.4
+>    - AWS JDBC Driver 2.5.5
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringHibernateExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Spring Boot and Hibernate application with t
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Hibernate
->    - AWS JDBC Driver 2.5.4
+>    - AWS JDBC Driver 2.5.5
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11

examples/SpringTxFailoverExample/README.md

@@ -4,7 +4,7 @@ In this tutorial, you will set up a Spring Boot application using the AWS JDBC D
 
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.0
->    - AWS JDBC Driver 2.5.4
+>    - AWS JDBC Driver 2.5.5
 >    - Postgresql 42.5.4
 >    - Java 8
 

examples/SpringWildflyExample/README.md

@@ -5,7 +5,7 @@ In this tutorial, you will set up a Wildfly and Spring Boot application with the
 > Note: this tutorial was written using the following technologies:
 >    - Spring Boot 2.7.1
 >    - Wildfly 26.1.1 Final
->    - AWS JDBC Driver 2.5.4
+>    - AWS JDBC Driver 2.5.5
 >    - Postgresql 42.5.4
 >    - Gradle 7
 >    - Java 11

examples/VertxExample/README.md

@@ -3,7 +3,7 @@
 In this tutorial, you will set up a Vert.x application with the AWS JDBC Driver, and use the driver to execute some simple database operations on an Aurora PostgreSQL database.
 
 > Note: this tutorial was written using the following technologies:
->    - AWS JDBC Driver 2.5.4
+>    - AWS JDBC Driver 2.5.5
 >    - PostgreSQL 42.5.4
 >    - Java 8
 >    - Vert.x 4.4.2

gradle.properties

@@ -14,7 +14,7 @@
 
 aws-advanced-jdbc-wrapper.version.major=2
 aws-advanced-jdbc-wrapper.version.minor=5
-aws-advanced-jdbc-wrapper.version.subminor=4
+aws-advanced-jdbc-wrapper.version.subminor=5
 snapshot=false
 nexus.publish=true
 

wrapper/src/test/resources/hibernate_files/hibernate-core.gradle

@@ -61,7 +61,7 @@ dependencies {
         transitive = true
     }
     testImplementation "joda-time:joda-time:2.3"
-    testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.5.4.jar')
+    testImplementation files('/app/libs/aws-advanced-jdbc-wrapper-2.5.5.jar')
     testImplementation dbLibs.postgresql
     testImplementation dbLibs.mysql
     testImplementation dbLibs.h2

wrapper/src/test/resources/hibernate_files/java-module.gradle

@@ -97,7 +97,7 @@ dependencies {
     // Since both the DB2 driver and HANA have a package "net.jpountz" we have to add dependencies conditionally
     // This is due to the "no split-packages" requirement of Java 9+
 
-    testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.5.4.jar')
+    testRuntimeOnly files('/app/libs/aws-advanced-jdbc-wrapper-2.5.5.jar')
     testRuntimeOnly dbLibs.mysql
 
     if ( db.startsWith( 'db2' ) ) {