Add a simple DataSource implementation

nicktorwald · nicktorwald · commit 7e20a2f818cc · 2019-05-09T01:25:33.000+07:00
Implement the DataSource interface to be more compatible with JDBC spec. Add JDBC standard and Tarantool specific properties (getters/setters) to follow enterprise features (according to JavaBeans spec). Closes: #175
diff --git a/README.md b/README.md
@@ -132,13 +132,13 @@ To configure socket channel provider you should implements SocketChannelProvider
 For example:
 
 ```
-tarantool://localhost:3301?user=test&password=test&socketProvider=abc.xyz.MySocketProvider
+jdbc:tarantool://localhost:3301?user=test&password=test&socketProvider=abc.xyz.MySocketProvider
 ```
 
 Here is an example how you can use the driver covered by Spring `DriverManagerDataSource`:
 
 ```java
-NamedParameterJdbcTemplate template = new NamedParameterJdbcTemplate(new DriverManagerDataSource("tarantool://localhost:3301?user=test&password=test"));
+NamedParameterJdbcTemplate template = new NamedParameterJdbcTemplate(new DriverManagerDataSource("jdbc:tarantool://localhost:3301?user=test&password=test"));
 RowMapper<Object> rowMapper = new RowMapper<Object>() {
     @Override
     public Object mapRow(ResultSet resultSet, int i) throws SQLException {
diff --git a/src/it/java/org/tarantool/TestSql.java b/src/it/java/org/tarantool/TestSql.java
@@ -36,7 +36,7 @@
 //
 //    public static void main(String[] args) throws IOException, SQLException {
 //
-//        NamedParameterJdbcTemplate template = new NamedParameterJdbcTemplate(new DriverManagerDataSource("tarantool://localhost:3301?username=test&password=test&socketProvider=org.tarantool.TestSql$TestSocketProvider"));
+//        NamedParameterJdbcTemplate template = new NamedParameterJdbcTemplate(new DriverManagerDataSource("jdbc:tarantool://localhost:3301?username=test&password=test&socketProvider=org.tarantool.TestSql$TestSocketProvider"));
 //        RowMapper<Object> rowMapper = new RowMapper<Object>() {
 //            @Override
 //            public Object mapRow(ResultSet resultSet, int i) throws SQLException {
diff --git a/src/main/java/org/tarantool/jdbc/SQLConnection.java b/src/main/java/org/tarantool/jdbc/SQLConnection.java
@@ -58,7 +58,7 @@ public class SQLConnection implements Connection {
     private DatabaseMetaData cachedMetadata;
     private int resultSetHoldability = UNSET_HOLDABILITY;
 
-    SQLConnection(String url, Properties properties) throws SQLException {
+    public SQLConnection(String url, Properties properties) throws SQLException {
         this.url = url;
         this.properties = properties;
 
diff --git a/src/main/java/org/tarantool/jdbc/SQLDriver.java b/src/main/java/org/tarantool/jdbc/SQLDriver.java
@@ -57,6 +57,9 @@ protected SQLTarantoolClientImpl makeSqlClient(String address, TarantoolClientCo
     protected Properties parseQueryString(URI uri, Properties info) throws SQLException {
         Properties urlProperties = new Properties();
 
+        // get scheme specific part (after the scheme part "jdbc:")
+        // to correct parse remaining URL
+        uri = URI.create(uri.getSchemeSpecificPart());
         String userInfo = uri.getUserInfo();
         if (userInfo != null) {
             // Get user and password from the corresponding part of the URI, i.e. before @ sign.
@@ -140,7 +143,7 @@ protected SocketChannelProvider getSocketProviderInstance(String className) thro
 
     @Override
     public boolean acceptsURL(String url) throws SQLException {
-        return url.toLowerCase().startsWith("tarantool:");
+        return url.toLowerCase().startsWith("jdbc:tarantool:");
     }
 
     @Override
diff --git a/src/main/java/org/tarantool/jdbc/SQLProperty.java b/src/main/java/org/tarantool/jdbc/SQLProperty.java
@@ -44,7 +44,7 @@ public enum SQLProperty {
     INIT_TIMEOUT(
         "initTimeout",
         "The number of milliseconds to wait for connection establishment. " +
-            "The default value is 60000 (1 minute).",
+            "The default system value is 60000 (1 minute).",
         "60000",
         null,
         false
@@ -84,6 +84,10 @@ public String getDefaultValue() {
         return defaultValue;
     }
 
+    public int getDefaultIntValue() {
+        return Integer.parseInt(defaultValue);
+    }
+
     public boolean isRequired() {
         return required;
     }
diff --git a/src/main/java/org/tarantool/jdbc/ds/SQLDataSource.java b/src/main/java/org/tarantool/jdbc/ds/SQLDataSource.java
@@ -0,0 +1,163 @@
+package org.tarantool.jdbc.ds;
+
+import org.tarantool.jdbc.SQLConnection;
+import org.tarantool.jdbc.SQLProperty;
+
+import java.io.PrintWriter;
+import java.sql.Connection;
+import java.sql.SQLException;
+import java.sql.SQLFeatureNotSupportedException;
+import java.sql.SQLNonTransientException;
+import java.util.Properties;
+import java.util.concurrent.TimeUnit;
+import java.util.logging.Logger;
+import javax.sql.DataSource;
+
+/**
+ * Simple {@code java.sql.DataSource} implementation.
+ */
+public class SQLDataSource implements TarantoolDataSource, DataSource {
+
+    private PrintWriter logWriter;
+    private String description;
+    private String name;
+
+    private Properties properties = new Properties();
+
+    @Override
+    public Connection getConnection() throws SQLException {
+        return new SQLConnection(makeUrl(), new Properties(properties));
+    }
+
+    @Override
+    public Connection getConnection(String username, String password) throws SQLException {
+        Properties copyProperties = new Properties(properties);
+        SQLProperty.USER.setString(copyProperties, username);
+        SQLProperty.PASSWORD.setString(copyProperties, password);
+        return new SQLConnection(makeUrl(), copyProperties);
+    }
+
+    @Override
+    public PrintWriter getLogWriter() {
+        return logWriter;
+    }
+
+    @Override
+    public void setLogWriter(PrintWriter out) {
+        logWriter = out;
+    }
+
+    @Override
+    public void setLoginTimeout(int seconds) {
+        SQLProperty.INIT_TIMEOUT.setInt(properties, (int) TimeUnit.SECONDS.toMillis(seconds));
+    }
+
+    @Override
+    public int getLoginTimeout() throws SQLException {
+        return (int) TimeUnit.MILLISECONDS.toSeconds(SQLProperty.INIT_TIMEOUT.getInt(properties));
+    }
+
+    @Override
+    public Logger getParentLogger() throws SQLFeatureNotSupportedException {
+        throw new SQLFeatureNotSupportedException();
+    }
+
+    @Override
+    public <T> T unwrap(Class<T> type) throws SQLException {
+        if (isWrapperFor(type)) {
+            return type.cast(this);
+        }
+        throw new SQLNonTransientException("Statement does not wrap " + type.getName());
+    }
+
+    @Override
+    public boolean isWrapperFor(Class<?> type) {
+        return type.isAssignableFrom(this.getClass());
+    }
+
+    @Override
+    public String getServerName() {
+        return SQLProperty.HOST.getString(properties);
+    }
+
+    @Override
+    public void setServerName(String serverName) {
+        SQLProperty.HOST.setString(properties, serverName);
+    }
+
+    @Override
+    public int getPortNumber() throws SQLException {
+        return SQLProperty.PORT.getInt(properties);
+    }
+
+    @Override
+    public void setPortNumber(int port) {
+        SQLProperty.PORT.setInt(properties, port);
+    }
+
+    @Override
+    public String getUser() {
+        return SQLProperty.USER.getString(properties);
+    }
+
+    @Override
+    public void setUser(String userName) {
+        SQLProperty.USER.setString(properties, userName);
+    }
+
+    @Override
+    public String getPassword() {
+        return SQLProperty.PASSWORD.getString(properties);
+    }
+
+    @Override
+    public void setPassword(String password) {
+        SQLProperty.PASSWORD.setString(properties, password);
+    }
+
+    @Override
+    public String getDescription() {
+        return description;
+    }
+
+    @Override
+    public void setDescription(String description) {
+        this.description = description;
+    }
+
+    @Override
+    public String getDataSourceName() {
+        return name;
+    }
+
+    @Override
+    public void setDataSourceName(String name) {
+        this.name = name;
+    }
+
+    @Override
+    public String getSocketChannelProvider() {
+        return SQLProperty.SOCKET_CHANNEL_PROVIDER.getString(properties);
+    }
+
+    @Override
+    public void setSocketChannelProvider(String classFqdn) {
+        SQLProperty.SOCKET_CHANNEL_PROVIDER.setString(properties, classFqdn);
+    }
+
+    @Override
+    public int getRequestTimeout() throws SQLException {
+        return (int) TimeUnit.MILLISECONDS.toSeconds(SQLProperty.REQUEST_TIMEOUT.getInt(properties));
+    }
+
+    @Override
+    public void setRequestTimeout(int seconds) {
+        SQLProperty.REQUEST_TIMEOUT.setInt(properties, (int) TimeUnit.SECONDS.toMillis(seconds));
+    }
+
+    private String makeUrl() {
+        return "jdbc:tarantool://" +
+            SQLProperty.HOST.getString(properties) + ":" + SQLProperty.PORT.getString(properties);
+    }
+
+}
diff --git a/src/main/java/org/tarantool/jdbc/ds/TarantoolDataSource.java b/src/main/java/org/tarantool/jdbc/ds/TarantoolDataSource.java
@@ -0,0 +1,42 @@
+package org.tarantool.jdbc.ds;
+
+import java.sql.SQLException;
+
+/**
+ * JDBC standard  Tarantool specific data source properties.
+ */
+public interface TarantoolDataSource {
+
+    String getServerName() throws SQLException;
+
+    void setServerName(String serverName) throws SQLException;
+
+    int getPortNumber() throws SQLException;
+
+    void setPortNumber(int port) throws SQLException;
+
+    String getUser() throws SQLException;
+
+    void setUser(String userName) throws SQLException;
+
+    String getPassword() throws SQLException;
+
+    void setPassword(String password) throws SQLException;
+
+    String getDescription() throws SQLException;
+
+    void setDescription(String description) throws SQLException;
+
+    String getDataSourceName() throws SQLException;
+
+    void setDataSourceName(String name) throws SQLException;
+
+    String getSocketChannelProvider() throws SQLException;
+
+    void setSocketChannelProvider(String classFqdn) throws SQLException;
+
+    int getRequestTimeout() throws SQLException;
+
+    void setRequestTimeout(int seconds) throws SQLException;
+
+}
diff --git a/src/test/java/org/tarantool/jdbc/AbstractJdbcIT.java b/src/test/java/org/tarantool/jdbc/AbstractJdbcIT.java
@@ -26,7 +26,7 @@ public abstract class AbstractJdbcIT {
     private static final Integer port = Integer.valueOf(System.getProperty("tntPort", "3301"));
     private static final String user = System.getProperty("tntUser", "test_admin");
     private static final String pass = System.getProperty("tntPass", "4pWBZmLEgkmKK5WP");
-    private static String URL = String.format("tarantool://%s:%d?user=%s&password=%s", host, port, user, pass);
+    private static String URL = String.format("jdbc:tarantool://%s:%d?user=%s&password=%s", host, port, user, pass);
 
     protected static final String LUA_FILE = "jdk-testing.lua";
     protected static final int LISTEN = 3301;
diff --git a/src/test/java/org/tarantool/jdbc/JdbcDriverTest.java b/src/test/java/org/tarantool/jdbc/JdbcDriverTest.java
@@ -34,7 +34,7 @@ public void testParseQueryString() throws Exception {
         SQLProperty.PASSWORD.setString(prop, "secret");
 
         URI uri = new URI(String.format(
-            "tarantool://server.local:3302?%s=%s&%s=%d",
+            "jdbc:tarantool://server.local:3302?%s=%s&%s=%d",
             SQLProperty.SOCKET_CHANNEL_PROVIDER.getName(), "some.class",
             SQLProperty.REQUEST_TIMEOUT.getName(), 5000)
         );
@@ -53,7 +53,7 @@ public void testParseQueryString() throws Exception {
     @Test
     public void testParseQueryStringUserInfoInURI() throws Exception {
         SQLDriver drv = new SQLDriver();
-        Properties result = drv.parseQueryString(new URI("tarantool://adm:secret@server.local"), null);
+        Properties result = drv.parseQueryString(new URI("jdbc:tarantool://adm:secret@server.local"), null);
         assertNotNull(result);
         assertEquals("server.local", SQLProperty.HOST.getString(result));
         assertEquals("3301", SQLProperty.PORT.getString(result));
@@ -64,7 +64,7 @@ public void testParseQueryStringUserInfoInURI() throws Exception {
     @Test
     public void testParseQueryStringValidations() {
         // Check non-number port
-        checkParseQueryStringValidation("tarantool://0",
+        checkParseQueryStringValidation("jdbc:tarantool://0",
             new Properties() {
                 {
                     SQLProperty.PORT.setString(this, "nan");
@@ -73,35 +73,35 @@ public void testParseQueryStringValidations() {
             "Property port must be a valid number.");
 
         // Check zero port
-        checkParseQueryStringValidation("tarantool://0:0", null, "Port is out of range: 0");
+        checkParseQueryStringValidation("jdbc:tarantool://0:0", null, "Port is out of range: 0");
 
         // Check high port
-        checkParseQueryStringValidation("tarantool://0:65536", null, "Port is out of range: 65536");
+        checkParseQueryStringValidation("jdbc:tarantool://0:65536", null, "Port is out of range: 65536");
 
         // Check non-number init timeout
         checkParseQueryStringValidation(
-            String.format("tarantool://0:3301?%s=nan", SQLProperty.INIT_TIMEOUT.getName()),
+            String.format("jdbc:tarantool://0:3301?%s=nan", SQLProperty.INIT_TIMEOUT.getName()),
             null,
             "Property initTimeout must be a valid number."
         );
 
         // Check negative init timeout
         checkParseQueryStringValidation(
-            String.format("tarantool://0:3301?%s=-100", SQLProperty.INIT_TIMEOUT.getName()),
+            String.format("jdbc:tarantool://0:3301?%s=-100", SQLProperty.INIT_TIMEOUT.getName()),
             null,
             "Property initTimeout must not be negative."
         );
 
         // Check non-number operation timeout
         checkParseQueryStringValidation(
-            String.format("tarantool://0:3301?%s=nan", SQLProperty.REQUEST_TIMEOUT.getName()),
+            String.format("jdbc:tarantool://0:3301?%s=nan", SQLProperty.REQUEST_TIMEOUT.getName()),
             null,
             "Property requestTimeout must be a valid number."
         );
 
         // Check negative operation timeout
         checkParseQueryStringValidation(
-            String.format("tarantool://0:3301?%s=-100", SQLProperty.REQUEST_TIMEOUT.getName()),
+            String.format("jdbc:tarantool://0:3301?%s=-100", SQLProperty.REQUEST_TIMEOUT.getName()),
             null,
             "Property requestTimeout must not be negative."
         );
@@ -111,7 +111,7 @@ public void testParseQueryStringValidations() {
     public void testGetPropertyInfo() throws SQLException {
         Driver drv = new SQLDriver();
         Properties props = new Properties();
-        DriverPropertyInfo[] info = drv.getPropertyInfo("tarantool://server.local:3302", props);
+        DriverPropertyInfo[] info = drv.getPropertyInfo("jdbc:tarantool://server.local:3302", props);
         assertNotNull(info);
         assertEquals(7, info.length);
 
@@ -167,7 +167,7 @@ public void testNoResponseAfterInitialConnect() throws IOException {
         ServerSocket socket = new ServerSocket();
         socket.bind(null, 0);
         try {
-            final String url = "tarantool://localhost:" + socket.getLocalPort();
+            final String url = "jdbc:tarantool://localhost:" + socket.getLocalPort();
             final Properties prop = new Properties();
             SQLProperty.INIT_TIMEOUT.setInt(prop, 500);
             SQLException e = assertThrows(SQLException.class, new Executable() {
@@ -184,12 +184,12 @@ public void execute() throws Throwable {
     }
 
     private void checkCustomSocketProviderFail(String providerClassName, String errMsg) throws SQLException {
-        final Driver drv = DriverManager.getDriver("tarantool:");
+        final Driver drv = DriverManager.getDriver("jdbc:tarantool:");
         final Properties prop = new Properties();
         SQLProperty.SOCKET_CHANNEL_PROVIDER.setString(prop, providerClassName);
         SQLProperty.INIT_TIMEOUT.setInt(prop, 500);
 
-        SQLException e = assertThrows(SQLException.class, () -> drv.connect("tarantool://0:3301", prop));
+        SQLException e = assertThrows(SQLException.class, () -> drv.connect("jdbc:tarantool://0:3301", prop));
         assertTrue(e.getMessage().startsWith(errMsg), e.getMessage());
     }
 
diff --git a/src/test/java/org/tarantool/jdbc/JdbcExceptionHandlingTest.java b/src/test/java/org/tarantool/jdbc/JdbcExceptionHandlingTest.java
diff --git a/src/test/java/org/tarantool/jdbc/ds/JdbcDataSourceIT.java b/src/test/java/org/tarantool/jdbc/ds/JdbcDataSourceIT.java
