(commons-configuration) branch master updated: Deprecate DatabaseConfiguration.getDatasource() in favor of getDataSource()

[ggregory]

This is an automated email from the ASF dual-hosted git repository.

ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-configuration.git


The following commit(s) were added to refs/heads/master by this push:
     new bb883412 Deprecate DatabaseConfiguration.getDatasource() in favor of 
getDataSource()
bb883412 is described below

commit bb883412c2ba4ce54c5e1ccfecdcdd170dbbde0d
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue May 7 08:06:45 2024 -0400

    Deprecate DatabaseConfiguration.getDatasource() in favor of
    getDataSource()
---
 src/changes/changes.xml                                     |  1 +
 .../commons/configuration2/DatabaseConfiguration.java       |  6 ++++--
 .../commons/configuration2/TestDatabaseConfiguration.java   | 13 ++++++++++++-
 3 files changed, 17 insertions(+), 3 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 1787ff91..976dfa59 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -39,6 +39,7 @@
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Fail-fast with a 
NullPointerException if ServletContextConfiguration(ServletContext) is called 
with null.</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Fail-fast with a 
NullPointerException if ServletFilterConfiguration(FilterConfig) is called with 
null.</action>
       <action type="fix" dev="ggregory" due-to="Gary Gregory">Fail-fast with a 
NullPointerException if ServletRequestConfiguration(ServletRequest) is called 
with null.</action>
+      <action type="fix" dev="ggregory" due-to="Gary Gregory">Deprecate 
DatabaseConfiguration.getDatasource() in favor of getDataSource().</action>
       <!-- UPDATE -->
       <action type="update" dev="ggregory" due-to="Dependabot">Bump 
commons-logging:commons-logging from 1.3.0 to 1.3.1 #390.</action>
       <action type="update" dev="ggregory" due-to="Dependabot">Bump 
commons-io:commons-io from 2.15.1 to 2.16.1 #394, #400.</action>
diff --git 
a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java 
b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
index 6b34cb0b..2b8b9d12 100644
--- a/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
+++ b/src/main/java/org/apache/commons/configuration2/DatabaseConfiguration.java
@@ -193,9 +193,9 @@ public class DatabaseConfiguration extends 
AbstractConfiguration {
         public T execute() {
             T result = null;
 
-            if (getDatasource() != null) {
+            if (getDataSource() != null) {
                 try {
-                    conn = getDatasource().getConnection();
+                    conn = getDataSource().getConnection();
                     result = performOperation();
 
                     if (isAutoCommit()) {
@@ -519,7 +519,9 @@ public class DatabaseConfiguration extends 
AbstractConfiguration {
      *
      * @return the data source
      * @since 1.4
+     * @deprecated Use {@link #getDataSource()}
      */
+    @Deprecated
     public DataSource getDatasource() {
         return dataSource;
     }
diff --git 
a/src/test/java/org/apache/commons/configuration2/TestDatabaseConfiguration.java
 
b/src/test/java/org/apache/commons/configuration2/TestDatabaseConfiguration.java
index 4acd132a..845e1024 100644
--- 
a/src/test/java/org/apache/commons/configuration2/TestDatabaseConfiguration.java
+++ 
b/src/test/java/org/apache/commons/configuration2/TestDatabaseConfiguration.java
@@ -54,22 +54,33 @@ import org.junit.jupiter.api.Test;
  * tries. Otherwise you may get database is already in use by another process 
errors.
  */
 public class TestDatabaseConfiguration {
+
     /**
      * A specialized database configuration implementation that can be 
configured to throw an exception when obtaining a
      * connection. This way database exceptions can be simulated.
      */
     public static class PotentialErrorDatabaseConfiguration extends 
DatabaseConfiguration {
+
         /** A flag whether a getConnection() call should fail. */
         private boolean failOnConnect;
 
         @Override
         public DataSource getDatasource() {
+            return getDS();
+        }
+
+        @Override
+        public DataSource getDataSource() {
+            return getDS();
+        }
+
+        private DataSource getDS() {
             if (failOnConnect) {
                 final DataSource ds = mock(DataSource.class);
                 assertDoesNotThrow(() -> 
when(ds.getConnection()).thenThrow(new SQLException("Simulated DB error")));
                 return ds;
             }
-            return super.getDatasource();
+            return super.getDataSource();
         }
     }