chore:Add commnets to cloudrecording service

agora-rest-client-core/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Agora Community
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

agora-rest-client-core/pom.xml

@@ -125,11 +125,7 @@
     <build>
         <resources>
             <resource>
-                <directory>..</directory>
-                <includes>
-                    <include>LICENSE</include>
-                </includes>
-                <targetPath>META-INF</targetPath>
+                <directory>src/main/resources</directory>
             </resource>
             <resource>
                 <directory>src</directory>
@@ -239,6 +235,39 @@
                     </execution>
                 </executions>
             </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-resources-plugin</artifactId>
+                <version>3.3.1</version>
+                <configuration>
+                    <propertiesEncoding>UTF-8</propertiesEncoding>
+                    <nonFilteredFileExtensions>
+                        <nonFilteredFileExtension>pdf</nonFilteredFileExtension>
+                        <nonFilteredFileExtension>swf</nonFilteredFileExtension>
+                    </nonFilteredFileExtensions>
+                </configuration>
+                <executions>
+                    <execution>
+                        <id>copy-license</id>
+                        <phase>process-resources</phase>
+                        <goals>
+                            <goal>copy-resources</goal>
+                        </goals>
+                        <configuration>
+                            <outputDirectory>${project.build.outputDirectory}/META-INF</outputDirectory>
+                            <resources>
+                                <resource>
+                                    <directory>${project.basedir}</directory>
+                                    <includes>
+                                        <include>LICENSE</include>
+                                    </includes>
+                                    <filtering>false</filtering>
+                                </resource>
+                            </resources>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 </project>

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

@@ -1,9 +1,7 @@
 package io.agora.rest.services.cloudrecording;
 
 import io.agora.rest.core.AgoraConfig;
-import io.agora.rest.core.Context;
 import io.agora.rest.core.DefaultContext;
-import io.agora.rest.services.cloudrecording.api.*;
 import io.agora.rest.services.cloudrecording.api.req.*;
 import io.agora.rest.services.cloudrecording.api.res.*;
 import io.agora.rest.services.cloudrecording.enums.CloudRecordingModeEnum;
@@ -12,79 +10,64 @@
 import io.agora.rest.services.cloudrecording.scenario.web.WebScenario;
 import reactor.core.publisher.Mono;
 
-public class CloudRecordingClient {
-
-    private final AcquireResourceAPI acquireResourceAPI;
-
-    private final QueryResourceAPI queryResourceAPI;
-
-    private final StartResourceAPI startResourceAPI;
-
-    private final UpdateResourceAPI updateResourceAPI;
-
-    private final StopResourceAPI stopResourceAPI;
-
-    private final IndividualScenario individualScenario;
-
-    private final WebScenario webScenario;
-
-    private final MixScenario mixScenario;
-
-    public static CloudRecordingClient create(AgoraConfig agoraConfig) {
-        return new CloudRecordingClient(new DefaultContext(agoraConfig));
+public abstract class CloudRecordingClient  {
+
+    private static CloudRecordingClient mInstance;
+
+    /**
+     * @param cloudRecordingConfig Instance of {@link CloudRecordingConfig}.
+     * @return Returns the Cloud Recording client instance.
+     * @brief Creates a Cloud Recording client with the specified configuration.
+     * @since v0.4.0
+     */
+    public static synchronized CloudRecordingClient create(CloudRecordingConfig cloudRecordingConfig) {
+        if (mInstance == null) {
+            AgoraConfig agoraConfig = AgoraConfig.builder()
+                    .appId(cloudRecordingConfig.getAppId())
+                    .credential(cloudRecordingConfig.getCredential())
+                    .domainArea(cloudRecordingConfig.getDomainArea())
+                    .httpProperty(cloudRecordingConfig.getHttpProperty())
+                    .build();
+            mInstance=new CloudRecordingClientImpl(new DefaultContext(agoraConfig));
+        }
+
+        return mInstance;
     }
 
-    protected CloudRecordingClient(Context context) {
-        this.acquireResourceAPI = new AcquireResourceAPI(context);
-        this.queryResourceAPI = new QueryResourceAPI(context);
-        this.startResourceAPI = new StartResourceAPI(context);
-        this.stopResourceAPI = new StopResourceAPI(context);
-        this.updateResourceAPI = new UpdateResourceAPI(context);
-
-        this.individualScenario = new IndividualScenario(acquireResourceAPI, queryResourceAPI, startResourceAPI,
-                updateResourceAPI, stopResourceAPI);
-        this.webScenario = new WebScenario(acquireResourceAPI, queryResourceAPI, startResourceAPI, updateResourceAPI,
-                stopResourceAPI);
-        this.mixScenario = new MixScenario(acquireResourceAPI, queryResourceAPI, startResourceAPI, updateResourceAPI,
-                stopResourceAPI);
-    }
 
-    public Mono<AcquireResourceRes> acquire(AcquireResourceReq request) {
-        return acquireResourceAPI.handle(request);
-    }
+    public abstract Mono<AcquireResourceRes> acquire(AcquireResourceReq request);
 
-    public Mono<StartResourceRes> start(String resourceId, CloudRecordingModeEnum mode, StartResourceReq request) {
-        return startResourceAPI.handle(resourceId, mode, request);
-    }
+    public abstract Mono<StartResourceRes> start(String resourceId, CloudRecordingModeEnum mode, StartResourceReq request);
 
-    public Mono<QueryResourceRes> query(String resourceId, String sid, CloudRecordingModeEnum mode) {
-        return queryResourceAPI.handle(resourceId, sid, mode);
-    }
+    public abstract Mono<QueryResourceRes> query(String resourceId, String sid, CloudRecordingModeEnum mode);
 
-    public Mono<StopResourceRes> stop(String resourceId, String sid, CloudRecordingModeEnum mode,
-                                      StopResourceReq request) {
-        return stopResourceAPI.handle(resourceId, sid, mode, request);
-    }
+    public abstract Mono<StopResourceRes> stop(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                               StopResourceReq request);
 
-    public Mono<UpdateResourceRes> update(String resourceId, String sid, CloudRecordingModeEnum mode,
-                                          UpdateResourceReq request) {
-        return updateResourceAPI.handle(resourceId, sid, mode, request);
-    }
+    public abstract Mono<UpdateResourceRes> update(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                                   UpdateResourceReq request);
 
-    public Mono<UpdateLayoutResourceRes> updateLayout(String resourceId, String sid, CloudRecordingModeEnum mode,
-                                                      UpdateLayoutResourceReq request) {
-        return updateResourceAPI.handleLayout(resourceId, sid, mode, request);
-    }
+    public abstract Mono<UpdateLayoutResourceRes> updateLayout(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                                               UpdateLayoutResourceReq request);
 
-    public IndividualScenario individualScenario() {
-        return individualScenario;
-    }
+    /**
+     * @brief Returns the individual scenario instance.
+     * @return Returns the individual scenario instance.
+     * @since v0.4.0
+     */
+    public abstract IndividualScenario individualScenario();
 
-    public WebScenario webScenario() {
-        return webScenario;
-    }
+    /**
+     * @brief Returns the web scenario instance.
+     * @return Returns the web scenario instance.
+     * @since v0.4.0
+     */
+    public abstract WebScenario webScenario();
 
-    public MixScenario mixScenario() {
-        return mixScenario;
-    }
+    /**
+     * @brief Returns the mix scenario instance.
+     * @return Returns the mix scenario instance.
+     * @since v0.4.0
+     */
+    public abstract MixScenario mixScenario();
 }

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

@@ -0,0 +1,87 @@
+package io.agora.rest.services.cloudrecording;
+
+import io.agora.rest.core.Context;
+import io.agora.rest.services.cloudrecording.api.*;
+import io.agora.rest.services.cloudrecording.api.req.*;
+import io.agora.rest.services.cloudrecording.api.res.*;
+import io.agora.rest.services.cloudrecording.enums.CloudRecordingModeEnum;
+import io.agora.rest.services.cloudrecording.scenario.individual.IndividualScenario;
+import io.agora.rest.services.cloudrecording.scenario.individual.IndividualScenarioImpl;
+import io.agora.rest.services.cloudrecording.scenario.mix.MixScenario;
+import io.agora.rest.services.cloudrecording.scenario.mix.MixScenarioImpl;
+import io.agora.rest.services.cloudrecording.scenario.web.WebScenario;
+import io.agora.rest.services.cloudrecording.scenario.web.WebScenarioImpl;
+import reactor.core.publisher.Mono;
+
+public class CloudRecordingClientImpl extends CloudRecordingClient {
+
+    private final AcquireResourceAPI acquireResourceAPI;
+
+    private final QueryResourceAPI queryResourceAPI;
+
+    private final StartResourceAPI startResourceAPI;
+
+    private final UpdateResourceAPI updateResourceAPI;
+
+    private final StopResourceAPI stopResourceAPI;
+
+    private final IndividualScenario individualScenario;
+
+    private final WebScenario webScenario;
+
+    private final MixScenario mixScenario;
+
+    protected CloudRecordingClientImpl(Context context) {
+        this.acquireResourceAPI = new AcquireResourceAPI(context);
+        this.queryResourceAPI = new QueryResourceAPI(context);
+        this.startResourceAPI = new StartResourceAPI(context);
+        this.stopResourceAPI = new StopResourceAPI(context);
+        this.updateResourceAPI = new UpdateResourceAPI(context);
+
+        this.individualScenario = new IndividualScenarioImpl(acquireResourceAPI, queryResourceAPI, startResourceAPI,
+                updateResourceAPI, stopResourceAPI);
+        this.webScenario = new WebScenarioImpl(acquireResourceAPI, queryResourceAPI, startResourceAPI, updateResourceAPI,
+                stopResourceAPI);
+        this.mixScenario = new MixScenarioImpl(acquireResourceAPI, queryResourceAPI, startResourceAPI, updateResourceAPI,
+                stopResourceAPI);
+    }
+
+    public Mono<AcquireResourceRes> acquire(AcquireResourceReq request) {
+        return acquireResourceAPI.handle(request);
+    }
+
+    public Mono<StartResourceRes> start(String resourceId, CloudRecordingModeEnum mode, StartResourceReq request) {
+        return startResourceAPI.handle(resourceId, mode, request);
+    }
+
+    public Mono<QueryResourceRes> query(String resourceId, String sid, CloudRecordingModeEnum mode) {
+        return queryResourceAPI.handle(resourceId, sid, mode);
+    }
+
+    public Mono<StopResourceRes> stop(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                      StopResourceReq request) {
+        return stopResourceAPI.handle(resourceId, sid, mode, request);
+    }
+
+    public Mono<UpdateResourceRes> update(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                          UpdateResourceReq request) {
+        return updateResourceAPI.handle(resourceId, sid, mode, request);
+    }
+
+    public Mono<UpdateLayoutResourceRes> updateLayout(String resourceId, String sid, CloudRecordingModeEnum mode,
+                                                      UpdateLayoutResourceReq request) {
+        return updateResourceAPI.handleLayout(resourceId, sid, mode, request);
+    }
+
+    public IndividualScenario individualScenario() {
+        return individualScenario;
+    }
+
+    public WebScenario webScenario() {
+        return webScenario;
+    }
+
+    public MixScenario mixScenario() {
+        return mixScenario;
+    }
+}