chore:Rename RegionArea to DomainArea

Author: seymourtang

README.md

@@ -4,6 +4,7 @@
 <img alt="Maven Central Version" src="https://img.shields.io/maven-central/v/io.agora/agora-rest-client-core?colorB=brightgreen">
 <img alt="GitHub License" src="https://img.shields.io/github/license/AgoraIO-Community/agora-rest-client-java">
 <a href="https://github.com/AgoraIO-Community/agora-rest-client-java/actions/workflows/maven.yml"><img alt="Java CI with Maven" src="https://github.com/AgoraIO-Community/agora-rest-client-java/actions/workflows/maven.yml/badge.svg"></a>
+<a href="https://github.com/AgoraIO-Community/agora-rest-client-java/actions/workflows/gitee-sync.yml"><img alt="gitee-sync" src="https://github.com/AgoraIO-Community/agora-rest-client-java/actions/workflows/gitee-sync.yml/badge.svg?branch=main"></a>
 <img alt="GitHub" src="https://img.shields.io/github/v/release/AgoraIO-Community/agora-rest-client-java">
 <img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/AgoraIO-Community/agora-rest-client-java">
 </p>
@@ -56,7 +57,7 @@ import io.agora.rest.AgoraException;
 import io.agora.rest.core.AgoraConfig;
 import io.agora.rest.core.BasicAuthCredential;
 import io.agora.rest.core.Credential;
-import io.agora.rest.core.RegionArea;
+import io.agora.rest.core.DomainArea;
 import io.agora.rest.services.cloudrecording.api.req.StartResourceReq;
 import io.agora.rest.services.cloudrecording.api.res.AcquireResourceRes;
 import io.agora.rest.services.cloudrecording.api.res.StartResourceRes;
@@ -101,9 +102,9 @@ public class Main {
             .appId(appId)
             .credential(credential)
             // Specify the region where the server is located.
-            // Optional values are CN, NA, EU, AP, and the client will automatically
+            // Optional values are CN, US, EU, AP, and the client will automatically
             // switch to use the best domain name according to the configured region
-            .regionArea(RegionArea.CNRegionArea)
+            .domainArea(DomainArea.)
             .build();
 
     // Initialize CloudRecordingClient

agora-rest-client-core/src/main/java/io/agora/rest/core/AgoraConfig.java

@@ -5,14 +5,14 @@ public class AgoraConfig {
 
     private final Credential credential;
 
-    private final RegionArea regionArea;
+    private final DomainArea domainArea;
 
     private final HttpProperty httpProperty;
 
     private AgoraConfig(Builder builder) {
         this.appId = builder.appId;
         this.credential = builder.credential;
-        this.regionArea = builder.regionArea;
+        this.domainArea = builder.domainArea;
         this.httpProperty = builder.httpProperty;
     }
 
@@ -28,8 +28,8 @@ public Credential getCredential() {
         return credential;
     }
 
-    public RegionArea getRegionArea() {
-        return regionArea;
+    public DomainArea getDomainArea() {
+        return domainArea;
     }
 
     public HttpProperty getHttpProperty() {
@@ -41,7 +41,7 @@ public String toString() {
         return "AgoraConfig{" +
                 "appId='" + appId + '\'' +
                 ", credential=" + credential +
-                ", regionArea=" + regionArea +
+                ", domainArea=" + domainArea +
                 ", httpProperty=" + httpProperty +
                 '}';
     }
@@ -52,7 +52,7 @@ public static class Builder {
 
         private Credential credential;
 
-        private RegionArea regionArea;
+        private DomainArea domainArea;
 
         private HttpProperty httpProperty;
 
@@ -69,8 +69,8 @@ public Builder credential(Credential credential) {
             return this;
         }
 
-        public Builder regionArea(RegionArea regionArea) {
-            this.regionArea = regionArea;
+        public Builder domainArea(DomainArea domainArea) {
+            this.domainArea = domainArea;
             return this;
         }
 

agora-rest-client-core/src/main/java/io/agora/rest/core/DefaultContext.java

@@ -27,7 +27,7 @@ public class DefaultContext implements Context {
     public DefaultContext(AgoraConfig agoraConfig) {
         this.agoraConfig = agoraConfig;
         this.httpClient = HttpClientFactory.createHttpClient(agoraConfig);
-        this.domainPool = new DomainPool(agoraConfig.getRegionArea());
+        this.domainPool = new DomainPool(agoraConfig.getDomainArea());
         this.codec = new JsonCodec();
     }
 

agora-rest-client-core/src/main/java/io/agora/rest/core/RegionArea.java renamed to agora-rest-client-core/src/main/java/io/agora/rest/core/DomainArea.java

@@ -4,45 +4,45 @@
 import java.util.Collections;
 import java.util.List;
 
-public enum RegionArea {
+public enum DomainArea {
     /**
-     * Unknown region area
+     * Unknown domain area
      */
-    UnkonwnRegionArea(Collections.emptyList(), Collections.emptyList()),
+    Unknown(Collections.emptyList(), Collections.emptyList()),
 
     /**
-     * US region area
+     * US domain area
      */
-    USRegionArea(
+    US(
             Arrays.asList("api-us-west-1", "api-us-east-1"),
             Arrays.asList("agora.io", "sd-rtn.com")),
 
     /**
-     * EU region area
+     * EU domain area
      */
-    EURegionArea(
+    EU(
             Arrays.asList("api-eu-west-1", "api-eu-central-1"),
             Arrays.asList("agora.io", "sd-rtn.com")),
 
     /**
-     * AP region area
+     * AP domain area
      */
-    APRegionArea(
+    AP(
             Arrays.asList("api-ap-southeast-1", "api-ap-northeast-1"),
             Arrays.asList("agora.io", "sd-rtn.com")),
 
     /**
-     * CN region area
+     * CN domain area
      */
-    CNRegionArea(
+    CN(
             Arrays.asList("api-cn-east-1", "api-cn-north-1"),
             Arrays.asList("sd-rtn.com", "agora.io"));
 
     private final List<String> regionDomainPrefixes;
 
     private final List<String> majorDomainSuffixes;
 
-    RegionArea(List<String> regionDomainPrefixes, List<String> majorDomainSuffixes) {
+    DomainArea(List<String> regionDomainPrefixes, List<String> majorDomainSuffixes) {
         this.regionDomainPrefixes = Collections.unmodifiableList(regionDomainPrefixes);
         this.majorDomainSuffixes = Collections.unmodifiableList(majorDomainSuffixes);
     }

agora-rest-client-core/src/main/java/io/agora/rest/core/DomainPool.java

@@ -30,8 +30,8 @@ public class DomainPool {
 
     private final Logger logger = LoggerFactory.getLogger(DomainPool.class);
 
-    public DomainPool(RegionArea domainArea) {
-        if (domainArea == null || domainArea == RegionArea.UnkonwnRegionArea) {
+    public DomainPool(DomainArea domainArea) {
+        if (domainArea == null || domainArea == DomainArea.Unknown) {
             throw new AgoraInvalidArgumentException("invalid domain area");
         }
 

agora-rest-client-core/src/main/java/io/agora/rest/services/cloudrecording/README.md

@@ -53,9 +53,9 @@
                 .appId(appId)
                 .credential(credential)
                 // Specify the region where the server is located. 
-                // Optional values are CN, NA, EU, AP, and the client will automatically
+                // Optional values are CN, US, EU, AP, and the client will automatically
                 // switch to use the best domain name according to the configured region
-                .regionArea(region)
+                .domainArea(DomainArea.CN)
                 .build();
 
         // Initialize CloudRecordingClient

agora-rest-client-core/src/test/java/io/agora/rest/core/DomainDNSResolverTest.java

@@ -18,9 +18,9 @@ public void testDomainDNSResolver() {
         assertNotNull(resolver);
 
         String domain = resolver.resolve(Arrays.asList("agora.io", "sd-rtn.com"),
-                RegionArea.CNRegionArea.getRegionDomainPrefixes().get(0)).block();
+                DomainArea.CN.getRegionDomainPrefixes().get(0)).block();
 
         logger.info("Domain: {}", domain);
         assertNotNull(domain);
     }
-}
+}

examples/cloudrecording/src/main/java/io/agora/rest/examples/cloudrecording/Main.java

@@ -1,7 +1,7 @@
 package io.agora.rest.examples.cloudrecording;
 
 import io.agora.rest.core.BasicAuthCredential;
-import io.agora.rest.core.RegionArea;
+import io.agora.rest.core.DomainArea;
 import io.agora.rest.examples.cloudrecording.scenario.IndividualRecordingScenario;
 import io.agora.rest.examples.cloudrecording.scenario.MixRecordingScenario;
 import io.agora.rest.examples.cloudrecording.scenario.WebRecordingScenario;
@@ -31,7 +31,7 @@ public class Main implements Callable<Integer> {
 
     private String token;
 
-    private final RegionArea region = RegionArea.CNRegionArea;
+    private final DomainArea region = DomainArea.CN;
 
     private StartResourceReq.StorageConfig storageConfig;
 

examples/cloudrecording/src/main/java/io/agora/rest/examples/cloudrecording/scenario/BaseScenario.java

@@ -2,7 +2,7 @@
 
 import io.agora.rest.core.AgoraConfig;
 import io.agora.rest.core.Credential;
-import io.agora.rest.core.RegionArea;
+import io.agora.rest.core.DomainArea;
 import io.agora.rest.services.cloudrecording.CloudRecordingClient;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
@@ -11,7 +11,7 @@ public class BaseScenario {
 
     private static final Logger logger = LoggerFactory.getLogger(BaseScenario.class);
 
-    protected final RegionArea region;
+    protected final DomainArea domainArea;
 
     protected final String appId;
 
@@ -23,8 +23,8 @@ public class BaseScenario {
 
     protected final CloudRecordingClient cloudRecordingClient;
 
-    public BaseScenario(RegionArea region, String appId, String cname, String uid, Credential credential) {
-        this.region = region;
+    public BaseScenario(DomainArea domainArea, String appId, String cname, String uid, Credential credential) {
+        this.domainArea = domainArea;
         this.appId = appId;
         this.cname = cname;
         this.uid = uid;
@@ -33,7 +33,7 @@ public BaseScenario(RegionArea region, String appId, String cname, String uid, C
         AgoraConfig agoraConfig = AgoraConfig.builder()
                 .appId(appId)
                 .credential(credential)
-                .regionArea(region)
+                .domainArea(domainArea)
                 .build();
 
         logger.info("AgoraConfig: {}", agoraConfig);

examples/cloudrecording/src/main/java/io/agora/rest/examples/cloudrecording/scenario/IndividualRecordingScenario.java

@@ -2,7 +2,7 @@
 
 import io.agora.rest.AgoraException;
 import io.agora.rest.core.Credential;
-import io.agora.rest.core.RegionArea;
+import io.agora.rest.core.DomainArea;
 import io.agora.rest.services.cloudrecording.api.req.StartResourceReq;
 import io.agora.rest.services.cloudrecording.api.req.UpdateResourceReq;
 import io.agora.rest.services.cloudrecording.api.res.AcquireResourceRes;
@@ -22,8 +22,8 @@
 public class IndividualRecordingScenario extends BaseScenario {
     private static final Logger logger = LoggerFactory.getLogger(IndividualRecordingScenario.class);
 
-    public IndividualRecordingScenario(RegionArea region, String appId, String cname, String uid, Credential credential) {
-        super(region, appId, cname, uid, credential);
+    public IndividualRecordingScenario(DomainArea domainArea, String appId, String cname, String uid, Credential credential) {
+        super(domainArea, appId, cname, uid, credential);
     }
 
     public void runRecording(String token, StartResourceReq.StorageConfig storageConfig) {