Add Driver#createConnectOptions

aguibert · aguibert · commit 6400b8c8937f · 2020-05-29T15:05:46.000-05:00
Also deprecate generic construction of SqlConnectOptions
diff --git a/vertx-db2-client/src/main/java/io/vertx/db2client/DB2ConnectOptions.java b/vertx-db2-client/src/main/java/io/vertx/db2client/DB2ConnectOptions.java
@@ -88,7 +88,7 @@ public DB2ConnectOptions(DB2ConnectOptions other) {
     super(other);
     this.pipeliningLimit = other.pipeliningLimit;
   }
-
+  
   @Override
   public DB2ConnectOptions setHost(String host) {
     return (DB2ConnectOptions) super.setHost(host);
@@ -210,6 +210,6 @@ public boolean equals(Object o) {
 
   @Override
   public int hashCode() {
-    return Objects.hash(pipeliningLimit);
+    return Objects.hash(super.hashCode(), pipeliningLimit);
   }
 }
diff --git a/vertx-db2-client/src/main/java/io/vertx/db2client/DB2Exception.java b/vertx-db2-client/src/main/java/io/vertx/db2client/DB2Exception.java
@@ -55,6 +55,6 @@ public String getSqlState() {
    */
   @Override
   public String getMessage() {
-    return super.getMessage();
+    return super.getMessage() + "; errorCode=" + errorCode + "; sqlState=" + sqlState;
   }
 }
diff --git a/vertx-db2-client/src/main/java/io/vertx/db2client/spi/DB2Driver.java b/vertx-db2-client/src/main/java/io/vertx/db2client/spi/DB2Driver.java
@@ -24,7 +24,7 @@
 import io.vertx.sqlclient.spi.Driver;
 
 public class DB2Driver implements Driver {
-
+  
   @Override
   public Pool createPool(SqlConnectOptions options, PoolOptions poolOptions) {
     return DB2Pool.pool(wrap(options), poolOptions);
@@ -35,17 +35,24 @@ public Pool createPool(Vertx vertx, SqlConnectOptions options, PoolOptions poolO
     return DB2Pool.pool(vertx, wrap(options), poolOptions);
   }
 
-  @Override
-  public boolean acceptsOptions(SqlConnectOptions options) {
-    return options instanceof DB2ConnectOptions || SqlConnectOptions.class.equals(options.getClass());
-  }
-  
   private static DB2ConnectOptions wrap(SqlConnectOptions options) {
     if (options instanceof DB2ConnectOptions) {
-      return (DB2ConnectOptions) options; 
-    } else {
+      return (DB2ConnectOptions) options;
+    } else if (options.getClass().equals(SqlConnectOptions.class)) {
       return new DB2ConnectOptions(options);
+    } else {
+      throw new IllegalArgumentException("Unsupported option type: " + options.getClass());
     }
   }
 
+  @Override
+  public SqlConnectOptions createConnectOptions() {
+    return new DB2ConnectOptions();
+  }
+
+  @Override
+  public String name() {
+    return KnownDrivers.DB2.name();
+  }
+
 }
diff --git a/vertx-db2-client/src/test/java/io/vertx/db2client/tck/DB2DriverTest.java b/vertx-db2-client/src/test/java/io/vertx/db2client/tck/DB2DriverTest.java
@@ -46,4 +46,9 @@ protected SqlConnectOptions defaultOptions() {
     return rule.options();
   }
 
+  @Override
+  protected String getDriverName() {
+    return "DB2";
+  }
+  
 }
diff --git a/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/MSSQLConnectOptions.java b/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/MSSQLConnectOptions.java
@@ -11,6 +11,11 @@
 
 package io.vertx.mssqlclient;
 
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Set;
+import java.util.concurrent.TimeUnit;
+
 import io.vertx.codegen.annotations.DataObject;
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.json.JsonObject;
@@ -26,11 +31,6 @@
 import io.vertx.core.net.TrustOptions;
 import io.vertx.sqlclient.SqlConnectOptions;
 
-import java.util.HashMap;
-import java.util.Map;
-import java.util.Set;
-import java.util.concurrent.TimeUnit;
-
 /**
  * Connect options for configuring {@link MSSQLConnection}.
  */
@@ -68,7 +68,7 @@ public MSSQLConnectOptions(SqlConnectOptions other) {
   public MSSQLConnectOptions(MSSQLConnectOptions other) {
     super(other);
   }
-
+  
   @Override
   public MSSQLConnectOptions setHost(String host) {
     return (MSSQLConnectOptions) super.setHost(host);
diff --git a/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/spi/MSSQLDriver.java b/vertx-mssql-client/src/main/java/io/vertx/mssqlclient/spi/MSSQLDriver.java
@@ -24,7 +24,7 @@
 import io.vertx.sqlclient.spi.Driver;
 
 public class MSSQLDriver implements Driver {
-
+  
   @Override
   public Pool createPool(SqlConnectOptions options, PoolOptions poolOptions) {
     return MSSQLPool.pool(wrap(options), poolOptions);
@@ -35,17 +35,24 @@ public Pool createPool(Vertx vertx, SqlConnectOptions options, PoolOptions poolO
     return MSSQLPool.pool(vertx, wrap(options), poolOptions);
   }
 
-  @Override
-  public boolean acceptsOptions(SqlConnectOptions options) {
-    return options instanceof MSSQLConnectOptions || SqlConnectOptions.class.equals(options.getClass());
-  }
-  
   private static MSSQLConnectOptions wrap(SqlConnectOptions options) {
     if (options instanceof MSSQLConnectOptions) {
       return (MSSQLConnectOptions) options; 
-    } else {
+    } else if (SqlConnectOptions.class.equals(options.getClass())) {
       return new MSSQLConnectOptions(options);
+    } else {
+      throw new IllegalArgumentException("Unsupported option type: " + options.getClass());
     }
   }
 
+  @Override
+  public SqlConnectOptions createConnectOptions() {
+    return new MSSQLConnectOptions();
+  }
+
+  @Override
+  public String name() {
+    return KnownDrivers.SQLSERVER.name();
+  }
+
 }
diff --git a/vertx-mssql-client/src/test/java/io/vertx/mssqlclient/tck/MSSQLDriverTest.java b/vertx-mssql-client/src/test/java/io/vertx/mssqlclient/tck/MSSQLDriverTest.java
@@ -33,5 +33,10 @@ public class MSSQLDriverTest extends DriverTestBase {
   protected SqlConnectOptions defaultOptions() {
     return rule.options();
   }
-
+  
+  @Override
+  protected String getDriverName() {
+    return "SQLSERVER";
+  }
+  
 }
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/MySQLConnectOptions.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/MySQLConnectOptions.java
@@ -92,7 +92,7 @@ public MySQLConnectOptions(MySQLConnectOptions other) {
     this.serverRsaPublicKeyPath = other.serverRsaPublicKeyPath;
     this.serverRsaPublicKeyValue = other.serverRsaPublicKeyValue != null ? other.serverRsaPublicKeyValue.copy() : null;
   }
-
+  
   /**
    * Get the collation for the connection.
    *
diff --git a/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/spi/MySQLDriver.java b/vertx-mysql-client/src/main/java/io/vertx/mysqlclient/spi/MySQLDriver.java
@@ -24,7 +24,7 @@
 import io.vertx.sqlclient.spi.Driver;
 
 public class MySQLDriver implements Driver {
-
+  
   @Override
   public Pool createPool(SqlConnectOptions options, PoolOptions poolOptions) {
     return MySQLPool.pool(wrap(options), poolOptions);
@@ -35,17 +35,24 @@ public Pool createPool(Vertx vertx, SqlConnectOptions options, PoolOptions poolO
     return MySQLPool.pool(vertx, wrap(options), poolOptions);
   }
 
-  @Override
-  public boolean acceptsOptions(SqlConnectOptions options) {
-    return options instanceof MySQLConnectOptions || SqlConnectOptions.class.equals(options.getClass());
-  }
-  
   private static MySQLConnectOptions wrap(SqlConnectOptions options) {
     if (options instanceof MySQLConnectOptions) {
-      return (MySQLConnectOptions) options; 
-    } else {
+      return (MySQLConnectOptions) options;
+    } else if (options.getClass().equals(SqlConnectOptions.class)) {
       return new MySQLConnectOptions(options);
+    } else {
+      throw new IllegalArgumentException("Unsupported option type: " + options.getClass());
     }
   }
+  
+  @Override
+  public SqlConnectOptions createConnectOptions() {
+    return new MySQLConnectOptions();
+  }
+  
+  @Override
+  public String name() {
+    return "MYSQL";
+  }
 
 }
diff --git a/vertx-mysql-client/src/test/java/io/vertx/mysqlclient/tck/MySQLDriverTest.java b/vertx-mysql-client/src/test/java/io/vertx/mysqlclient/tck/MySQLDriverTest.java
@@ -35,4 +35,9 @@ protected SqlConnectOptions defaultOptions() {
     return rule.options();
   }
 
+  @Override
+  protected String getDriverName() {
+    return "MYSQL";
+  }
+
 }
diff --git a/vertx-pg-client/src/main/java/io/vertx/pgclient/PgConnectOptions.java b/vertx-pg-client/src/main/java/io/vertx/pgclient/PgConnectOptions.java
@@ -135,7 +135,7 @@ public PgConnectOptions(PgConnectOptions other) {
     pipeliningLimit = other.pipeliningLimit;
     sslMode = other.sslMode;
   }
-
+  
   @Override
   public PgConnectOptions setHost(String host) {
     return (PgConnectOptions) super.setHost(host);
diff --git a/vertx-pg-client/src/main/java/io/vertx/pgclient/spi/PgDriver.java b/vertx-pg-client/src/main/java/io/vertx/pgclient/spi/PgDriver.java
@@ -9,7 +9,7 @@
 import io.vertx.sqlclient.spi.Driver;
 
 public class PgDriver implements Driver {
-
+  
   @Override
   public Pool createPool(SqlConnectOptions options, PoolOptions poolOptions) {
     return PgPool.pool(wrap(options), poolOptions);
@@ -20,17 +20,24 @@ public Pool createPool(Vertx vertx, SqlConnectOptions options, PoolOptions poolO
     return PgPool.pool(vertx, wrap(options), poolOptions);
   }
 
-  @Override
-  public boolean acceptsOptions(SqlConnectOptions options) {
-    return options instanceof PgConnectOptions || SqlConnectOptions.class.equals(options.getClass());
-  }
-  
   private static PgConnectOptions wrap(SqlConnectOptions options) {
     if (options instanceof PgConnectOptions) {
-      return (PgConnectOptions) options; 
-    } else {
+      return (PgConnectOptions) options;
+    } else if (options.getClass().equals(SqlConnectOptions.class)) {
       return new PgConnectOptions(options);
+    } else {
+      throw new IllegalArgumentException("Unsupported option type: " + options.getClass());
     }
   }
+  
+  @Override
+  public SqlConnectOptions createConnectOptions() {
+    return new PgConnectOptions();
+  }
+
+  @Override
+  public String name() {
+    return KnownDrivers.POSTGRESQL.name();
+  }
 
 }
diff --git a/vertx-pg-client/src/test/java/io/vertx/pgclient/tck/PgDriverTest.java b/vertx-pg-client/src/test/java/io/vertx/pgclient/tck/PgDriverTest.java
@@ -34,4 +34,9 @@ protected SqlConnectOptions defaultOptions() {
     return rule.options();
   }
 
+  @Override
+  protected String getDriverName() {
+    return "POSTGRESQL";
+  }
+  
 }
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/SqlConnectOptions.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/SqlConnectOptions.java
@@ -15,6 +15,7 @@
 import io.vertx.codegen.annotations.GenIgnore;
 import io.vertx.core.json.JsonObject;
 import io.vertx.core.net.NetClientOptions;
+import io.vertx.sqlclient.spi.Driver;
 
 import java.util.HashMap;
 import java.util.Map;
@@ -25,6 +26,7 @@
  */
 @DataObject(generateConverter = true)
 public class SqlConnectOptions extends NetClientOptions {
+  
   public static final boolean DEFAULT_CACHE_PREPARED_STATEMENTS = false;
   public static final int DEFAULT_PREPARED_STATEMENT_CACHE_MAX_SIZE = 256;
   public static final int DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT = 2048;
@@ -39,17 +41,32 @@ public class SqlConnectOptions extends NetClientOptions {
   private int preparedStatementCacheSqlLimit = DEFAULT_PREPARED_STATEMENT_CACHE_SQL_LIMIT;
   private Map<String, String> properties = new HashMap<>(4);
 
+  /**
+   * @deprecated This constructor will be removed in the next release.
+   * Instead, use {@link Driver#createConnectOptions()}
+   */
+  @Deprecated
   public SqlConnectOptions() {
     super();
     init();
   }
 
+  /**
+   * @deprecated This constructor will be removed in the next release.
+   * Instead, use {@link Driver#createConnectOptions()}
+   */
+  @Deprecated
   public SqlConnectOptions(JsonObject json) {
     super(json);
     init();
     SqlConnectOptionsConverter.fromJson(json, this);
   }
 
+  /**
+   * @deprecated This constructor will be removed in the next release.
+   * Instead, use {@link Driver#createConnectOptions()}
+   */
+  @Deprecated
   public SqlConnectOptions(SqlConnectOptions other) {
     super(other);
     this.host = other.host;
@@ -64,7 +81,7 @@ public SqlConnectOptions(SqlConnectOptions other) {
       this.properties = new HashMap<>(other.properties);
     }
   }
-
+  
   /**
    * Get the host for connecting to the server.
    *
@@ -279,4 +296,28 @@ public JsonObject toJson() {
    */
   protected void init() {
   }
+  
+  @Override
+  public boolean equals(Object obj) {
+    if (this == obj)
+      return true;
+    if (!(obj instanceof SqlConnectOptions))
+      return false;
+    SqlConnectOptions that = (SqlConnectOptions) obj;
+    return Objects.equals(host, that.host) &&
+        Objects.equals(port, that.port) &&
+        Objects.equals(database, that.database) &&
+        Objects.equals(user, that.user) &&
+        Objects.equals(password, that.password) &&
+        Objects.equals(properties, that.properties) &&
+        Objects.equals(cachePreparedStatements, that.cachePreparedStatements) &&
+        Objects.equals(preparedStatementCacheMaxSize, that.preparedStatementCacheMaxSize) &&
+        Objects.equals(preparedStatementCacheSqlLimit, that.preparedStatementCacheSqlLimit);
+  }
+  
+  @Override
+  public int hashCode() {
+    return Objects.hash(host, port, database, user, password, properties, cachePreparedStatements, 
+        preparedStatementCacheMaxSize, preparedStatementCacheSqlLimit);
+  }
 }
diff --git a/vertx-sql-client/src/main/java/io/vertx/sqlclient/spi/Driver.java b/vertx-sql-client/src/main/java/io/vertx/sqlclient/spi/Driver.java
diff --git a/vertx-sql-client/src/test/java/io/vertx/sqlclient/tck/DriverTestBase.java b/vertx-sql-client/src/test/java/io/vertx/sqlclient/tck/DriverTestBase.java

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public DB2ConnectOptions(DB2ConnectOptions other) {`
`88`	`88`	`super(other);`
`89`	`89`	`this.pipeliningLimit = other.pipeliningLimit;`
`90`	`90`	`}`
`91`		`-`
	`91`	`+`
`92`	`92`	`@Override`
`93`	`93`	`public DB2ConnectOptions setHost(String host) {`
`94`	`94`	`return (DB2ConnectOptions) super.setHost(host);`
`@@ -210,6 +210,6 @@ public boolean equals(Object o) {`
`210`	`210`
`211`	`211`	`@Override`
`212`	`212`	`public int hashCode() {`
`213`		`- return Objects.hash(pipeliningLimit);`
	`213`	`+ return Objects.hash(super.hashCode(), pipeliningLimit);`
`214`	`214`	`}`
`215`	`215`	`}`
Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,6 @@ public String getSqlState() {`
`55`	`55`	`*/`
`56`	`56`	`@Override`
`57`	`57`	`public String getMessage() {`
`58`		`- return super.getMessage();`
	`58`	`+ return super.getMessage() + "; errorCode=" + errorCode + "; sqlState=" + sqlState;`
`59`	`59`	`}`
`60`	`60`	`}`
Original file line number	Diff line number	Diff line change
`@@ -46,4 +46,9 @@ protected SqlConnectOptions defaultOptions() {`
`46`	`46`	`return rule.options();`
`47`	`47`	`}`
`48`	`48`
	`49`	`+ @Override`
	`50`	`+ protected String getDriverName() {`
	`51`	`+ return "DB2";`
	`52`	`+ }`
	`53`	`+`
`49`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -33,5 +33,10 @@ public class MSSQLDriverTest extends DriverTestBase {`
`33`	`33`	`protected SqlConnectOptions defaultOptions() {`
`34`	`34`	`return rule.options();`
`35`	`35`	`}`
`36`		`-`
	`36`	`+`
	`37`	`+ @Override`
	`38`	`+ protected String getDriverName() {`
	`39`	`+ return "SQLSERVER";`
	`40`	`+ }`
	`41`	`+`
`37`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -92,7 +92,7 @@ public MySQLConnectOptions(MySQLConnectOptions other) {`
`92`	`92`	`this.serverRsaPublicKeyPath = other.serverRsaPublicKeyPath;`
`93`	`93`	`this.serverRsaPublicKeyValue = other.serverRsaPublicKeyValue != null ? other.serverRsaPublicKeyValue.copy() : null;`
`94`	`94`	`}`
`95`		`-`
	`95`	`+`
`96`	`96`	`/**`
`97`	`97`	`* Get the collation for the connection.`
`98`	`98`	`*`
Original file line number	Diff line number	Diff line change
`@@ -35,4 +35,9 @@ protected SqlConnectOptions defaultOptions() {`
`35`	`35`	`return rule.options();`
`36`	`36`	`}`
`37`	`37`
	`38`	`+ @Override`
	`39`	`+ protected String getDriverName() {`
	`40`	`+ return "MYSQL";`
	`41`	`+ }`
	`42`	`+`
`38`	`43`	`}`