feat: Add Universe Domain to Java-Core

gapic-generator-java-pom-parent/pom.xml

@@ -27,7 +27,7 @@
         consistent across modules in this repository -->
     <javax.annotation-api.version>1.3.2</javax.annotation-api.version>
     <grpc.version>1.60.0</grpc.version>
-    <google.auth.version>1.20.0</google.auth.version>
+    <google.auth.version>1.21.0</google.auth.version>
     <google.http-client.version>1.43.3</google.http-client.version>
     <gson.version>2.10.1</gson.version>
     <guava.version>32.1.3-jre</guava.version>

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

@@ -59,6 +59,7 @@
 import java.io.InputStream;
 import java.io.ObjectInputStream;
 import java.io.Serializable;
+import java.net.URI;
 import java.nio.charset.Charset;
 import java.nio.charset.StandardCharsets;
 import java.util.Locale;
@@ -81,7 +82,6 @@ public abstract class ServiceOptions<
     implements Serializable {
 
   public static final String CREDENTIAL_ENV_NAME = "GOOGLE_APPLICATION_CREDENTIALS";
-
   private static final String DEFAULT_HOST = "https://www.googleapis.com";
   private static final String LEGACY_PROJECT_ENV_NAME = "GCLOUD_PROJECT";
   private static final String PROJECT_ENV_NAME = "GOOGLE_CLOUD_PROJECT";
@@ -95,6 +95,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 +126,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 +144,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 +202,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 +320,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 +597,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 +792,62 @@ public String getClientLibToken() {
   public String getQuotaProjectId() {
     return quotaProjectId;
   }
+
+  /**
+   * Returns the resolved endpoint for the Service to connect to Google Cloud
+   *
+   * <p>The resolved endpoint is always in `host:port` format
+   */
+  public String getResolvedEndpoint(String serviceName) {
+    if (universeDomain == null) {
+      return formatEndpoint(serviceName, Credentials.GOOGLE_DEFAULT_UNIVERSE);
+    } else if (universeDomain.isEmpty()) {
+      throw new IllegalArgumentException("Universe Domain cannot be empty");
+    } else {
+      if (host != null) {
+        return normalizeEndpoint();
+      }
+      return formatEndpoint(serviceName, getUniverseDomain());
+    }
+  }
+
+  private String formatEndpoint(String serviceName, String universeDomain) {
+    return serviceName + "." + universeDomain + ":443";
+  }
+
+  // Best effort endpoint normalization to ensure it results in {domain}:{port} format
+  // for gRPC-Java. `host` is expected to be in format of http(s)://{domain}
+  String normalizeEndpoint() {
+    URI uri = URI.create(host);
+    String scheme = uri.getScheme();
+    int port = uri.getPort();
+
+    // If no port is provided, http:// defaults to 80 and https:// defaults to 443
+    if (scheme.equals("http")) {
+      return String.format("%s:%s", uri.getHost(), port > 0 ? port : 80);
+    } else if (scheme.equals("https")) {
+      return String.format("%s:%s", uri.getHost(), port > 0 ? port : 443);
+    } else {
+      throw new RuntimeException("Invalid host: " + host + ". Expecting http(s)://{domain}");
+    }
+  }
+
+  /**
+   * Temporarily used for BigQuery and Storage Apiary Wrapped Libraries. To be removed in the
+   * future. Returns the host to be used for the rootUrl and output is in the format of:
+   * "https://serviceName.universeDomain/"
+   */
+  @InternalApi
+  public String getResolvedApiaryHost(String serviceName) {
+    String resolvedUniverseDomain =
+        getUniverseDomain() != null ? getUniverseDomain() : Credentials.GOOGLE_DEFAULT_UNIVERSE;
+    return "https://www." + serviceName + "." + resolvedUniverseDomain + "/";
+  }
+
+  /** Validates that Credentials' Universe Domain matches the user configured Universe Domain. */
+  public boolean isValidUniverseDomain() throws IOException {
+    String resolvedUniverseDomain =
+        getUniverseDomain() != null ? getUniverseDomain() : Credentials.GOOGLE_DEFAULT_UNIVERSE;
+    return resolvedUniverseDomain.equals(getCredentials().getUniverseDomain());
+  }
 }