Support head bucket

Author: baiyubin2020

src/main/java/com/aliyun/oss/OSS.java

@@ -177,6 +177,27 @@ public interface OSS {
      */
     public AccessControlList getBucketAcl(GenericRequest genericRequest) throws OSSException, ClientException;
 
+    /**
+     * Gets the metadata of {@link Bucket}.
+     * 
+     * @param bucketName
+     *            Bucket name.
+     *
+     * @return The {@link BucketMetadata} instance.
+     */
+    public BucketMetadata getBucketMetadata(String bucketName) throws OSSException, ClientException;
+
+    /**
+     * Gets all the metadata of {@link Bucket}.
+     * 
+     * @param genericRequest
+     *            Generic request which specifies the bucket name.
+     *
+     * @return The {@link BucketMetadata} instance.
+     *
+     */
+    public BucketMetadata getBucketMetadata(GenericRequest genericRequest) throws OSSException, ClientException;
+
     /**
      * Sets the http referer on the {@link Bucket} instance specified by the
      * bucket name.

src/main/java/com/aliyun/oss/OSSClient.java

@@ -384,6 +384,16 @@ public AccessControlList getBucketAcl(GenericRequest genericRequest) throws OSSE
         return bucketOperation.getBucketAcl(genericRequest);
     }
 
+    @Override
+    public BucketMetadata getBucketMetadata(String bucketName) throws OSSException, ClientException {
+        return this.getBucketMetadata(new GenericRequest(bucketName));
+    }
+
+    @Override
+    public BucketMetadata getBucketMetadata(GenericRequest genericRequest) throws OSSException, ClientException {
+        return bucketOperation.getBucketMetadata(genericRequest);
+    }
+
     @Override
     public void setBucketReferer(String bucketName, BucketReferer referer) throws OSSException, ClientException {
         this.setBucketReferer(new SetBucketRefererRequest(bucketName, referer));

src/main/java/com/aliyun/oss/internal/OSSBucketOperation.java

@@ -34,7 +34,9 @@
 import static com.aliyun.oss.common.parser.RequestMarshallers.setBucketQosRequestMarshaller;
 import static com.aliyun.oss.common.parser.RequestMarshallers.bucketImageProcessConfMarshaller;
 import static com.aliyun.oss.common.utils.CodingUtils.assertParameterNotNull;
+import static com.aliyun.oss.internal.OSSUtils.OSS_RESOURCE_MANAGER;
 import static com.aliyun.oss.internal.OSSUtils.ensureBucketNameValid;
+import static com.aliyun.oss.internal.OSSUtils.safeCloseResponse;
 import static com.aliyun.oss.internal.RequestParameters.DELIMITER;
 import static com.aliyun.oss.internal.RequestParameters.ENCODING_TYPE;
 import static com.aliyun.oss.internal.RequestParameters.MARKER;
@@ -74,6 +76,7 @@
 import static com.aliyun.oss.internal.ResponseParsers.getBucketImageProcessConfResponseParser;
 
 import java.io.ByteArrayInputStream;
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.List;
@@ -83,17 +86,21 @@
 import com.aliyun.oss.HttpMethod;
 import com.aliyun.oss.OSSErrorCode;
 import com.aliyun.oss.OSSException;
+import com.aliyun.oss.ServiceException;
 import com.aliyun.oss.common.auth.CredentialsProvider;
 import com.aliyun.oss.common.comm.RequestMessage;
+import com.aliyun.oss.common.comm.ResponseHandler;
 import com.aliyun.oss.common.comm.ResponseMessage;
 import com.aliyun.oss.common.comm.ServiceClient;
 import com.aliyun.oss.common.utils.BinaryUtil;
+import com.aliyun.oss.common.utils.ExceptionFactory;
 import com.aliyun.oss.common.utils.HttpHeaders;
 import com.aliyun.oss.model.AccessControlList;
 import com.aliyun.oss.model.Bucket;
 import com.aliyun.oss.model.BucketInfo;
 import com.aliyun.oss.model.BucketList;
 import com.aliyun.oss.model.BucketLoggingResult;
+import com.aliyun.oss.model.BucketMetadata;
 import com.aliyun.oss.model.BucketProcess;
 import com.aliyun.oss.model.BucketReferer;
 import com.aliyun.oss.model.BucketReplicationProgress;
@@ -129,6 +136,7 @@
 import com.aliyun.oss.model.TagSet;
 import com.aliyun.oss.model.Style;
 import com.aliyun.oss.model.UserQos;
+import org.apache.http.HttpStatus;
 
 /**
  * Bucket operation.
@@ -264,6 +272,34 @@ public AccessControlList getBucketAcl(GenericRequest genericRequest) throws OSSE
         return doOperation(request, getBucketAclResponseParser, bucketName, null, true);
     }
 
+    public BucketMetadata getBucketMetadata(GenericRequest genericRequest) throws OSSException, ClientException {
+
+        assertParameterNotNull(genericRequest, "genericRequest");
+
+        String bucketName = genericRequest.getBucketName();
+        assertParameterNotNull(bucketName, "bucketName");
+        ensureBucketNameValid(bucketName);
+
+        RequestMessage request = new OSSRequestMessageBuilder(getInnerClient()).setEndpoint(getEndpoint())
+                .setMethod(HttpMethod.HEAD).setBucket(bucketName).setOriginalRequest(genericRequest).build();
+
+        List<ResponseHandler> reponseHandlers = new ArrayList<ResponseHandler>();
+        reponseHandlers.add(new ResponseHandler() {
+            @Override
+            public void handle(ResponseMessage response) throws ServiceException, ClientException {
+                if (response.getStatusCode() == HttpStatus.SC_NOT_FOUND) {
+                    safeCloseResponse(response);
+                    throw ExceptionFactory.createOSSException(
+                            response.getHeaders().get(OSSHeaders.OSS_HEADER_REQUEST_ID), OSSErrorCode.NO_SUCH_BUCKET,
+                            OSS_RESOURCE_MANAGER.getString("NoSuchBucket"));
+                }
+            }
+        });
+
+        return doOperation(request, ResponseParsers.getBucketMetadataResponseParser, bucketName, null, true, null,
+                reponseHandlers);
+    }
+
     /**
      * Set bucket referer.
      */

src/main/java/com/aliyun/oss/internal/OSSHeaders.java

@@ -78,4 +78,6 @@ public interface OSSHeaders extends HttpHeaders {
     static final String OSS_STORAGE_CLASS = "x-oss-storage-class";
     static final String OSS_RESTORE = "x-oss-restore";
     static final String OSS_ONGOING_RESTORE = "ongoing-request=\"true\"";
+
+    static final String OSS_BUCKET_REGION = "x-oss-bucket-region";
 }

src/main/java/com/aliyun/oss/internal/ResponseParsers.java

@@ -50,6 +50,7 @@
 import com.aliyun.oss.model.BucketInfo;
 import com.aliyun.oss.model.BucketList;
 import com.aliyun.oss.model.BucketLoggingResult;
+import com.aliyun.oss.model.BucketMetadata;
 import com.aliyun.oss.model.BucketProcess;
 import com.aliyun.oss.model.BucketReferer;
 import com.aliyun.oss.model.BucketReplicationProgress;
@@ -121,6 +122,7 @@ public final class ResponseParsers {
     public static final ListImageStyleResponseParser listImageStyleResponseParser = new ListImageStyleResponseParser();
     public static final GetBucketRefererResponseParser getBucketRefererResponseParser = new GetBucketRefererResponseParser();
     public static final GetBucketAclResponseParser getBucketAclResponseParser = new GetBucketAclResponseParser();
+    public static final GetBucketMetadataResponseParser getBucketMetadataResponseParser = new GetBucketMetadataResponseParser();
     public static final GetBucketLocationResponseParser getBucketLocationResponseParser = new GetBucketLocationResponseParser();
     public static final GetBucketLoggingResponseParser getBucketLoggingResponseParser = new GetBucketLoggingResponseParser();
     public static final GetBucketWebsiteResponseParser getBucketWebsiteResponseParser = new GetBucketWebsiteResponseParser();
@@ -236,6 +238,19 @@ public AccessControlList parse(ResponseMessage response) throws ResponseParseExc
         }
 
     }
+	
+    public static final class GetBucketMetadataResponseParser implements ResponseParser<BucketMetadata> {
+
+        @Override
+        public BucketMetadata parse(ResponseMessage response) throws ResponseParseException {
+            try {
+                return parseBucketMetadata(response.getHeaders());
+            } finally {
+                safeCloseResponse(response);
+            }
+        }
+
+    }
 
     public static final class GetBucketLocationResponseParser implements ResponseParser<String> {
 
@@ -1256,6 +1271,30 @@ public static String parseGetBucketLocation(InputStream responseBody) throws Res
 
     }
 
+    /**
+     * Unmarshall bucket metadata from response headers.
+     */
+    public static BucketMetadata parseBucketMetadata(Map<String, String> headers) throws ResponseParseException {
+
+        try {
+            BucketMetadata bucketMetadata = new BucketMetadata();
+
+            for (Iterator<String> it = headers.keySet().iterator(); it.hasNext();) {
+                String key = it.next();
+
+                if (key.equals(OSSHeaders.OSS_BUCKET_REGION)) {
+                    bucketMetadata.setBucketRegion(headers.get(key));
+                } else {
+                    bucketMetadata.addHttpMetadata(key, headers.get(key));
+                }
+            }
+
+            return bucketMetadata;
+        } catch (Exception e) {
+            throw new ResponseParseException(e.getMessage(), e);
+        }
+    }
+
     /**
      * Unmarshall simplified object meta from response headers.
      */

src/main/java/com/aliyun/oss/model/BucketMetadata.java

@@ -0,0 +1,75 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.aliyun.oss.model;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import com.aliyun.oss.internal.OSSHeaders;
+
+/**
+ * OSS Bucket's metadata.
+ */
+public class BucketMetadata {
+
+    /**
+     * Gets bucket region.
+     * 
+     * @return bucket region.
+     */
+    public String getBucketRegion() {
+        return httpMetadata.get(OSSHeaders.OSS_BUCKET_REGION);
+    }
+
+    /**
+     * Sets bucket region. SDK uses.
+     * 
+     * @param bucketRegion
+     *            bucket Region.
+     */
+    public void setBucketRegion(String bucketRegion) {
+        httpMetadata.put(OSSHeaders.OSS_BUCKET_REGION, bucketRegion);
+    }
+
+    /**
+     * Add http metadata.
+     * 
+     * @param key
+     *            The key of header.
+     * @param value
+     *            The value of the key.
+     */
+    public void addHttpMetadata(String key, String value) {
+        httpMetadata.put(key, value);
+    }
+
+    /**
+     * Gets the http metadata.
+     * 
+     * @return http metadata
+     */
+    public Map<String, String> getHttpMetadata() {
+        return httpMetadata;
+    }
+
+    // http headers.
+    private Map<String, String> httpMetadata = new HashMap<String, String>();
+
+}

src/test/java/com/aliyun/oss/integrationtests/BucketMetadataTest.java

@@ -0,0 +1,61 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package com.aliyun.oss.integrationtests;
+
+import junit.framework.Assert;
+
+import org.junit.Test;
+
+import com.aliyun.oss.OSSErrorCode;
+import com.aliyun.oss.OSSException;
+import com.aliyun.oss.internal.OSSHeaders;
+import com.aliyun.oss.model.BucketMetadata;
+
+public class BucketMetadataTest extends TestBase {
+
+    @Test
+    public void testGetBucketMetadata() {
+        try {
+            BucketMetadata meta = ossClient.getBucketMetadata(bucketName);
+            Assert.assertEquals(meta.getBucketRegion(), TestConfig.OSS_TEST_REGION);
+            Assert.assertEquals(meta.getHttpMetadata().get(OSSHeaders.OSS_HEADER_REQUEST_ID).length(),
+                    "59F2AC3B349A25FA4C44BF8A".length());
+        } catch (Exception e) {
+        	e.printStackTrace();
+            Assert.fail(e.getMessage());
+        } 
+    }
+    
+    @Test
+    public void testUnormalGetBucketMetadata() {
+        final String bucketName = "unormal-get-bucket-meta";
+        
+        // bucket non-existent 
+        try {
+            ossClient.getBucketMetadata(bucketName);
+            Assert.fail("Get bucket meta should not be successful");
+        } catch (OSSException e) {
+            Assert.assertEquals(OSSErrorCode.NO_SUCH_KEY, e.getErrorCode());
+            Assert.assertEquals(e.getRequestId().length(), "59F2AC3B349A25FA4C44BF8A".length());
+        }
+
+    }
+    
+}