Move address translator driver options to DefaultDriverOption

alexsa · alexsa · commit 85d59316572c · 2025-03-23T12:55:18.000+01:00
diff --git a/core/src/main/java/com/datastax/oss/driver/api/core/config/DefaultDriverOption.java b/core/src/main/java/com/datastax/oss/driver/api/core/config/DefaultDriverOption.java
@@ -994,7 +994,48 @@ public enum DefaultDriverOption implements DriverOption {
    *
    * <p>Value-type: boolean
    */
-  SSL_ALLOW_DNS_REVERSE_LOOKUP_SAN("advanced.ssl-engine-factory.allow-dns-reverse-lookup-san");
+  SSL_ALLOW_DNS_REVERSE_LOOKUP_SAN("advanced.ssl-engine-factory.allow-dns-reverse-lookup-san"),
+  /**
+   * An address to always translate all node addresses to that same proxy hostname no matter what IP
+   * address a node has, but still using its native transport port.
+   *
+   * <p>Value-Type: {@link String}
+   */
+  ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME("advanced.address-translator.advertised-hostname"),
+  /**
+   * A map of Cassandra node subnets (CIDR notations) to target addresses, for example (note quoted
+   * keys):
+   *
+   * <pre>
+   * advanced.address-translator.subnet-addresses {
+   *   "100.64.0.0/15" = "cassandra.datacenter1.com:9042"
+   *   "100.66.0.0/15" = "cassandra.datacenter2.com:9042"
+   *   # IPv6 example:
+   *   # "::ffff:6440:0/111" = "cassandra.datacenter1.com:9042"
+   *   # "::ffff:6442:0/111" = "cassandra.datacenter2.com:9042"
+   * }
+   * </pre>
+   *
+   * Note: subnets must be represented as prefix blocks, see {@link
+   * inet.ipaddr.Address#isPrefixBlock()}.
+   *
+   * <p>Value type: {@link java.util.Map Map}&#60;{@link String},{@link String}&#62;
+   */
+  ADDRESS_TRANSLATOR_SUBNET_ADDRESSES("advanced.address-translator.subnet-addresses"),
+  /**
+   * A default address to fallback to if Cassandra node IP isn't contained in any of the configured
+   * subnets.
+   *
+   * <p>Value-Type: {@link String}
+   */
+  ADDRESS_TRANSLATOR_DEFAULT_ADDRESS("advanced.address-translator.default-address"),
+  /**
+   * Whether to resolve the addresses on initialization (if true) or on each node (re-)connection
+   * (if false). Defaults to false.
+   *
+   * <p>Value-Type: boolean
+   */
+  ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES("advanced.address-translator.resolve-addresses");
 
   private final String path;
 
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/addresstranslation/FixedHostNameAddressTranslator.java b/core/src/main/java/com/datastax/oss/driver/internal/core/addresstranslation/FixedHostNameAddressTranslator.java
@@ -17,8 +17,9 @@
  */
 package com.datastax.oss.driver.internal.core.addresstranslation;
 
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME;
+
 import com.datastax.oss.driver.api.core.addresstranslation.AddressTranslator;
-import com.datastax.oss.driver.api.core.config.DriverOption;
 import com.datastax.oss.driver.api.core.context.DriverContext;
 import edu.umd.cs.findbugs.annotations.NonNull;
 import java.net.InetSocketAddress;
@@ -37,28 +38,13 @@ public class FixedHostNameAddressTranslator implements AddressTranslator {
 
   private static final Logger LOG = LoggerFactory.getLogger(FixedHostNameAddressTranslator.class);
 
-  public static final String ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME =
-      "advanced.address-translator.advertised-hostname";
-
-  public static DriverOption ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME_OPTION =
-      new DriverOption() {
-        @NonNull
-        @Override
-        public String getPath() {
-          return ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME;
-        }
-      };
-
   private final String advertisedHostname;
   private final String logPrefix;
 
   public FixedHostNameAddressTranslator(@NonNull DriverContext context) {
     logPrefix = context.getSessionName();
     advertisedHostname =
-        context
-            .getConfig()
-            .getDefaultProfile()
-            .getString(ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME_OPTION);
+        context.getConfig().getDefaultProfile().getString(ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME);
   }
 
   @NonNull
diff --git a/core/src/main/java/com/datastax/oss/driver/internal/core/addresstranslation/SubnetAddressTranslator.java b/core/src/main/java/com/datastax/oss/driver/internal/core/addresstranslation/SubnetAddressTranslator.java
@@ -17,8 +17,11 @@
  */
 package com.datastax.oss.driver.internal.core.addresstranslation;
 
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_DEFAULT_ADDRESS;
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES;
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_SUBNET_ADDRESSES;
+
 import com.datastax.oss.driver.api.core.addresstranslation.AddressTranslator;
-import com.datastax.oss.driver.api.core.config.DriverOption;
 import com.datastax.oss.driver.api.core.context.DriverContext;
 import com.datastax.oss.driver.internal.core.util.AddressUtils;
 import edu.umd.cs.findbugs.annotations.NonNull;
@@ -45,67 +48,6 @@
 public class SubnetAddressTranslator implements AddressTranslator {
   private static final Logger LOG = LoggerFactory.getLogger(SubnetAddressTranslator.class);
 
-  /**
-   * A map of Cassandra node subnets (CIDR notations) to target addresses, for example (note quoted
-   * keys):
-   *
-   * <pre>
-   * advanced.address-translator.subnet-addresses {
-   *   "100.64.0.0/15" = "cassandra.datacenter1.com:9042"
-   *   "100.66.0.0/15" = "cassandra.datacenter2.com:9042"
-   *   # IPv6 example:
-   *   # "::ffff:6440:0/111" = "cassandra.datacenter1.com:9042"
-   *   # "::ffff:6442:0/111" = "cassandra.datacenter2.com:9042"
-   * }
-   * </pre>
-   *
-   * Note: subnets must be represented as prefix blocks, see {@link
-   * inet.ipaddr.Address#isPrefixBlock()}.
-   */
-  public static final String ADDRESS_TRANSLATOR_SUBNET_ADDRESSES =
-      "advanced.address-translator.subnet-addresses";
-
-  /**
-   * A default address to fallback to if Cassandra node IP isn't contained in any of the configured
-   * subnets.
-   */
-  public static final String ADDRESS_TRANSLATOR_DEFAULT_ADDRESS =
-      "advanced.address-translator.default-address";
-
-  /**
-   * Whether to resolve the addresses on initialization (if true) or on each node (re-)connection
-   * (if false). Defaults to false.
-   */
-  public static final String ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES =
-      "advanced.address-translator.resolve-addresses";
-
-  public static DriverOption ADDRESS_TRANSLATOR_SUBNET_ADDRESSES_OPTION =
-      new DriverOption() {
-        @NonNull
-        @Override
-        public String getPath() {
-          return ADDRESS_TRANSLATOR_SUBNET_ADDRESSES;
-        }
-      };
-
-  public static DriverOption ADDRESS_TRANSLATOR_DEFAULT_ADDRESS_OPTION =
-      new DriverOption() {
-        @NonNull
-        @Override
-        public String getPath() {
-          return ADDRESS_TRANSLATOR_DEFAULT_ADDRESS;
-        }
-      };
-
-  public static DriverOption ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES_OPTION =
-      new DriverOption() {
-        @NonNull
-        @Override
-        public String getPath() {
-          return ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES;
-        }
-      };
-
   private final List<SubnetAddress> subnetAddresses;
 
   @SuppressWarnings("OptionalUsedAsFieldOrParameterType")
@@ -119,10 +61,10 @@ public SubnetAddressTranslator(@NonNull DriverContext context) {
         context
             .getConfig()
             .getDefaultProfile()
-            .getBoolean(ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES_OPTION, false);
+            .getBoolean(ADDRESS_TRANSLATOR_RESOLVE_ADDRESSES, false);
     this.subnetAddresses =
-        context.getConfig().getDefaultProfile()
-            .getStringMap(ADDRESS_TRANSLATOR_SUBNET_ADDRESSES_OPTION).entrySet().stream()
+        context.getConfig().getDefaultProfile().getStringMap(ADDRESS_TRANSLATOR_SUBNET_ADDRESSES)
+            .entrySet().stream()
             .map(
                 e -> {
                   // Quoted and/or containing forward slashes map keys in reference.conf are read to
@@ -138,7 +80,7 @@ public SubnetAddressTranslator(@NonNull DriverContext context) {
                 context
                     .getConfig()
                     .getDefaultProfile()
-                    .getString(ADDRESS_TRANSLATOR_DEFAULT_ADDRESS_OPTION, null))
+                    .getString(ADDRESS_TRANSLATOR_DEFAULT_ADDRESS, null))
             .map(address -> parseAddress(address, resolveAddresses));
 
     validateSubnetsAreNotOverlapping(this.subnetAddresses);
diff --git a/core/src/test/java/com/datastax/oss/driver/internal/core/addresstranslation/FixedHostNameAddressTranslatorTest.java b/core/src/test/java/com/datastax/oss/driver/internal/core/addresstranslation/FixedHostNameAddressTranslatorTest.java
@@ -17,6 +17,7 @@
  */
 package com.datastax.oss.driver.internal.core.addresstranslation;
 
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.Mockito.mock;
 import static org.mockito.Mockito.when;
@@ -33,9 +34,7 @@ public class FixedHostNameAddressTranslatorTest {
   @Test
   public void should_translate_address() {
     DriverExecutionProfile defaultProfile = mock(DriverExecutionProfile.class);
-    when(defaultProfile.getString(
-            FixedHostNameAddressTranslator.ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME_OPTION))
-        .thenReturn("myaddress");
+    when(defaultProfile.getString(ADDRESS_TRANSLATOR_ADVERTISED_HOSTNAME)).thenReturn("myaddress");
     DefaultDriverContext defaultDriverContext =
         MockedDriverContextFactory.defaultDriverContext(Optional.of(defaultProfile));
 
diff --git a/core/src/test/java/com/datastax/oss/driver/internal/core/addresstranslation/SubnetAddressTranslatorTest.java b/core/src/test/java/com/datastax/oss/driver/internal/core/addresstranslation/SubnetAddressTranslatorTest.java
@@ -17,6 +17,8 @@
  */
 package com.datastax.oss.driver.internal.core.addresstranslation;
 
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_DEFAULT_ADDRESS;
+import static com.datastax.oss.driver.api.core.config.DefaultDriverOption.ADDRESS_TRANSLATOR_SUBNET_ADDRESSES;
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
 import static org.mockito.Mockito.mock;
@@ -66,7 +68,7 @@ public void should_translate_to_default_address() {
     when(context
             .getConfig()
             .getDefaultProfile()
-            .getString(SubnetAddressTranslator.ADDRESS_TRANSLATOR_DEFAULT_ADDRESS_OPTION, null))
+            .getString(ADDRESS_TRANSLATOR_DEFAULT_ADDRESS, null))
         .thenReturn("cassandra.com:19042");
     SubnetAddressTranslator translator = new SubnetAddressTranslator(context);
     InetSocketAddress address = new InetSocketAddress("100.68.0.1", 9042);
@@ -144,7 +146,7 @@ public void should_fail_on_default_address_without_port() {
     when(context
             .getConfig()
             .getDefaultProfile()
-            .getString(SubnetAddressTranslator.ADDRESS_TRANSLATOR_DEFAULT_ADDRESS_OPTION, null))
+            .getString(ADDRESS_TRANSLATOR_DEFAULT_ADDRESS, null))
         .thenReturn("cassandra.com");
     assertThatIllegalArgumentException()
         .isThrownBy(() -> new SubnetAddressTranslator(context))
@@ -153,8 +155,7 @@ public void should_fail_on_default_address_without_port() {
 
   private static DefaultDriverContext context(Map<String, String> subnetAddresses) {
     DriverExecutionProfile profile = mock(DriverExecutionProfile.class);
-    when(profile.getStringMap(SubnetAddressTranslator.ADDRESS_TRANSLATOR_SUBNET_ADDRESSES_OPTION))
-        .thenReturn(subnetAddresses);
+    when(profile.getStringMap(ADDRESS_TRANSLATOR_SUBNET_ADDRESSES)).thenReturn(subnetAddresses);
     return MockedDriverContextFactory.defaultDriverContext(Optional.of(profile));
   }
 }
