preflight

Author: jeffreykzli

src/main/java/com/qcloud/cos/COSClient.java

@@ -39,6 +39,7 @@
 import java.util.Map;
 import java.util.Map.Entry;
 import java.util.Objects;
+import java.util.concurrent.ConcurrentHashMap;
 
 import com.fasterxml.jackson.core.Version;
 import com.fasterxml.jackson.databind.ObjectMapper;
@@ -165,6 +166,8 @@ public class COSClient implements COS {
 
     private CosHttpClient cosHttpClient;
 
+    private ConcurrentHashMap<String, Long> preflightBuckets = new ConcurrentHashMap<>();
+
     public COSClient(COSCredentials cred, ClientConfig clientConfig) {
         this(new COSStaticCredentialsProvider(cred), clientConfig);
     }
@@ -840,6 +843,17 @@ ObjectMetadata uploadObjectInternal(UploadMode uploadMode, UploadObjectRequest u
         rejectNull(bucketName,
                 "The bucket name parameter must be specified when uploading an object");
         rejectNull(key, "The key parameter must be specified when uploading an object");
+
+        try {
+            preflightObj(bucketName, key);
+        } catch (CosServiceException cse) {
+            log.warn("fail to do the preflight request due to the service exception, will not do the upload obj request", cse);
+            throw cse;
+        } catch (CosClientException cce) {
+            log.warn("fail to do the preflight request due to the client exception, will not do the upload obj request", cce);
+            throw cce;
+        }
+
         // If a file is specified for upload, we need to pull some additional
         // information from it to auto-configure a few options
         if (file == null) {
@@ -979,6 +993,22 @@ ObjectMetadata uploadObjectInternal(UploadMode uploadMode, UploadObjectRequest u
             CosDataSource.Utils.cleanupDataSource(uploadObjectRequest, file, isOrig, input, log);
         }
 
+        if (returnedMetadata.isNeedPreflight()) {
+            Long currentTime = System.currentTimeMillis();
+            if ((preflightBuckets.get(bucketName) == null) || ((currentTime - preflightBuckets.get(bucketName)) > clientConfig.getPreflightStatusUpdateInterval())) {
+                String reqMsg = String.format("will update preflight status, bucket[%s]",bucketName);
+                log.info(reqMsg);
+                preflightBuckets.put(bucketName, currentTime);
+            }
+        } else {
+            Long currentTime = System.currentTimeMillis();
+            if ((preflightBuckets.get(bucketName) != null) && ((currentTime - preflightBuckets.get(bucketName)) > clientConfig.getPreflightStatusUpdateInterval())) {
+                String reqMsg = String.format("will remove bucket[%s] from preflight lists",bucketName);
+                log.info(reqMsg);
+                preflightBuckets.remove(bucketName);
+            }
+        }
+
         String contentMd5 = metadata.getContentMD5();
         if (md5DigestStream != null) {
             contentMd5 = Base64.encodeAsString(md5DigestStream.getMd5Digest());
@@ -5475,5 +5505,22 @@ public BucketGetMetadataResult getBucketMetadata(String bucketName) throws CosCl
 
         return result;
     }
+
+    private void preflightObj(String bucketName, String key) throws CosClientException, CosServiceException {
+        rejectEmpty(bucketName,
+                "The bucket name parameter must be specified when doing preflight request");
+        rejectEmpty(key,
+                "The key parameter must be specified when doing preflight request");
+        if (clientConfig.isCheckPreflightStatus() && preflightBuckets.containsKey(bucketName)) {
+            String reqMsg = String.format("will do preflight request for put object[%s] to the bucket[%s]", key, bucketName);
+            log.debug(reqMsg);
+            CosServiceRequest serviceRequest = new CosServiceRequest();
+            CosHttpRequest<CosServiceRequest> request = createRequest(bucketName, key, serviceRequest, HttpMethodName.HEAD);
+            request.addParameter("preflight", null);
+            request.addHeader("x-cos-next-action", "PutObject");
+
+            invoke(request, voidCosResponseHandler);
+        }
+    }
 }
 

src/main/java/com/qcloud/cos/ClientConfig.java

@@ -127,6 +127,10 @@ public class ClientConfig {
 
     private boolean isRefreshEndpointAddr = false;
 
+    private boolean checkPreflightStatus = false;
+
+    private long preflightStatusUpdateInterval = 10 * 1000L;
+
     // 不传入region 用于后续调用List Buckets(获取所有的bucket信息)
     public ClientConfig() {
         super();
@@ -451,4 +455,16 @@ public void turnOnRefreshEndpointAddrSwitch() {
     public boolean IsRefreshEndpointAddr() {
         return isRefreshEndpointAddr;
     }
+
+    public boolean isCheckPreflightStatus() {
+        return checkPreflightStatus;
+    }
+
+    public void setCheckPreflightStatus(boolean checkPreflightStatus) {
+        this.checkPreflightStatus = checkPreflightStatus;
+    }
+
+    public long getPreflightStatusUpdateInterval() {
+        return preflightStatusUpdateInterval;
+    }
 }

src/main/java/com/qcloud/cos/model/ObjectMetadata.java

@@ -830,4 +830,12 @@ public CIUploadResult getCiUploadResult() {
     public void setCiUploadResult(CIUploadResult ciUploadResult) {
         this.ciUploadResult = ciUploadResult;
     }
+
+    public boolean isNeedPreflight() {
+        if (metadata.containsKey("x-cos-preflight")) {
+            String preflightStatus = (String)metadata.get("x-cos-preflight");
+            return preflightStatus.equalsIgnoreCase("true");
+        }
+        return false;
+    }
 }

src/main/java/com/qcloud/cos/retry/PredefinedRetryPolicies.java

@@ -60,6 +60,9 @@ public <X extends CosServiceRequest> boolean shouldRetry(CosHttpRequest<X> reque
                 Exception exception,
                 int retryIndex) {
             if (RetryUtils.isRetryableServiceException(exception)) {
+                if (request.getParameters().containsKey("preflight")) {
+                    return false;
+                }
                 return true;
             }