release 0.0.7-beta source code for java

Author: unionsdk

CHANGELOG.md

@@ -1,3 +1,92 @@
+# 0.0.7-beta 2023-06-16
+
+### G42Cloud SDK CCE
+
+- _Features_
+  - None
+- _Bug Fix_
+  - None
+- _Change_
+  - **ShowNode**
+    - changes of response param
+      - `+ status.lastProbeTime`
+  - **UpdateNode**
+    - changes of response param
+      - `+ status.lastProbeTime`
+  - **DeleteNode**
+    - changes of response param
+      - `+ status.lastProbeTime`
+  - **CreateNode**
+    - changes of response param
+      - `+ status.lastProbeTime`
+  - **ListNodes**
+    - changes of response param
+      - `+ items.status.lastProbeTime`
+
+### G42Cloud SDK CSE
+
+- _Features_
+  - None
+- _Bug Fix_
+  - None
+- _Change_
+  - **DownloadKie**
+    - changes of response param
+      - `+ data.id`
+  - **CreateEngine**
+    - changes of response param
+      - `+ jobId`
+      - `- job_id`
+  - **DeleteEngine**
+    - changes of response param
+      - `+ jobId`
+      - `- job_id`
+
+### G42Cloud SDK ECS
+
+- _Features_
+  - None
+- _Bug Fix_
+  - None
+- _Change_
+  - **CreateServers**
+    - changes of request param
+      - `+ server.data_volumes.delete_on_termination`
+  - **CreatePostPaidServers**
+    - changes of request param
+      - `+ server.data_volumes.delete_on_termination`
+
+### G42Cloud SDK SMN
+
+- _Features_
+  - Support the following interfaces：
+    - `UpdateSubscription`
+    - `ListLogtank`
+    - `CreateLogtank`
+    - `UpdateLogtank`
+    - `DeleteLogtank`
+- _Bug Fix_
+  - None
+- _Change_
+  - **ListTopicDetails**
+    - changes of response param
+      - `+ topic_id`
+  - **ListTopics**
+    - changes of request param
+      - `+ topic_id`
+    - changes of response param
+      - `+ topics.topic_id`
+  - **ListTopicAttributes**
+    - changes of response param
+      - `+ attributes.access_policy`
+      - `+ attributes.introduction`
+      - `- attributes.Version`
+      - `- attributes.Id`
+      - `- attributes.Statement`
+  - **AddSubscription**
+    - changes of request param
+      - `+ extension`
+
 # 0.0.6-beta 2023-05-12
 
 ### G42Cloud SDK CBR

core/pom.xml

@@ -5,14 +5,14 @@
 
     <parent>
         <groupId>io.github.g42cloud-sdk</groupId>
-        <version>0.0.6-beta</version>
+        <version>0.0.7-beta</version>
         <artifactId>g42cloud-sdk</artifactId>
     </parent>
 
     <modelVersion>4.0.0</modelVersion>
     <packaging>jar</packaging>
     <artifactId>g42cloud-sdk-core</artifactId>
-    <version>0.0.6-beta</version>
+    <version>0.0.7-beta</version>
     <name>G42 Cloud SDK for Java Core</name>
     <description>Core library for G42 Cloud Java SDK</description>
     <url>https://github.com/g42cloud-sdk/g42cloud-sdk-java</url>

core/src/main/java/com/g42cloud/sdk/core/Constants.java

@@ -71,6 +71,14 @@ public final class Constants {
 
     public static final String ISO_8601_BASIC_FORMAT = "yyyyMMdd'T'HHmmss'Z'";
 
+    public static final int DEFAULT_CHUNK_SIZE = 4096;
+
+    public static final int DEFAULT_WRITE_BUFFER_STREAM = 8192;
+
+    public static final int DEFAULT_READ_BUFFER_STREAM = 8192;
+
+    public static final long DEFAULT_PROGRESS_INTERVAL = 100 * 1024L;
+
     /**
      * Supported media type
      */

core/src/main/java/com/g42cloud/sdk/core/HcClient.java

@@ -39,13 +39,18 @@
 import com.g42cloud.sdk.core.http.LocationType;
 import com.g42cloud.sdk.core.http.SdkFormDataBody;
 import com.g42cloud.sdk.core.impl.DefaultHttpClient;
+import com.g42cloud.sdk.core.progress.ProgressInputStream;
+import com.g42cloud.sdk.core.progress.ProgressRequest;
+import com.g42cloud.sdk.core.progress.SimpleProgressManager;
 import com.g42cloud.sdk.core.utils.CastUtils;
 import com.g42cloud.sdk.core.utils.ExceptionUtils;
+import com.g42cloud.sdk.core.utils.HttpUtils;
 import com.g42cloud.sdk.core.utils.JsonUtils;
 import com.g42cloud.sdk.core.utils.StringUtils;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+import java.io.BufferedInputStream;
 import java.net.MalformedURLException;
 import java.net.URL;
 import java.time.OffsetDateTime;
@@ -185,7 +190,7 @@ public <ReqT, ResT> ResT syncInvokeHttp(ReqT request, HttpRequestDef<ReqT, ResT>
             }
             printAccessLog(httpRequest, httpResponse, exchange);
             handleException(httpRequest, httpResponse);
-            return extractResponse(httpResponse, reqDef);
+            return extractResponse(httpRequest, httpResponse, reqDef);
         } finally {
             SdkExchangeCache.removeExchange(exchangeId);
         }
@@ -233,7 +238,7 @@ public <ReqT, ResT> CompletableFuture<ResT> asyncInvokeHttp(ReqT request, HttpRe
             return httpClient.asyncInvokeHttp(validHttpRequest).thenApplyAsync(httpResponse -> {
                 printAccessLog(finalValidHttpRequest, httpResponse, exchange);
                 handleException(finalValidHttpRequest, httpResponse);
-                return extractResponse(httpResponse, reqDef);
+                return extractResponse(finalValidHttpRequest, httpResponse, reqDef);
             }, httpConfig.getExecutorService()).whenCompleteAsync((r, e) ->
                     SdkExchangeCache.removeExchange(exchangeIdRef.get()), httpConfig.getExecutorService());
         }, httpConfig.getExecutorService());
@@ -285,9 +290,15 @@ protected <ReqT, ResT> HttpRequest buildRequest(ReqT request, HttpRequestDef<Req
             }
         }
 
-        // upload
-        if (request instanceof SdkStreamRequest) {
-            httpRequestBuilder.withBody(((SdkStreamRequest) request).extractBody());
+        // handle upload/download progress
+        if (request instanceof ProgressRequest) {
+            ProgressRequest progressRequest = (ProgressRequest) request;
+            httpRequestBuilder.withProgressListener((progressRequest.getProgressListener()))
+                    .withProgressInterval(progressRequest.getProgressInterval() > 0 ?
+                            progressRequest.getProgressInterval() : Constants.DEFAULT_PROGRESS_INTERVAL);
+            if (request instanceof SdkStreamRequest) {
+                httpRequestBuilder.withBody(((SdkStreamRequest) request).extractBody());
+            }
         }
 
         httpRequestBuilder.addHeader(Constants.USER_AGENT, "g42cloud-usdk-java/3.0");
@@ -311,12 +322,13 @@ private void buildRequestBody(HttpRequest.HttpRequestBuilder httpRequestBuilder,
         } else if (reqValue instanceof SdkSerializable) {
             httpRequestBuilder.withBodyAsString(((SdkSerializable<?>) reqValue).serialize());
         } else {
-            httpRequestBuilder.withBodyAsString(JsonUtils.toJSON(reqValue));
+            String bodyString = reqValue instanceof String ? (String) reqValue : JsonUtils.toJSON(reqValue);
+            httpRequestBuilder.withBodyAsString(bodyString);
         }
     }
 
     private void buildQueryParams(HttpRequest.HttpRequestBuilder httpRequestBuilder, String fieldName,
-        Object reqValue) {
+                                  Object reqValue) {
         if (reqValue instanceof Collection) {
             httpRequestBuilder.addQueryParam(fieldName, buildCollectionQueryParams(reqValue));
         } else if (reqValue instanceof Map) {
@@ -380,52 +392,75 @@ private void handleException(HttpRequest httpRequest, HttpResponse httpResponse)
         }
     }
 
-    private <ReqT, ResT> ResT extractResponse(HttpResponse httpResponse, HttpRequestDef<ReqT, ResT> reqDef) {
-        int code = httpResponse.getStatusCode();
+    private <T> T processTextBasedType(HttpResponse httpResponse, HttpRequestDef<?, T> reqDef)
+            throws InstantiationException, IllegalAccessException {
 
-        try {
-            ResT resT;
-            String stringResult = httpResponse.getBodyAsString();
-            String respContentType = httpResponse.getContentType();
-
-            if (Objects.nonNull(respContentType)
-                    && (respContentType.startsWith(Constants.MEDIATYPE.APPLICATION_OCTET_STREAM)
-                    || respContentType.startsWith(Constants.MEDIATYPE.IMAGE)
-                    || respContentType.startsWith(Constants.MEDIATYPE.APPLICATION_BSON))) {
-                resT = reqDef.getResponseType().newInstance();
-                if (resT instanceof SdkStreamResponse) {
-                    resT = CastUtils.cast(((SdkStreamResponse) resT).parseBody(httpResponse.getBody()));
-                }
-            } else {
-                if (SdkSerializable.class.isAssignableFrom(reqDef.getResponseType())) {
-                    resT = deserializeSerializableResponse(reqDef.getResponseType(), stringResult);
-                } else if (!reqDef.hasResponseField(Constants.BODY)) {
-                    resT = JsonUtils.toObjectIgnoreUnknown(stringResult, reqDef.getResponseType());
-                    if (Objects.isNull(resT)) {
-                        resT = reqDef.getResponseType().newInstance();
-                    }
+        T response;
+        String stringResult = httpResponse.getBodyAsString();
+        int statusCode = httpResponse.getStatusCode();
+        if (SdkSerializable.class.isAssignableFrom(reqDef.getResponseType())) {
+            // Processes the response that implements the SdkSerializable interface
+            response = deserializeSerializableResponse(reqDef.getResponseType(), stringResult);
+        } else if (!reqDef.hasResponseField(Constants.BODY)) {
+            // process response without body
+            response = JsonUtils.toObjectIgnoreUnknown(stringResult, reqDef.getResponseType());
+            if (Objects.isNull(response)) {
+                response = reqDef.getResponseType().newInstance();
+            }
 
-                    if (reqDef.hasResponseField(String.valueOf(code))) {
-                        Field<ResT, ?> resTField = reqDef.getResponseField(String.valueOf(code));
-                        resTField.writeValueSafe(resT,
-                                JsonUtils.toObjectIgnoreUnknown(stringResult, resTField.getFieldType()),
-                                resTField.getFieldType());
-                    }
+            if (reqDef.hasResponseField(String.valueOf(statusCode))) {
+                Field<T, ?> resTField = reqDef.getResponseField(String.valueOf(statusCode));
+                resTField.writeValueSafe(response,
+                        JsonUtils.toObjectIgnoreUnknown(stringResult, resTField.getFieldType()),
+                        resTField.getFieldType());
+            }
 
-                } else {
-                    resT = reqDef.getResponseType().newInstance();
-                    Field<ResT, ?> responseField = reqDef.getResponseField(Constants.BODY);
-                    Object obj = responseToObject(stringResult, responseField);
-                    responseField.writeValueSafe(resT, obj, responseField.getFieldType());
+        } else {
+            // process response with body[object, map, list, string...]
+            response = reqDef.getResponseType().newInstance();
+            Field<T, ?> responseField = reqDef.getResponseField(Constants.BODY);
+            Object obj = responseToObject(stringResult, responseField);
+            responseField.writeValueSafe(response, obj, responseField.getFieldType());
+
+            if (reqDef.hasResponseField(String.valueOf(statusCode))) {
+                Field<T, ?> resTField = reqDef.getResponseField(String.valueOf(statusCode));
+                resTField.writeValueSafe(response, obj, resTField.getFieldType());
+            }
+        }
 
-                    if (reqDef.hasResponseField(String.valueOf(code))) {
-                        Field<ResT, ?> resTField = reqDef.getResponseField(String.valueOf(code));
-                        resTField.writeValueSafe(resT, obj, resTField.getFieldType());
-                    }
-                }
+        return response;
+    }
+
+    private <T> T processStreamType(HttpRequest httpRequest, HttpResponse httpResponse, HttpRequestDef<?, T> reqDef)
+            throws InstantiationException, IllegalAccessException {
+
+        T response = reqDef.getResponseType().newInstance();
+        if (response instanceof SdkStreamResponse) {
+            if (Objects.nonNull(httpRequest.getProgressListener())) {
+                SimpleProgressManager progressManager = new SimpleProgressManager(
+                        httpResponse.getContentLength(), 0,
+                        httpRequest.getProgressListener(), httpRequest.getProgressInterval());
+                ((SdkStreamResponse) response).parseBody(new BufferedInputStream(
+                        new ProgressInputStream(httpResponse.getBody(), progressManager),
+                        Constants.DEFAULT_READ_BUFFER_STREAM));
+            } else if (Objects.nonNull(httpResponse.getContentType())
+                    && HttpUtils.isBsonContentType(httpResponse.getContentType())) {
+                response = CastUtils.cast(((SdkStreamResponse) response).parseBody(httpResponse.getBodyAsBytes()));
+            } else {
+                response = CastUtils.cast(((SdkStreamResponse) response).parseBody(httpResponse.getBody()));
             }
+        }
+
+        return response;
+    }
+
+    private <ReqT, ResT> ResT extractResponse(
+            HttpRequest httpRequest, HttpResponse httpResponse, HttpRequestDef<ReqT, ResT> reqDef) {
+
+        try {
+            ResT finalResT = HttpUtils.isTextBasedContentType(httpResponse.getContentType()) ?
+                    processTextBasedType(httpResponse, reqDef) : processStreamType(httpRequest, httpResponse, reqDef);
 
-            ResT finalResT = resT;
             reqDef.getResponseFields().forEach(resTField -> {
                 if (resTField.getLocation() == LocationType.Header) {
                     fillHeaderField(httpResponse, finalResT, resTField);

core/src/main/java/com/g42cloud/sdk/core/SdkStreamRequest.java

@@ -22,13 +22,39 @@
 package com.g42cloud.sdk.core;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.g42cloud.sdk.core.progress.ProgressListener;
+import com.g42cloud.sdk.core.progress.ProgressRequest;
 
 import java.io.InputStream;
 
 /**
  * @author G42Cloud_SDK
  */
-public class SdkStreamRequest implements SdkRequest {
+public class SdkStreamRequest implements SdkRequest, ProgressRequest {
+
+    private ProgressListener progressListener;
+
+    private long progressInterval;
+
+    @Override
+    public void setProgressListener(ProgressListener progressListener) {
+        this.progressListener = progressListener;
+    }
+
+    @Override
+    public ProgressListener getProgressListener() {
+        return progressListener;
+    }
+
+    @Override
+    public void setProgressInterval(long progressInterval) {
+        this.progressInterval = progressInterval;
+    }
+
+    @Override
+    public long getProgressInterval() {
+        return progressInterval;
+    }
 
     @JsonIgnore
     private InputStream body;

core/src/main/java/com/g42cloud/sdk/core/SdkStreamResponse.java

@@ -38,13 +38,26 @@ public class SdkStreamResponse extends SdkResponse {
 
     /**
      * 解析http响应body，用于content-type是application/bson或application/octet-stream的响应
+     *
      * @param inputStream http response body
      */
     public Object parseBody(InputStream inputStream) {
         this.body = inputStream;
         return this;
     }
 
+    /**
+     * 解析http响应body到XXXResponse，XXXResponse是SdkBsonDocResponse的子类，
+     * 目前只有SdkBsonDocResponse的子类的解析会使用这个函数，即content-type是application/bson的响应。
+     * 把该函数放在SdkStreamResponse的目的是为了解除core模块对core-bson模块的依赖。
+     *
+     * @param buf http response body
+     * @return object deserialized from buf
+     */
+    public Object parseBody(byte[] buf) {
+        throw new SdkException("only used in application/bson response");
+    }
+
     public void consumeDownloadStream(Consumer<InputStream> consumer) {
         try (InputStream inputStream = this.body) {
             consumer.accept(inputStream);