Deprecate DatabaseConfiguration.getDatasource() in favor of
getDataSource()
diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 1787ff9..976dfa5 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 6b34cb0..2b8b9d1 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 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 @@
*
* @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 4acd132..845e102 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 @@
* 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();
}
}
