feat: Add Universe Domain to Java-Core

java-core/google-cloud-core/src/main/java/com/google/cloud/ServiceOptions.java

@@ -46,6 +46,7 @@
 import com.google.auth.oauth2.ServiceAccountCredentials;
 import com.google.cloud.spi.ServiceRpcFactory;
 import com.google.common.base.Preconditions;
+import com.google.common.base.Strings;
 import com.google.common.collect.ImmutableMap;
 import com.google.common.collect.ImmutableSet;
 import com.google.common.collect.Iterables;
@@ -81,6 +82,7 @@ public abstract class ServiceOptions<
     implements Serializable {
 
   public static final String CREDENTIAL_ENV_NAME = "GOOGLE_APPLICATION_CREDENTIALS";
+  public static final String GOOGLE_DEFAULT_UNIVERSE = "googleapis.com";
 
   private static final String DEFAULT_HOST = "https://www.googleapis.com";
   private static final String LEGACY_PROJECT_ENV_NAME = "GCLOUD_PROJECT";
@@ -95,6 +97,7 @@ public abstract class ServiceOptions<
   protected final String clientLibToken;
 
   private final String projectId;
+  private final String universeDomain;
   private final String host;
   private final RetrySettings retrySettings;
   private final String serviceRpcFactoryClassName;
@@ -125,6 +128,7 @@ public abstract static class Builder<
     private final ImmutableSet<String> allowedClientLibTokens =
         ImmutableSet.of(ServiceOptions.getGoogApiClientLibName());
     private String projectId;
+    private String universeDomain;
     private String host;
     protected Credentials credentials;
     private RetrySettings retrySettings;
@@ -142,6 +146,7 @@ protected Builder() {}
     @InternalApi("This class should only be extended within google-cloud-java")
     protected Builder(ServiceOptions<ServiceT, OptionsT> options) {
       projectId = options.projectId;
+      universeDomain = options.universeDomain;
       host = options.host;
       credentials = options.credentials;
       retrySettings = options.retrySettings;
@@ -199,6 +204,17 @@ public B setHost(String host) {
       return self();
     }
 
+    /**
+     * Universe Domain is the domain for Google Cloud Services. It follows the format of
+     * `{ServiceName}.{UniverseDomain}`. For example, speech.googleapis.com would have a Universe
+     * Domain value of `googleapis.com` and cloudasset.test.com would have a Universe Domain of
+     * `test.com`. If this value is not set, this will default to `googleapis.com`.
+     */
+    public B setUniverseDomain(String universeDomain) {
+      this.universeDomain = universeDomain;
+      return self();
+    }
+
     /**
      * Sets the service authentication credentials. If no credentials are set, {@link
      * GoogleCredentials#getApplicationDefault()} will be used to attempt getting credentials from
@@ -306,6 +322,7 @@ protected ServiceOptions(
           "A project ID is required for this service but could not be determined from the builder "
               + "or the environment.  Please set a project ID using the builder.");
     }
+    universeDomain = builder.universeDomain;
     host = firstNonNull(builder.host, getDefaultHost());
     credentials = builder.credentials != null ? builder.credentials : defaultCredentials();
     retrySettings = firstNonNull(builder.retrySettings, getDefaultRetrySettings());
@@ -582,6 +599,16 @@ public String getProjectId() {
     return projectId;
   }
 
+  /**
+   * Universe Domain is the domain for Google Cloud Services. It follows the format of
+   * `{ServiceName}.{UniverseDomain}`. For example, speech.googleapis.com would have a Universe
+   * Domain value of `googleapis.com` and cloudasset.test.com would have a Universe Domain of
+   * `test.com`. If this value is not set, this will default to `googleapis.com`.
+   */
+  public String getUniverseDomain() {
+    return universeDomain;
+  }
+
   /** Returns the service host. */
   public String getHost() {
     return host;
@@ -767,4 +794,40 @@ public String getClientLibToken() {
   public String getQuotaProjectId() {
     return quotaProjectId;
   }
+
+  /** Returns the resolved endpoint for the Service to connect to Google Cloud */
+  public String getResolvedEndpoint(String serviceName) {
+    if (universeDomain == null) {
+      return formatEndpoint(serviceName, GOOGLE_DEFAULT_UNIVERSE);
+    } else if (Strings.isNullOrEmpty(universeDomain)) {
+      throw new IllegalArgumentException("Universe Domain cannot be empty");
+    } else {
+      if (host == null) {
+        return formatEndpoint(serviceName, getUniverseDomain());
+      }
+      return host;
+    }
+  }
+
+  // Temporarily used for Apiary Wrapped Libraries. To be removed in the future.
+  @InternalApi
+  public String getResolvedApiaryEndpoint(String serviceName) {
+    String resolvedUniverseDomain =
+        getUniverseDomain() != null ? getUniverseDomain() : GOOGLE_DEFAULT_UNIVERSE;
+    return formatEndpoint(serviceName, resolvedUniverseDomain);
+  }
+
+  /** Validates that Credentials' Universe Domain and user configured Universe Domain matches. */
+  public boolean isValidUniverseDomain() throws IOException {
+    Credentials credentials = getCredentials();
+    String universeDomain = getUniverseDomain();
+    String resolvedUniverseDomain =
+        universeDomain != null ? universeDomain : GOOGLE_DEFAULT_UNIVERSE;
+    return true;
+    //    return credentials.getUniverseDomain() != resolvedUniverseDomain;
+  }
+
+  private String formatEndpoint(String serviceName, String universeDomain) {
+    return serviceName + "." + universeDomain + ":443";
+  }
 }

java-core/google-cloud-core/src/test/java/com/google/cloud/ServiceOptionsTest.java

@@ -22,6 +22,7 @@
 import static org.junit.Assert.assertNotEquals;
 import static org.junit.Assert.assertNull;
 import static org.junit.Assert.assertSame;
+import static org.junit.Assert.assertThrows;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
 
@@ -471,6 +472,74 @@ public void testResponseHeaderDoesNotContainMetaDataFlavor() throws Exception {
     assertThat(ServiceOptions.headerContainsMetadataFlavor(httpResponse)).isFalse();
   }
 
+  @Test
+  public void testGetResolvedEndpoint_noUniverseDomain() {
+    TestServiceOptions options = TestServiceOptions.newBuilder().setProjectId("project-id").build();
+    assertThat(options.getResolvedEndpoint("service")).isEqualTo("service.googleapis.com:443");
+  }
+
+  @Test
+  public void testGetResolvedEndpoint_emptyUniverseDomain() {
+    TestServiceOptions options =
+        TestServiceOptions.newBuilder().setUniverseDomain("").setProjectId("project-id").build();
+    IllegalArgumentException exception =
+        assertThrows(IllegalArgumentException.class, () -> options.getResolvedEndpoint("service"));
+    assertThat(exception.getMessage()).isEqualTo("Universe Domain cannot be empty");
+  }
+
+  @Test
+  public void testGetResolvedEndpoint_customUniverseDomain_noHost() {
+    TestServiceOptions options =
+        TestServiceOptions.newBuilder()
+            .setUniverseDomain("test.com")
+            .setHost(null)
+            .setProjectId("project-id")
+            .build();
+    // `https://www.googleapis.com` is the DEFAULT_HOST value for ServiceOptions. The ServiceOptions
+    // builder will set as it as the host if host is null
+    assertThat(options.getResolvedEndpoint("service")).isEqualTo("https://www.googleapis.com");
+  }
+
+  @Test
+  public void testGetResolvedEndpoint_customUniverseDomain_customHost() {
+    TestServiceOptions options =
+        TestServiceOptions.newBuilder()
+            .setUniverseDomain("test.com")
+            .setHost("service.random.com:443")
+            .setProjectId("project-id")
+            .build();
+    assertThat(options.getResolvedEndpoint("service")).isEqualTo("service.random.com:443");
+  }
+
+  @Test
+  public void testGetResolvedApiaryEndpoint_noUniverseDomain() {
+    TestServiceOptions options = TestServiceOptions.newBuilder().setProjectId("project-id").build();
+    assertThat(options.getResolvedApiaryEndpoint("service"))
+        .isEqualTo("service.googleapis.com:443");
+  }
+
+  @Test
+  public void testGetResolvedApiaryEndpoint_customUniverseDomain_noHost() {
+    TestServiceOptions options =
+        TestServiceOptions.newBuilder()
+            .setUniverseDomain("test.com")
+            .setHost(null)
+            .setProjectId("project-id")
+            .build();
+    assertThat(options.getResolvedApiaryEndpoint("service")).isEqualTo("service.test.com:443");
+  }
+
+  @Test
+  public void testGetResolvedApiaryEndpoint_customUniverseDomain_customHost() {
+    TestServiceOptions options =
+        TestServiceOptions.newBuilder()
+            .setUniverseDomain("test.com")
+            .setHost("service.random.com:443")
+            .setProjectId("project-id")
+            .build();
+    assertThat(options.getResolvedEndpoint("service")).isEqualTo("service.random.com:443");
+  }
+
   private HttpResponse createHttpResponseWithHeader(final Multimap<String, String> headers)
       throws Exception {
     HttpTransport mockHttpTransport =