From 12c5e9ea5d3475c339794a04dd84490409f4f01a Mon Sep 17 00:00:00 2001 From: Rob Bygrave Date: Thu, 2 Sep 2021 22:48:09 +1200 Subject: [PATCH] #2344 - Rename Database.getDataSource() to dataSource() with deprecation --- .../src/main/java/io/ebean/Database.java | 20 +++++++++++++++++-- .../server/core/DScriptRunner.java | 2 +- .../server/core/DefaultServer.java | 6 +++--- .../sqlserver/SqlServerStepSequenceTest.java | 2 +- .../ebeaninternal/api/TDSpiEbeanServer.java | 4 ++-- .../server/rawsql/TestRawSqlBuilder.java | 2 +- ebean-core/src/test/java/org/Main.java | 2 +- .../tests/basic/TestQueryUsingConnection.java | 3 +-- .../org/tests/query/TestQueryFindIterate.java | 2 +- .../dbmigration/DdlGenerator.java | 2 +- .../java/org/querytest/QCustomerTest.java | 2 +- .../java/org/integration/ClusterTest.java | 4 ++-- 12 files changed, 33 insertions(+), 18 deletions(-) diff --git a/ebean-api/src/main/java/io/ebean/Database.java b/ebean-api/src/main/java/io/ebean/Database.java index 4fabcb598..043b775f9 100644 --- a/ebean-api/src/main/java/io/ebean/Database.java +++ b/ebean-api/src/main/java/io/ebean/Database.java @@ -133,12 +133,28 @@ public interface Database { /** * Return the associated DataSource for this Database instance. */ - DataSource getDataSource(); + DataSource dataSource(); + + /** + * Deprecated migrate to dataSource(). + */ + @Deprecated + default DataSource getDataSource() { + return dataSource(); + } /** * Return the associated read only DataSource for this Database instance (can be null). */ - DataSource getReadOnlyDataSource(); + DataSource readOnlyDataSource(); + + /** + * Deprecated migrate to readOnlyDataSource(). + */ + @Deprecated + default DataSource getReadOnlyDataSource() { + return readOnlyDataSource(); + } /** * Return the name. This is used with {@link DB#byName(String)} to get a diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DScriptRunner.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DScriptRunner.java index cb78076bc..0844bdd36 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DScriptRunner.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DScriptRunner.java @@ -102,7 +102,7 @@ final class DScriptRunner implements ScriptRunner { private Connection obtainConnection() { try { - return server.getDataSource().getConnection(); + return server.dataSource().getConnection(); } catch (SQLException e) { throw new PersistenceException("Failed to obtain connection to run script", e); } diff --git a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java index 0f1302f92..92f47b516 100644 --- a/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java +++ b/ebean-core/src/main/java/io/ebeaninternal/server/core/DefaultServer.java @@ -355,12 +355,12 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { } @Override - public DataSource getDataSource() { + public DataSource dataSource() { return transactionManager.getDataSource(); } @Override - public DataSource getReadOnlyDataSource() { + public DataSource readOnlyDataSource() { return transactionManager.getReadOnlyDataSource(); } @@ -635,7 +635,7 @@ public final class DefaultServer implements SpiServer, SpiEbeanServer { @Override public void truncate(String... tables) { - try (Connection connection = getDataSource().getConnection()) { + try (Connection connection = dataSource().getConnection()) { for (String table : tables) { executeSql(connection, databasePlatform.truncateStatement(table)); } diff --git a/ebean-core/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java b/ebean-core/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java index 6c356021b..ff4f3ad05 100644 --- a/ebean-core/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java +++ b/ebean-core/src/test/java/io/ebean/config/dbplatform/sqlserver/SqlServerStepSequenceTest.java @@ -27,7 +27,7 @@ public class SqlServerStepSequenceTest extends BaseTestCase { server().sqlUpdate("create sequence sqls_testseq_9876 start with 1 increment by 50").execute(); BackgroundExecutor be = server().getBackgroundExecutor(); - DataSource ds = server().getDataSource(); + DataSource ds = server().dataSource(); SqlServerStepSequence s = new SqlServerStepSequence(be, ds, "sqls_testseq_9876", 50); diff --git a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java index 2067b4ebb..6c971d831 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java +++ b/ebean-core/src/test/java/io/ebeaninternal/api/TDSpiEbeanServer.java @@ -338,12 +338,12 @@ public class TDSpiEbeanServer implements SpiEbeanServer { } @Override - public DataSource getDataSource() { + public DataSource dataSource() { return null; } @Override - public DataSource getReadOnlyDataSource() { + public DataSource readOnlyDataSource() { return null; } diff --git a/ebean-core/src/test/java/io/ebeaninternal/server/rawsql/TestRawSqlBuilder.java b/ebean-core/src/test/java/io/ebeaninternal/server/rawsql/TestRawSqlBuilder.java index 8d4feeaf9..9fa3fd0a9 100644 --- a/ebean-core/src/test/java/io/ebeaninternal/server/rawsql/TestRawSqlBuilder.java +++ b/ebean-core/src/test/java/io/ebeaninternal/server/rawsql/TestRawSqlBuilder.java @@ -266,7 +266,7 @@ public class TestRawSqlBuilder extends BaseTestCase { "join o_customer c on o.kcustomer_id = c.id " + "where c.id = ? and o.id > ?"; - final DataSource dataSource = DB.getDefault().getDataSource(); + final DataSource dataSource = DB.getDefault().dataSource(); try (Connection connection = dataSource.getConnection()) { try (PreparedStatement stmt = connection.prepareStatement(sql)) { diff --git a/ebean-core/src/test/java/org/Main.java b/ebean-core/src/test/java/org/Main.java index 9ce670947..7489f8056 100644 --- a/ebean-core/src/test/java/org/Main.java +++ b/ebean-core/src/test/java/org/Main.java @@ -15,7 +15,7 @@ public class Main { EbeanServer ms = Ebean.getServer("ms"); - DataSource dataSource = ms.getDataSource(); + DataSource dataSource = ms.dataSource(); Connection connection = dataSource.getConnection(); PreparedStatement statement = connection.prepareStatement("select next VALUE for j2_seq"); diff --git a/ebean-core/src/test/java/org/tests/basic/TestQueryUsingConnection.java b/ebean-core/src/test/java/org/tests/basic/TestQueryUsingConnection.java index 486d3a833..c7aba0ab8 100644 --- a/ebean-core/src/test/java/org/tests/basic/TestQueryUsingConnection.java +++ b/ebean-core/src/test/java/org/tests/basic/TestQueryUsingConnection.java @@ -2,7 +2,6 @@ package org.tests.basic; import io.ebean.BaseTestCase; import io.ebean.DB; -import io.ebean.Database; import io.ebean.Transaction; import io.ebean.annotation.IgnorePlatform; import io.ebean.annotation.Platform; @@ -24,7 +23,7 @@ public class TestQueryUsingConnection extends BaseTestCase { ResetBasicData.reset(); - DataSource dataSource = DB.getDefault().getDataSource(); + DataSource dataSource = DB.getDefault().dataSource(); try (Connection connection = dataSource.getConnection()) { diff --git a/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java b/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java index c2d31a851..0cd41e022 100644 --- a/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java +++ b/ebean-core/src/test/java/org/tests/query/TestQueryFindIterate.java @@ -235,7 +235,7 @@ public class TestQueryFindIterate extends BaseTestCase { SpiServer pluginApi = server().getPluginApi(); DataSourcePool dsPool = (DataSourcePool) pluginApi.getServerConfig().getReadOnlyDataSource(); if (dsPool == null) { - dsPool = (DataSourcePool) server().getDataSource(); + dsPool = (DataSourcePool) server().dataSource(); } int startConns = dsPool.getStatus(false).getBusy(); diff --git a/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java b/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java index 4c9ff9320..f5250827b 100644 --- a/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java +++ b/ebean-ddl-generator/src/main/java/io/ebeaninternal/dbmigration/DdlGenerator.java @@ -141,7 +141,7 @@ public class DdlGenerator implements SpiDdlGenerator { private Connection obtainConnection() { try { - return server.getDataSource().getConnection(); + return server.dataSource().getConnection(); } catch (SQLException e) { throw new PersistenceException("Failed to obtain connection to run DDL", e); } diff --git a/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java b/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java index 867290e71..223f62b0a 100644 --- a/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java +++ b/ebean-querybean/src/test/java/org/querytest/QCustomerTest.java @@ -277,7 +277,7 @@ public class QCustomerTest { cust.setStatus(Customer.Status.GOOD); cust.save(); - DataSource dataSource = DB.getDefault().getDataSource(); + DataSource dataSource = DB.getDefault().dataSource(); try (Connection connection = dataSource.getConnection()) { diff --git a/ebean-redis/src/test/java/org/integration/ClusterTest.java b/ebean-redis/src/test/java/org/integration/ClusterTest.java index 2d1046009..57e4568d7 100644 --- a/ebean-redis/src/test/java/org/integration/ClusterTest.java +++ b/ebean-redis/src/test/java/org/integration/ClusterTest.java @@ -30,7 +30,7 @@ public class ClusterTest { public void testBothNear() { // ensure the default server exists first final Database db = DB.getDefault(); - Database other = createOther(db.getPluginApi().getDataSource()); + Database other = createOther(db.getPluginApi().dataSource()); new QPerson() .name.eq("Someone") @@ -62,7 +62,7 @@ public class ClusterTest { public void test() throws InterruptedException { // ensure the default server exists first final Database db = DB.getDefault(); - Database other = createOther(db.getPluginApi().getDataSource()); + Database other = createOther(db.getPluginApi().dataSource()); for (int i = 0; i < 10; i++) { Person foo = new Person("name " + i);