added get describe regions interface (#464)

Author: zhuxiaolong37

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

@@ -5101,4 +5101,16 @@ public UdfApplicationLog getUdfApplicationLog(GetUdfApplicationLogRequest getUdf
      *             If any errors occurred in OSS while processing the request.
      */
     VoidResult closeMetaQuery(String bucketName) throws OSSException, ClientException;
+
+    /**
+     * Describe regions from the OSS Server
+     * @param describeRegionsRequest
+     * @return A {@link DescribeRegionsResult} instance.
+     * @throws OSSException
+     *             If any errors are encountered in the client while making the
+     *             request or handling the response.
+     * @throws ClientException
+     *             If any errors occurred in OSS while processing the request.
+     */
+    DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest) throws OSSException, ClientException;
 }

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

@@ -1957,6 +1957,11 @@ public VoidResult closeMetaQuery(String bucketName) throws OSSException, ClientE
         return this.bucketOperation.closeMetaQuery(new GenericRequest(bucketName));
     }
 
+    @Override
+    public DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest) throws OSSException, ClientException {
+        return this.bucketOperation.describeRegions(describeRegionsRequest);
+    }
+
     @Override
     public void shutdown() {
         try {

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

@@ -2120,4 +2120,21 @@ public VoidResult closeMetaQuery(GenericRequest genericRequest) throws OSSExcept
 
         return doOperation(request, requestIdResponseParser, bucketName, null, true);
     }
+
+    public DescribeRegionsResult describeRegions(DescribeRegionsRequest describeRegionsRequest) throws OSSException, ClientException {
+        assertParameterNotNull(describeRegionsRequest, "describeRegionsRequest");
+
+        String bucketName = describeRegionsRequest.getBucketName();
+        String region = describeRegionsRequest.getRegion();
+
+        Map<String, String> params = new HashMap<String, String>();
+        params.put(REGIONS, region);
+
+
+        RequestMessage request = new OSSRequestMessageBuilder(getInnerClient()).setEndpoint(getEndpoint())
+                .setMethod(HttpMethod.GET).setBucket(bucketName).setParameters(params)
+                .setOriginalRequest(describeRegionsRequest).build();
+
+        return doOperation(request, describeRegionsResponseParser, bucketName, null, true);
+    }
 }

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

@@ -156,5 +156,5 @@ public final class RequestParameters {
     public static final String ACCESS_MONITOR = "accessmonitor";
 
     public static final String SUBRESOURCE_REGION_LIST = "regionList";
-
+    public static final String REGIONS = "regions";
 }

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

@@ -141,6 +141,7 @@ public final class ResponseParsers {
     public static final GetBucketAccessMonitorResponseParser getBucketAccessMonitorResponseParser = new GetBucketAccessMonitorResponseParser();
     public static final GetMetaQueryStatusResponseParser getMetaQueryStatusResponseParser = new GetMetaQueryStatusResponseParser();
     public static final DoMetaQueryResponseParser doMetaQueryResponseParser = new DoMetaQueryResponseParser();
+    public static final DescribeRegionsResponseParser describeRegionsResponseParser = new DescribeRegionsResponseParser();
 
     public static Long parseLongWithDefault(String defaultValue){
         if(defaultValue == null || "".equals(defaultValue)){
@@ -4178,4 +4179,47 @@ private DoMetaQueryResult parseDoMetaQueryResult(InputStream inputStream) throws
             }
         }
     }
+
+    public static final class DescribeRegionsResponseParser implements ResponseParser<DescribeRegionsResult> {
+        @Override
+        public DescribeRegionsResult parse(ResponseMessage response) throws ResponseParseException {
+            try {
+                DescribeRegionsResult result = parseDescribeRegionsResult(response.getContent());
+                setResultParameter(result, response);
+                return result;
+            } finally {
+                safeCloseResponse(response);
+            }
+        }
+
+        private DescribeRegionsResult parseDescribeRegionsResult(InputStream inputStream) throws ResponseParseException {
+            DescribeRegionsResult describeRegionsResult = new DescribeRegionsResult();
+            if (inputStream == null) {
+                return describeRegionsResult;
+            }
+
+            try {
+                Element root = getXmlRootElement(inputStream);
+                List<RegionInfo> regionInfoList = new ArrayList<RegionInfo>();
+
+                List<Element> regionListElems = root.getChildren("RegionInfo");
+                for (Element elem : regionListElems) {
+                    RegionInfo regionInfo = new RegionInfo();
+                    regionInfo.setRegion(elem.getChildText("Region"));
+                    regionInfo.setInternetEndpoint(elem.getChildText("InternetEndpoint"));
+                    regionInfo.setInternalEndpoint(elem.getChildText("InternalEndpoint"));
+                    regionInfo.setAccelerateEndpoint(elem.getChildText("AccelerateEndpoint"));
+
+                    regionInfoList.add(regionInfo);
+                }
+                describeRegionsResult.setRegionInfoList(regionInfoList);
+
+                return describeRegionsResult;
+            } catch (JDOMParseException e) {
+                throw new ResponseParseException(e.getPartialDocument() + ": " + e.getMessage(), e);
+            } catch (Exception e) {
+                throw new ResponseParseException(e.getMessage(), e);
+            }
+        }
+    }
 }

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

@@ -0,0 +1,28 @@
+package com.aliyun.oss.model;
+
+public class DescribeRegionsRequest extends GenericRequest {
+    private String region;
+
+    public DescribeRegionsRequest() {}
+    public DescribeRegionsRequest(String region) {
+        this.region = region;
+    }
+
+    public DescribeRegionsRequest(String bucketName, String region) {
+        super(bucketName);
+        this.region = region;
+    }
+
+    public String getRegion() {
+        return region;
+    }
+
+    public void setRegion(String region) {
+        this.region = region;
+    }
+
+    public DescribeRegionsRequest WithRegion(String region) {
+        setRegion(region);
+        return this;
+    }
+}

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

@@ -0,0 +1,17 @@
+package com.aliyun.oss.model;
+
+import java.util.ArrayList;
+import java.util.List;
+
+public class DescribeRegionsResult extends GenericResult {
+
+    private List<RegionInfo> regionInfoList = new ArrayList<RegionInfo>();
+
+    public List<RegionInfo> getRegionInfoList() {
+        return regionInfoList;
+    }
+
+    public void setRegionInfoList(List<RegionInfo> regionInfoList) {
+        this.regionInfoList = regionInfoList;
+    }
+}

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

@@ -0,0 +1,41 @@
+package com.aliyun.oss.model;
+
+public class RegionInfo extends GenericResult {
+
+    private String region;
+    private String internetEndpoint;
+    private String internalEndpoint;
+    private String accelerateEndpoint;
+
+    public String getRegion() {
+        return region;
+    }
+
+    public void setRegion(String region) {
+        this.region = region;
+    }
+
+    public String getInternetEndpoint() {
+        return internetEndpoint;
+    }
+
+    public void setInternetEndpoint(String internetEndpoint) {
+        this.internetEndpoint = internetEndpoint;
+    }
+
+    public String getInternalEndpoint() {
+        return internalEndpoint;
+    }
+
+    public void setInternalEndpoint(String internalEndpoint) {
+        this.internalEndpoint = internalEndpoint;
+    }
+
+    public String getAccelerateEndpoint() {
+        return accelerateEndpoint;
+    }
+
+    public void setAccelerateEndpoint(String accelerateEndpoint) {
+        this.accelerateEndpoint = accelerateEndpoint;
+    }
+}

src/samples/DescribeRegionsSample.java

@@ -0,0 +1,39 @@
+package samples;
+
+import com.aliyun.oss.model.GetDescribeRegionsRequest;
+import com.aliyun.oss.model.GetDescribeRegionsResult;
+import com.aliyun.oss.model.RegionInfo;
+
+public class DescribeRegionsSample {
+    private static String endpoint = "*** Provide OSS endpoint ***";
+    private static String accessKeyId = "*** Provide your AccessKeyId ***";
+    private static String accessKeySecret = "*** Provide your AccessKeySecret ***";
+
+    public static void main(String[] args) {
+
+        OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
+
+        try {
+            GetDescribeRegionsResult result = ossClient.getDescribeRegions(new GetDescribeRegionsRequest());
+
+            for(RegionInfo r : result.getRegionInfoList()){
+                System.out.println(r.getRegion());
+                System.out.println(r.getInternetEndpoint());
+                System.out.println(r.getInternetEndpoint());
+                System.out.println(r.getAccelerateEndpoint());
+            }
+            System.out.println("return status code: " + result.getResponse().getStatusCode());
+        } catch (OSSException oe) {
+            System.out.println("Error Message: " + oe.getErrorMessage());
+            System.out.println("Error Code:       " + oe.getErrorCode());
+            System.out.println("Request ID:      " + oe.getRequestId());
+            System.out.println("Host ID:           " + oe.getHostId());
+        } catch (ClientException ce) {
+            System.out.println("Error Message: " + ce.getMessage());
+        } finally {
+            if(ossClient != null){
+                ossClient.shutdown();
+            }
+        }
+    }
+}

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

@@ -0,0 +1,39 @@
+package com.aliyun.oss.integrationtests;
+
+import com.aliyun.oss.model.*;
+import junit.framework.Assert;
+import org.junit.Test;
+
+public class BucketDescribeRegionsTest extends TestBase {
+
+    private static final String region = "oss-cn-chengdu";
+    @Test
+    public void testBucketDescribeRegions() {
+
+        try {
+            DescribeRegionsResult regionsResult = ossClient.describeRegions(new DescribeRegionsRequest().WithRegion(region));
+
+            Assert.assertEquals(region, regionsResult.getRegionInfoList().get(0).getRegion());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getInternalEndpoint());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getInternetEndpoint());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getAccelerateEndpoint());
+        } catch (Exception e1) {
+            Assert.fail(e1.getMessage());
+        }
+    }
+
+    @Test
+    public void testBucketDescribeRegionsException() {
+
+        try {
+            DescribeRegionsResult regionsResult = ossClient.describeRegions(new DescribeRegionsRequest());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().size());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getRegion());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getInternetEndpoint());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getInternetEndpoint());
+            Assert.assertNotNull( regionsResult.getRegionInfoList().get(0).getAccelerateEndpoint());
+        } catch (Exception e1) {
+            Assert.fail(e1.getMessage());
+        }
+    }
+}