Merge branch 'master' of https://github.com/twonote/radosgw-admin4j

Author: hrchu

README.md

@@ -1,21 +1,21 @@
 [![Build Status](https://travis-ci.org/twonote/radosgw-admin4j.svg?branch=master)](https://travis-ci.org/twonote/radosgw-admin4j)  [![License](https://img.shields.io/badge/license-Apache%202-blue.svg)]()
-[![Javadocs](https://www.javadoc.io/badge/io.github.twonote/radosgw-admin4j.svg)](https://static.javadoc.io/io.github.twonote/radosgw-admin4j/1.1.0/index.html?org/twonote/rgwadmin4j/RgwAdmin.html)
+[![Javadocs](https://www.javadoc.io/badge/io.github.twonote/radosgw-admin4j.svg)](https://static.javadoc.io/io.github.twonote/radosgw-admin4j/1.3.0/index.html?org/twonote/rgwadmin4j/RgwAdmin.html)
 
 # About
-radosgw-admin4j is a Ceph object storage admin client that allows provisioning and control of a Ceph object storage deployment. This includes support for user/subuser management, quota management, usage report, bucket/object management, etc.
+radosgw-admin4j is a Ceph object storage admin client that allows provisioning and control of a Ceph object storage deployment. Features include user/sub user management, quota management, usage report, bucket/object management, etc.
 
 # Highlight
-* **Fully support all [operations](http://docs.ceph.com/docs/master/radosgw/adminops/)** includes **subuser**, **quota** and more in the least Ceph version.
+* **Fully support all [operations](http://docs.ceph.com/docs/master/radosgw/adminops/)** includes **sub user**, **quota** and more in the least Ceph version.
 * An easier way to manage radosgw. Avoid troubles when working with radosgw admin APIs, especially that docs are a bit confusing and inconsistent with the code base.
-* Quality and compatibility - [Continuous Integration](https://travis-ci.org/twonote/radosgw-admin4j) and tests against the least stable Ceph version (**Luminous**/**Mimic** currently. Krakan and previous should also works.)
+* Quality and compatibility - [Continuous Integration](https://travis-ci.org/twonote/radosgw-admin4j) and tests against the least stable Ceph version (**Luminous**/**Mimic** currently. Kraken and previous should also work.)
 * Contributor friendly - typical contribution process, no wired policies, all contributions are welcome!
 
 # Start using 
 
 ## Add dependency
 
 You can obtain radosgw-admim4j from Maven Central using the following identifier:
-* [io.github.twonote.radosgw-admin4j:1.1.0](https://search.maven.org/#artifactdetails%7Cio.github.twonote%7Cradosgw-admin4j%7C1.1.0%7Cjar)
+* [io.github.twonote.radosgw-admin4j:1.3.0](https://search.maven.org/#artifactdetails%7Cio.github.twonote%7Cradosgw-admin4j%7C1.3.0%7Cjar)
 
 ## Configuration
 
@@ -30,7 +30,7 @@ RgwAdmin RGW_ADMIN =
 
 ## Usage example
 
-We support all types of operation includes **User**, **Subuser**, **Key**, **Bucket**, **Capability**, **Quota** and **Usage**. Please check all available operations in [![Javadocs](https://www.javadoc.io/badge/io.github.twonote/radosgw-admin4j.svg)](https://static.javadoc.io/io.github.twonote/radosgw-admin4j/1.0.2/index.html?org/twonote/rgwadmin4j/RgwAdmin.html)
+We support all types of operation includes **User**, **Subuser**, **Key**, **Bucket**, **Capability**, **Quota** and **Usage**. Please check all available operations in [![Javadocs](https://www.javadoc.io/badge/io.github.twonote/radosgw-admin4j.svg)](https://static.javadoc.io/io.github.twonote/radosgw-admin4j/1.3.0/index.html?org/twonote/rgwadmin4j/RgwAdmin.html)
 
 
 ### User management
@@ -62,7 +62,7 @@ RGW_ADMIN.removeUser(userId);
 // Allow the user owns more buckets
 RGW_ADMIN.modifyUser(userId, ImmutableMap.of("max-buckets", String.valueOf(Integer.MAX_VALUE)));
 
-// Set the quota that causes the user can have at most one thousand objects and the maximal usage is 1 GiB
+// Set the quota that causes the user can have at most one thousand objects, and the maximal usage is 1 GiB
 RGW_ADMIN.setUserQuota(userId, 1000, 1048576);
 ```
 
@@ -85,7 +85,7 @@ UsageInfo userUsage = RGW_ADMIN.getUserUsage(userId).get();
 userUsage.getSummary().stream().peek(System.out::println);
 ```
 
-## Radosgw setup
+## One more thing: Radosgw setup
 To kick off, you need one ready to use radosgw instance and one radosgw account with proper admin capabilities. Follow the guide below to have a radowgw setup then you can fire the example code.
 
 ### “I do not have a radosgw setup currently”
@@ -94,7 +94,7 @@ You could refer the [Ceph official manual](http://docs.ceph.com/docs/master/star
 $ sudo docker rm -f rgwl; rm -rf /etc/cephl; sudo docker run -d -p 80:80 -v /etc/cephl/:/etc/ceph/ -e CEPH_DEMO_UID=qqq -e CEPH_DEMO_ACCESS_KEY=qqq -e CEPH_DEMO_SECRET_KEY=qqq -e RGW_CIVETWEB_PORT=80 -e NETWORK_AUTO_DETECT=4 --name rgwl ceph/daemon@sha256:4d84442c3ac5746bbfc72349a3472fb9e99120c0cb2a95fc4a17320070ca9422 demo; sleep 10
 ```
 
-Note that the port 80 should be available.
+Note that port 80 should be available.
 
 Check the setup succeeded by the following command:
 ```

changelog.txt

@@ -1,3 +1,8 @@
+1.3.0 (2019-05-23)
+- Set quota for specific bucket
+- List all buckets 
+- Bugfix: setSubUserPermission() cannot set the READ_WRITE permission.
+
 1.1.0 (2018-03-29)
 - Get/set bucket quota 
 

pom.xml

@@ -5,7 +5,7 @@
 
     <groupId>io.github.twonote</groupId>
     <artifactId>radosgw-admin4j</artifactId>
-    <version>1.1.0</version>
+    <version>1.3.1-SNAPSHOT</version>
     <packaging>jar</packaging>
 
     <name>radosgw-admin4j</name>

src/main/java/org/twonote/rgwadmin4j/RgwAdmin.java

@@ -244,7 +244,7 @@ List<SubUser> setSubUserPermission(
    * Remove an existing S3 credential from the specified user.
    *
    * @param userId The specified user.
-   * @param accessKey The access key belonging to the credential to remove.
+   * @param accessKey The access key which is belonging to the credential to remove.
    */
   void removeS3Credential(String userId, String accessKey);
 
@@ -280,7 +280,7 @@ List<S3Credential> createS3CredentialForSubUser(
    * @param userId the specified user.
    * @param subUserId the specified sub user. Should not contain user id, i.e., bar instead of
    *     foo:bar.
-   * @param accessKey The access key belonging to the credential to remove.
+   * @param accessKey The access key which is belonging to the credential to remove.
    */
   void removeS3CredentialFromSubUser(String userId, String subUserId, String accessKey);