jdbc: add connection timeout configuration and handling

Added connection property 'socketTimeout' to allow user control over
network timeout before actual connection is returned by the driver.

Implemented 'Connection.setNetworkTimeout' API to make it possible to
change the maximum amount of time to wait for server replies after the
connection is established.

Fixed non-conforming methods to throw SQLException as per standard.

Closes tarantool#38

Author: ztarvos

src/main/java/org/tarantool/TarantoolConnection.java

@@ -4,6 +4,7 @@
 import java.io.InputStream;
 import java.io.OutputStream;
 import java.net.Socket;
+import java.net.SocketException;
 import java.nio.ByteBuffer;
 import java.util.List;
 import java.util.Map;
@@ -80,4 +81,24 @@ protected void sql(String sql, Object[] bind) {
     public boolean isClosed() {
         return socket.isClosed();
     }
+
+    /**
+     * Sets given timeout value on underlying socket.
+     *
+     * @param timeout Timeout in milliseconds.
+     * @throws SocketException If failed.
+     */
+    public void setSocketTimeout(int timeout) throws SocketException {
+        socket.setSoTimeout(timeout);
+    }
+
+    /**
+     * Retrieves timeout value from underlying socket.
+     *
+     * @return Timeout in milliseconds.
+     * @throws SocketException If failed.
+     */
+    public int getSocketTimeout() throws SocketException {
+        return socket.getSoTimeout();
+    }
 }

src/main/java/org/tarantool/jdbc/SQLConnection.java

@@ -1,5 +1,6 @@
 package org.tarantool.jdbc;
 
+import java.io.IOException;
 import java.sql.Array;
 import java.sql.Blob;
 import java.sql.CallableStatement;
@@ -20,6 +21,7 @@
 import java.util.Properties;
 import java.util.concurrent.Executor;
 
+import org.tarantool.CommunicationException;
 import org.tarantool.TarantoolConnection;
 
 @SuppressWarnings("Since15")
@@ -36,12 +38,14 @@ public SQLConnection(TarantoolConnection connection, String url, Properties prop
 
     @Override
     public Statement createStatement() throws SQLException {
-        return new SQLStatement(connection, this);
+        checkNotClosed();
+        return new SQLStatement(this);
     }
 
     @Override
     public PreparedStatement prepareStatement(String sql) throws SQLException {
-        return new SQLPreparedStatement(connection, this, sql);
+        checkNotClosed();
+        return new SQLPreparedStatement(this, sql);
     }
 
     @Override
@@ -89,6 +93,7 @@ public boolean isClosed() throws SQLException {
 
     @Override
     public DatabaseMetaData getMetaData() throws SQLException {
+        checkNotClosed();
         return new SQLDatabaseMetadata(this);
     }
 
@@ -293,15 +298,28 @@ public void abort(Executor executor) throws SQLException {
 
     @Override
     public void setNetworkTimeout(Executor executor, int milliseconds) throws SQLException {
-        throw new SQLFeatureNotSupportedException();
+        checkNotClosed();
+
+        if (milliseconds < 0)
+            throw new SQLException("Network timeout cannot be negative.");
+
+        try {
+            connection.setSocketTimeout(milliseconds);
+        } catch (Exception e) {
+            throw new SQLException("Failed to set socket timeout: timeout=" + milliseconds, e);
+        }
     }
 
     @Override
     public int getNetworkTimeout() throws SQLException {
-        throw new SQLFeatureNotSupportedException();
+        checkNotClosed();
+        try {
+            return connection.getSocketTimeout();
+        } catch (Exception e) {
+            throw new SQLException("Failed to retrieve socket timeout", e);
+        }
     }
 
-
     @Override
     public <T> T unwrap(Class<T> iface) throws SQLException {
         throw new SQLFeatureNotSupportedException();
@@ -311,4 +329,28 @@ public <T> T unwrap(Class<T> iface) throws SQLException {
     public boolean isWrapperFor(Class<?> iface) throws SQLException {
         throw new SQLFeatureNotSupportedException();
     }
+
+    /**
+     * @throws SQLException If connection is closed.
+     */
+    protected void checkNotClosed() throws SQLException {
+        if (isClosed())
+            throw new SQLException("Connection is closed.");
+    }
+
+    /**
+     * Inspects passed exception and closes the connection if appropriate.
+     *
+     * @param e Exception to process.
+     */
+    protected void handleException(Exception e) {
+        if (CommunicationException.class.isAssignableFrom(e.getClass()) ||
+            IOException.class.isAssignableFrom(e.getClass())) {
+            try {
+                close();
+            } catch (Exception ex) {
+                e.addSuppressed(ex);
+            }
+        }
+    }
 }

src/main/java/org/tarantool/jdbc/SQLDatabaseMetadata.java

@@ -672,22 +672,29 @@ protected boolean like(String value, String[] parts) {
     @Override
     public ResultSet getTables(String catalog, String schemaPattern, String tableNamePattern, String[] types)
             throws SQLException {
-        if (types != null && !Arrays.asList(types).contains("TABLE")) {
-            return new SQLResultSet(JDBCBridge.EMPTY);
-        }
-        String[] parts = tableNamePattern == null ? new String[]{""} : tableNamePattern.split("%");
-        List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 0, Arrays.asList(), 0, SPACES_MAX, 0);
-        List<List<Object>> rows = new ArrayList<List<Object>>();
-        for (List<Object> space : spaces) {
-            String name = (String) space.get(NAME_IDX);
-            Map flags = (Map) space.get(FLAGS_IDX);
-            if (flags != null && flags.containsKey("sql") && like(name, parts)) {
-                rows.add(Arrays.asList(name, "TABLE", flags.get("sql")));
+        connection.checkNotClosed();
+        try {
+            if (types != null && !Arrays.asList(types).contains("TABLE")) {
+                return new SQLResultSet(JDBCBridge.EMPTY);
+            }
+            String[] parts = tableNamePattern == null ? new String[]{""} : tableNamePattern.split("%");
+            List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 0, Arrays.asList(), 0, SPACES_MAX, 0);
+            List<List<Object>> rows = new ArrayList<List<Object>>();
+            for (List<Object> space : spaces) {
+                String name = (String) space.get(NAME_IDX);
+                Map flags = (Map) space.get(FLAGS_IDX);
+                if (flags != null && flags.containsKey("sql") && like(name, parts)) {
+                    rows.add(Arrays.asList(name, "TABLE", flags.get("sql")));
+                }
             }
+            return new SQLNullResultSet(JDBCBridge.mock(Arrays.asList("TABLE_NAME", "TABLE_TYPE", "REMARKS",
+                    //nulls
+                    "TABLE_CAT", "TABLE_SCHEM", "TABLE_TYPE", "TYPE_CAT", "TYPE_SCHEM", "TYPE_NAME", "SELF_REFERENCING_COL_NAME", "REF_GENERATION"), rows));
+        } catch (Exception e) {
+            connection.handleException(e);
+            throw new SQLException("Failed to retrieve table(s) description: " +
+                    "tableNamePattern=" + tableNamePattern, e);
         }
-        return new SQLNullResultSet(JDBCBridge.mock(Arrays.asList("TABLE_NAME", "TABLE_TYPE", "REMARKS",
-                //nulls
-                "TABLE_CAT", "TABLE_SCHEM", "TABLE_TYPE", "TYPE_CAT", "TYPE_SCHEM", "TYPE_NAME", "SELF_REFERENCING_COL_NAME", "REF_GENERATION"), rows));
     }
 
     @Override
@@ -712,32 +719,41 @@ public ResultSet getTableTypes() throws SQLException {
     @Override
     public ResultSet getColumns(String catalog, String schemaPattern, String tableNamePattern, String columnNamePattern)
             throws SQLException {
-        String[] tableParts = tableNamePattern == null ? new String[]{""} : tableNamePattern.split("%");
-        String[] colParts = columnNamePattern == null ? new String[]{""} : columnNamePattern.split("%");
-        List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 0, Arrays.asList(), 0, SPACES_MAX, 0);
-        List<List<Object>> rows = new ArrayList<List<Object>>();
-        for (List<Object> space : spaces) {
-            String tableName = (String) space.get(NAME_IDX);
-            Map flags = (Map) space.get(FLAGS_IDX);
-            if (flags != null && flags.containsKey("sql") && like(tableName, tableParts)) {
-                List<Map<String, Object>> format = (List<Map<String, Object>>) space.get(FORMAT_IDX);
-                for (int columnIdx = 1; columnIdx <= format.size(); columnIdx++) {
-                    Map<String, Object> f = format.get(columnIdx - 1);
-                    String columnName = (String) f.get("name");
-                    String dbType = (String) f.get("type");
-                    if (like(columnName, colParts)) {
-                        rows.add(Arrays.<Object>asList(tableName, columnName, columnIdx, Types.OTHER, dbType, 10, 1, "YES", Types.OTHER, "NO", "NO"));
+        connection.checkNotClosed();
+        try {
+            String[] tableParts = tableNamePattern == null ? new String[]{""} : tableNamePattern.split("%");
+            String[] colParts = columnNamePattern == null ? new String[]{""} : columnNamePattern.split("%");
+            List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 0, Arrays.asList(), 0, SPACES_MAX, 0);
+            List<List<Object>> rows = new ArrayList<List<Object>>();
+            for (List<Object> space : spaces) {
+                String tableName = (String) space.get(NAME_IDX);
+                Map flags = (Map) space.get(FLAGS_IDX);
+                if (flags != null && flags.containsKey("sql") && like(tableName, tableParts)) {
+                    List<Map<String, Object>> format = (List<Map<String, Object>>) space.get(FORMAT_IDX);
+                    for (int columnIdx = 1; columnIdx <= format.size(); columnIdx++) {
+                        Map<String, Object> f = format.get(columnIdx - 1);
+                        String columnName = (String) f.get("name");
+                        String dbType = (String) f.get("type");
+                        if (like(columnName, colParts)) {
+                            rows.add(Arrays.<Object>asList(tableName, columnName, columnIdx, Types.OTHER, dbType, 10, 1, "YES", Types.OTHER, "NO", "NO"));
+                        }
                     }
                 }
             }
-        }
 
-        return new SQLNullResultSet((JDBCBridge.mock(
-                Arrays.asList("TABLE_NAME", "COLUMN_NAME", "ORDINAL_POSITION", "DATA_TYPE", "TYPE_NAME", "NUM_PREC_RADIX", "NULLABLE", "IS_NULLABLE", "SOURCE_DATA_TYPE", "IS_AUTOINCREMENT", "IS_GENERATEDCOLUMN",
-                        //nulls
-                        "TABLE_CAT", "TABLE_SCHEM", "COLUMN_SIZE", "BUFFER_LENGTH", "DECIMAL_DIGITS", "REMARKS", "COLUMN_DEF", "SQL_DATA_TYPE", "SQL_DATETIME_SUB", "CHAR_OCTET_LENGTH", "SCOPE_CATALOG", "SCOPE_SCHEMA", "SCOPE_TABLE"
-                ),
-                rows)));
+            return new SQLNullResultSet((JDBCBridge.mock(
+                    Arrays.asList("TABLE_NAME", "COLUMN_NAME", "ORDINAL_POSITION", "DATA_TYPE", "TYPE_NAME", "NUM_PREC_RADIX", "NULLABLE", "IS_NULLABLE", "SOURCE_DATA_TYPE", "IS_AUTOINCREMENT", "IS_GENERATEDCOLUMN",
+                            //nulls
+                            "TABLE_CAT", "TABLE_SCHEM", "COLUMN_SIZE", "BUFFER_LENGTH", "DECIMAL_DIGITS", "REMARKS", "COLUMN_DEF", "SQL_DATA_TYPE", "SQL_DATETIME_SUB", "CHAR_OCTET_LENGTH", "SCOPE_CATALOG", "SCOPE_SCHEMA", "SCOPE_TABLE"
+                    ),
+                    rows)));
+        } catch (Exception e) {
+            connection.handleException(e);
+            throw new SQLException(
+                    "Failed to retrieve column(s) description: " +
+                    "tableNamePattern=" + tableNamePattern +
+                    "columnNamePattern=" + columnNamePattern, e);
+        }
     }
 
     @Override
@@ -765,29 +781,35 @@ public ResultSet getVersionColumns(String catalog, String schema, String table)
 
     @Override
     public ResultSet getPrimaryKeys(String catalog, String schema, String table) throws SQLException {
-        List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 2, Arrays.asList(table), 0, 1, 0);
-
-        List<List<Object>> rows = new ArrayList<List<Object>>();
-
-        if (spaces != null && spaces.size() > 0) {
-            List<Object> space = spaces.get(0);
-            List<Map<String, Object>> fields = (List<Map<String, Object>>) space.get(FORMAT_IDX);
-            List<List<Object>> indexes = (List<List<Object>>) connection.connection.select(_VINDEX, 0, Arrays.asList(space.get(SPACE_ID_IDX), 0), 0, 1, 0);
-            List<Object> primaryKey = indexes.get(0);
-            List<List<Object>> parts = (List<List<Object>>) primaryKey.get(INDEX_FORMAT_IDX);
-            for (int i = 0; i < parts.size(); i++) {
-                List<Object> part = parts.get(i);
-                int ordinal = ((Number) part.get(0)).intValue();
-                String column = (String) fields.get(ordinal).get("name");
-                rows.add(Arrays.asList(table, column, i + 1, "primary", primaryKey.get(NAME_IDX)));
+        connection.checkNotClosed();
+        try {
+            List<List<Object>> spaces = (List<List<Object>>) connection.connection.select(_VSPACE, 2, Arrays.asList(table), 0, 1, 0);
+
+            List<List<Object>> rows = new ArrayList<List<Object>>();
+
+            if (spaces != null && spaces.size() > 0) {
+                List<Object> space = spaces.get(0);
+                List<Map<String, Object>> fields = (List<Map<String, Object>>) space.get(FORMAT_IDX);
+                List<List<Object>> indexes = (List<List<Object>>) connection.connection.select(_VINDEX, 0, Arrays.asList(space.get(SPACE_ID_IDX), 0), 0, 1, 0);
+                List<Object> primaryKey = indexes.get(0);
+                List<List<Object>> parts = (List<List<Object>>) primaryKey.get(INDEX_FORMAT_IDX);
+                for (int i = 0; i < parts.size(); i++) {
+                    List<Object> part = parts.get(i);
+                    int ordinal = ((Number) part.get(0)).intValue();
+                    String column = (String) fields.get(ordinal).get("name");
+                    rows.add(Arrays.asList(table, column, i + 1, "primary", primaryKey.get(NAME_IDX)));
+                }
             }
+            return new SQLNullResultSet((JDBCBridge.mock(
+                    Arrays.asList("TABLE_NAME", "COLUMN_NAME", "KEY_SEQ", "PK_NAME",
+                            //nulls
+                            "TABLE_CAT", "TABLE_SCHEM"
+                    ),
+                    rows)));
+        } catch (Exception e) {
+            connection.handleException(e);
+            throw new SQLException("Failed to retrieve primary key(s) description: table=" + table, e);
         }
-        return new SQLNullResultSet((JDBCBridge.mock(
-                Arrays.asList("TABLE_NAME", "COLUMN_NAME", "KEY_SEQ", "PK_NAME",
-                        //nulls
-                        "TABLE_CAT", "TABLE_SCHEM"
-                ),
-                rows)));
     }
 
     @Override