Oracle URL parsing enhancements (eclipse-vertx#1153)

* Add missing Oracle EZConnect properties to OracleConnectOptions Signed-off-by: Thomas Segismont <tsegismont@gmail.com> * Refactored OracleConnectionUriParser and OracleDatabaseHelper Now they both support EZConnect url format. Also, connection properties decoding has been implemented. Signed-off-by: Thomas Segismont <tsegismont@gmail.com>

Author: tsegismont

vertx-oracle-client/src/main/java/io/vertx/oracleclient/OracleConnectOptions.java

@@ -34,6 +34,16 @@ public static OracleConnectOptions wrap(SqlConnectOptions options) {
  }
  }
 
+ public static final String DEFAULT_HOST = "localhost";
+ public static final int DEFAULT_PORT = 1521;
+ public static final String DEFAULT_USER = "";
+ public static final String DEFAULT_PASSWORD = "";
+ public static final String DEFAULT_DATABASE = "";
+
+ private String serviceId;
+ private String serviceName;
+ private ServerMode serverMode;
+ private String instanceName;
  // Support TNS_ADMIN (tnsnames.ora, ojdbc.properties).
  private String tnsAdmin;
 
@@ -42,6 +52,10 @@ public OracleConnectOptions() {
 
  public OracleConnectOptions(OracleConnectOptions other) {
  super(other);
+ this.serviceId = other.serviceId;
+ this.serviceName = other.serviceName;
+ this.serverMode = other.serverMode;
+ this.instanceName = other.instanceName;
  this.tnsAdmin = other.tnsAdmin;
  }
 
@@ -68,6 +82,80 @@ public static OracleConnectOptions fromUri(String connectionUri) throws IllegalA
 
  // Oracle-specific options
 
+ /**
+ * @return the Oracle service identifier (SID)
+ */
+ public String getServiceId() {
+ return serviceId;
+ }
+
+ /**
+ * Set the Oracle service identifier (SID).
+ * If set, the client will build an Oracle connection URL using SID instead of the EZConnect format.
+ *
+ * @param serviceId the service identifier
+ * @return a reference to this, so the API can be used fluently
+ */
+ public OracleConnectOptions setServiceId(String serviceId) {
+ this.serviceId = serviceId;
+ return this;
+ }
+
+ /**
+ * @return the Oracle service name
+ */
+ public String getServiceName() {
+ return serviceName;
+ }
+
+ /**
+ * Set the Oracle service name.
+ * If set, the client will build an Oracle connection URL in the EZConnect format.
+ *
+ * @param serviceName the Oracle service name
+ * @return a reference to this, so the API can be used fluently
+ */
+ public OracleConnectOptions setServiceName(String serviceName) {
+ this.serviceName = serviceName;
+ return this;
+ }
+
+ /**
+ * @return the server connection mode
+ */
+ public ServerMode getServerMode() {
+ return serverMode;
+ }
+
+ /**
+ * Set the server connection mode.
+ *
+ * @param serverMode the connection mode
+ * @return a reference to this, so the API can be used fluently
+ */
+ public OracleConnectOptions setServerMode(ServerMode serverMode) {
+ this.serverMode = serverMode;
+ return this;
+ }
+
+ /**
+ * @return the Oracle instance name
+ */
+ public String getInstanceName() {
+ return instanceName;
+ }
+
+ /**
+ * Set the Oracle instance name.
+ *
+ * @param instanceName the instance name
+ * @return a reference to this, so the API can be used fluently
+ */
+ public OracleConnectOptions setInstanceName(String instanceName) {
+ this.instanceName = instanceName;
+ return this;
+ }
+
  public String getTnsAdmin() {
  return tnsAdmin;
  }
@@ -124,6 +212,13 @@ public String getDatabase() {
  return super.getDatabase();
  }
 
+ /**
+ * Set the database name.
+ * If set, the client will build an Oracle connection URL in the EZConnect format using the {@code database} value as service name.
+ *
+ * @param database the database name to specify
+ * @return a reference to this, so the API can be used fluently
+ */
  @Override
  public OracleConnectOptions setDatabase(String database) {
  return (OracleConnectOptions) super.setDatabase(database);
@@ -201,6 +296,15 @@ public JsonObject toJson() {
  return json;
  }
 
+ @Override
+ protected void init() {
+ this.setHost(DEFAULT_HOST);
+ this.setPort(DEFAULT_PORT);
+ this.setUser(DEFAULT_USER);
+ this.setPassword(DEFAULT_PASSWORD);
+ this.setDatabase(DEFAULT_DATABASE);
+ }
+
  @Override
  public OracleConnectOptions merge(JsonObject other) {
  JsonObject json = toJson();

vertx-oracle-client/src/main/java/io/vertx/oracleclient/ServerMode.java

@@ -0,0 +1,38 @@
+/*
+ * Copyright (c) 2011-2022 Contributors to the Eclipse Foundation
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
+ * which is available at https://www.apache.org/licenses/LICENSE-2.0.
+ *
+ * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
+ */
+
+package io.vertx.oracleclient;
+
+import io.vertx.codegen.annotations.VertxGen;
+
+/**
+ * Describes the server connection mode.
+ */
+@VertxGen
+public enum ServerMode {
+
+ DEDICATED("dedicated"), SHARED("shared");
+
+ private final String mode;
+
+ ServerMode(String mode) {
+ this.mode = mode;
+ }
+
+ public static ServerMode of(String mode) {
+ return DEDICATED.mode.equalsIgnoreCase(mode) ? DEDICATED : SHARED.mode.equalsIgnoreCase(mode) ? SHARED : null;
+ }
+
+ @Override
+ public String toString() {
+ return mode;
+ }
+}