org.twonote.rgwadmin4j.impl

Class RgwAdminImpl

java.lang.Object

org.twonote.rgwadmin4j.impl.RgwAdminImpl

All Implemented Interfaces:

RgwAdmin

public class RgwAdminImpl
extends java.lang.Object
implements RgwAdmin

Radosgw administrator implementation

Created by petertc on 2/16/17.

Constructor Summary

Constructors

Constructor and Description
RgwAdminImpl(java.lang.String accessKey, java.lang.String secretKey, java.lang.String endpoint) Create a Radosgw administrator implementation

Method Summary

Modifier and Type	Method and Description
java.util.List<Cap>	addUserCapability(java.lang.String userId, java.util.List<Cap> userCaps) Add an administrative capability to a specified user.
java.util.Optional<java.lang.String>	checkBucketIndex(java.lang.String bucketName, boolean isCheckObjects, boolean isFix) Check the index of an existing bucket.
java.util.List<S3Credential>	createS3Credential(java.lang.String userId) Create a new S3 credential pair for the specified user.
java.util.List<S3Credential>	createS3Credential(java.lang.String userId, java.lang.String accessKey, java.lang.String secretKey) Create a new S3 credential for the specified user.
java.util.List<S3Credential>	createS3CredentialForSubUser(java.lang.String userId, java.lang.String subUserId) Create a new S3 credential for the specified sub user.
java.util.List<S3Credential>	createS3CredentialForSubUser(java.lang.String userId, java.lang.String subUserId, java.lang.String accessKey, java.lang.String secretKey) Create a new S3 credential for the specified subuser.
java.util.List<SubUser>	createSubUser(java.lang.String userId, java.lang.String subUserId, java.util.Map<java.lang.String,java.lang.String> parameters) Create a new subuser
SubUser	createSubUser(java.lang.String userId, java.lang.String subUserId, SubUser.Permission permission, CredentialType credentialType) Create a new sub-user
SwiftCredential	createSwiftCredentialForSubUser(java.lang.String userId, java.lang.String subUserId) Create a new swift credential for the specified sub user.
SwiftCredential	createSwiftCredentialForSubUser(java.lang.String userId, java.lang.String subUserId, java.lang.String password) Create a new swift credential for the specified sub user.
User	createUser(java.lang.String userId) Create a new user.
User	createUser(java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> options) Create a new user.
java.util.Optional<BucketInfo>	getBucketInfo(java.lang.String bucketName) Get information about a bucket.
java.util.Optional<java.lang.String>	getBucketPolicy(java.lang.String bucketName) Read the policy of a bucket.
java.util.Optional<Quota>	getBucketQuota(java.lang.String userId) Get bucket quota.
java.util.Optional<java.lang.String>	getObjectPolicy(java.lang.String bucketName, java.lang.String objectKey) Read the policy of an object.
java.util.Optional<Quota>	getQuota(java.lang.String userId, java.lang.String quotaType)
java.util.Optional<SubUser>	getSubUserInfo(java.lang.String userId, java.lang.String subUserId) Get sub-user information.
java.util.Optional<UsageInfo>	getUsage() Request bandwidth usage information.
java.util.Optional<UsageInfo>	getUsage(java.util.Map<java.lang.String,java.lang.String> parameters) Request bandwidth usage information.
java.util.Optional<User>	getUserInfo(java.lang.String userId) Get user information.
java.util.Optional<Quota>	getUserQuota(java.lang.String userId) Get user quota.
java.util.Optional<UsageInfo>	getUserUsage(java.lang.String userId) Request bandwidth usage information for specified user.
java.util.Optional<UsageInfo>	getUserUsage(java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> parameters) Request bandwidth usage information for specified user.
void	linkBucket(java.lang.String bucketName, java.lang.String bucketId, java.lang.String userId) Link a bucket to a specified user, unlinking the bucket from any previous user.
java.util.List<java.lang.String>	listBucket() List all buckets.
java.util.List<java.lang.String>	listBucket(java.lang.String userId) List buckets belong to a user.
java.util.List<BucketInfo>	listBucketInfo() Get information about buckets.
java.util.List<BucketInfo>	listBucketInfo(java.lang.String userId) Get information about buckets under a given user.
java.util.List<java.lang.String>	listSubUser(java.lang.String userId) Get the subuser list under a user
java.util.List<SubUser>	listSubUserInfo(java.lang.String userId) Retrieve the sub-user information under a user
java.util.List<java.lang.String>	listUser() Get the user list
java.util.List<User>	listUserInfo() Get information about users exist in the system
java.util.List<SubUser>	modifySubUser(java.lang.String userId, java.lang.String subUserId, java.util.Map<java.lang.String,java.lang.String> parameters)
User	modifyUser(java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> parameters) Modify a user.
void	removeBucket(java.lang.String bucketName) Delete an existing bucket.
void	removeObject(java.lang.String bucketName, java.lang.String objectKey) Remove an existing object.
void	removeS3Credential(java.lang.String userId, java.lang.String accessKey) Remove an existing S3 credential from the specified user.
void	removeS3CredentialFromSubUser(java.lang.String userId, java.lang.String subUserId, java.lang.String accessKey) Remove an existing S3 credential from the specified sub user.
void	removeSubUser(java.lang.String userId, java.lang.String subUserId) Remove an existing subuser.
void	removeSwiftCredentialFromSubUser(java.lang.String userId, java.lang.String subUserId) Remove the credential from the specified sub user.
void	removeUser(java.lang.String userId) Remove an existing user.
java.util.List<Cap>	removeUserCapability(java.lang.String userId, java.util.List<Cap> userCaps) Remove an administrative capability from a specified user.
void	setBucketQuota(java.lang.String userId, long maxObjects, long maxSizeKB) Set or modify quotas on all buckets owned by a user.
void	setIndividualBucketQuota(java.lang.String userId, java.lang.String bucket, long maxObjects, long maxSizeKB) Set or modify a quota on a given bucket.
java.util.List<SubUser>	setSubUserPermission(java.lang.String userId, java.lang.String subUserId, SubUser.Permission permission) Modify an existing subuser permission.
void	setUserQuota(java.lang.String userId, long maxObjects, long maxSizeKB) Set or modify a quota on a user.
void	setUserQuota(java.lang.String userId, java.lang.String quotaType, long maxObjects, long maxSizeKB)
void	suspendUser(java.lang.String userId, boolean suspend) Suspend or resume a user
void	trimUsage(java.util.Map<java.lang.String,java.lang.String> parameters) Remove usage information.
void	trimUserUsage(java.lang.String userId, java.util.Map<java.lang.String,java.lang.String> parameters) Remove usage information for specified user.
void	unlinkBucket(java.lang.String bucketName, java.lang.String userId) Unlink a bucket from a specified user.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RgwAdminImpl

public RgwAdminImpl(java.lang.String accessKey,
                    java.lang.String secretKey,
                    java.lang.String endpoint)

Create a Radosgw administrator implementation

Parameters:

accessKey - Access key of the admin who have proper administrative capabilities.

secretKey - Secret key of the admin who have proper administrative capabilities.

endpoint - Radosgw admin API endpoint, e.g., http://127.0.0.1:80/admin

Method Detail

trimUserUsage

public void trimUserUsage(java.lang.String userId,
                          java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Remove usage information for specified user. With no dates specified, removes all usage information.

There are few parameters available to filter the query result as you wish, includes:

• start: Date and (optional) time that specifies the start time of the requested data. Example: 2012-09-25 16:00:00
• end: Date and (optional) time that specifies the end time of the requested data (non-inclusive). Example: 2012-09-25 16:00:00

Specified by:

trimUserUsage in interface RgwAdmin

Parameters:

userId - The user for which the information is requested.

parameters - optional parameters to filter the usage to delete.

trimUsage

public void trimUsage(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Remove usage information. With no dates specified, removes all usage information.

There are few parameters available to filter the query result as you wish, includes:

• start: Date and (optional) time that specifies the start time of the requested data. Example: 2012-09-25 16:00:00
• end: Date and (optional) time that specifies the end time of the requested data (non-inclusive). Example: 2012-09-25 16:00:00

Specified by:

trimUsage in interface RgwAdmin

Parameters:

parameters - optional parameters to filter the usage to delete.

getUserUsage

public java.util.Optional<UsageInfo> getUserUsage(java.lang.String userId)

Description copied from interface: RgwAdmin

Request bandwidth usage information for specified user.

See RgwAdmin.getUsage(Map)

Specified by:

getUserUsage in interface RgwAdmin

getUserUsage

public java.util.Optional<UsageInfo> getUserUsage(java.lang.String userId,
                                                  java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Request bandwidth usage information for specified user.

See RgwAdmin.getUsage(Map)

Specified by:

getUserUsage in interface RgwAdmin

getUsage

public java.util.Optional<UsageInfo> getUsage()

Description copied from interface: RgwAdmin

Request bandwidth usage information.

See RgwAdmin.getUsage(Map)

Specified by:

getUsage in interface RgwAdmin

getUsage

public java.util.Optional<UsageInfo> getUsage(java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Request bandwidth usage information.

Note that radosgw does not enable usage collection in default. To get usage, you need the following option:

   rgw enable usage log = true
 

There are few parameters available to filter the query result as you wish, includes:

• start: Date and (optional) time that specifies the start time of the requested data. Example: 2012-09-25 16:00:00
• end: Date and (optional) time that specifies the end time of the requested data (non-inclusive). Example: 2012-09-25 16:00:00
• show-entries: Specifies whether data entries should be returned. Example: False [True]
• show-summary: Specifies whether data summary should be returned. Example: False [True]

Specified by:

getUsage in interface RgwAdmin

Parameters:

parameters - optional parameters to filter the query result.

Returns:

Request bandwidth usage information.

addUserCapability

public java.util.List<Cap> addUserCapability(java.lang.String userId,
                                             java.util.List<Cap> userCaps)

Description copied from interface: RgwAdmin

Add an administrative capability to a specified user.

Note that you can get the capability by RgwAdmin.getUserInfo(String)

Specified by:

addUserCapability in interface RgwAdmin

Parameters:

userId - The user ID to add an administrative capability to.

userCaps - The administrative capability to add to the user.

Returns:

The user's capabilities after the operation.

removeUserCapability

public java.util.List<Cap> removeUserCapability(java.lang.String userId,
                                                java.util.List<Cap> userCaps)

Description copied from interface: RgwAdmin

Remove an administrative capability from a specified user.

Note that you can get the capability by RgwAdmin.getUserInfo(String)

Specified by:

removeUserCapability in interface RgwAdmin

Parameters:

userId - The user ID to remove an administrative capability from.

userCaps - The administrative capabilities to remove from the user.

Returns:

The user's capabilities after the operation.

createSubUser

public java.util.List<SubUser> createSubUser(java.lang.String userId,
                                             java.lang.String subUserId,
                                             java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Create a new subuser

Available parameters include:

• access-key: Specify access key.
• secret-key: Specify secret key.
• key-type: Key type to be generated, options are: swift (default), s3.
• access: Set access permissions for sub-user, should be one of read, write, readwrite, full, "".
• generate-secret: Generate the secret key. Default: False

Tips:

1. In general for a subuser to be useful, it must be granted permissions by specifying access.
2. You can get subuser credentials by RgwAdmin.getUserInfo(String) after creation.
3. To create subuser for S3, you need Ceph v11.2.0-kraken or above.

Specified by:

createSubUser in interface RgwAdmin

Parameters:

userId - The user ID under which a subuser is to be created.

subUserId - Specify the subuser ID to be created.

parameters - The subuser parameters.

Returns:

Subusers associated with the user account.

createSubUser

public SubUser createSubUser(java.lang.String userId,
                             java.lang.String subUserId,
                             SubUser.Permission permission,
                             CredentialType credentialType)

Description copied from interface: RgwAdmin

Create a new sub-user

This method will create the sub-user with the automatically generated credential.

Tips:

1. In general for a subuser to be useful, it must be granted permissions by specifying access.
2. You can get subuser credentials by RgwAdmin.getUserInfo(String) after creation.
3. To create subuser for S3, you need Ceph v11.2.0-kraken or above.

Specified by:

createSubUser in interface RgwAdmin

Parameters:

userId - The user ID under which a subuser is to be created.

subUserId - Specify the subuser ID to be created. Should be in the relative form, i.e., does not contain the user id.

permission - The subuser permission.

credentialType - Specify credential type to be generated.

Returns:

The created subuser information.

modifySubUser

public java.util.List<SubUser> modifySubUser(java.lang.String userId,
                                             java.lang.String subUserId,
                                             java.util.Map<java.lang.String,java.lang.String> parameters)

setSubUserPermission

public java.util.List<SubUser> setSubUserPermission(java.lang.String userId,
                                                    java.lang.String subUserId,
                                                    SubUser.Permission permission)

Description copied from interface: RgwAdmin

Modify an existing subuser permission.

Note that you can get the permission by RgwAdmin.getSubUserInfo(String, String)

Specified by:

setSubUserPermission in interface RgwAdmin

Parameters:

userId - The user ID under which a subuser is to be created.

subUserId - Specify the subuser ID to be created.

permission - Specify the subuser permission.

Returns:

Subusers associated with the user account.

listSubUserInfo

public java.util.List<SubUser> listSubUserInfo(java.lang.String userId)

Description copied from interface: RgwAdmin

Retrieve the sub-user information under a user

Specified by:

listSubUserInfo in interface RgwAdmin

Parameters:

userId - The user ID under which subusers we interested to

Returns:

subusers

getSubUserInfo

public java.util.Optional<SubUser> getSubUserInfo(java.lang.String userId,
                                                  java.lang.String subUserId)

Description copied from interface: RgwAdmin

Get sub-user information.

Specified by:

getSubUserInfo in interface RgwAdmin

Parameters:

userId - The user ID.

subUserId - The subuser ID

Returns:

The subuser information.

removeSubUser

public void removeSubUser(java.lang.String userId,
                          java.lang.String subUserId)

Description copied from interface: RgwAdmin

Remove an existing subuser.

Note that the operation also removes credentials belonging to the subuser.

Specified by:

removeSubUser in interface RgwAdmin

Parameters:

userId - The user ID under which the subuser is to be removed.

subUserId - The subuser ID to be removed.

createS3Credential

public java.util.List<S3Credential> createS3Credential(java.lang.String userId,
                                                       java.lang.String accessKey,
                                                       java.lang.String secretKey)

Description copied from interface: RgwAdmin

Create a new S3 credential for the specified user.

Specified by:

createS3Credential in interface RgwAdmin

Parameters:

userId - the specified user.

accessKey - S3 access key

secretKey - S3 secret key

Returns:

S3 credentials associated with this user account.

createS3Credential

public java.util.List<S3Credential> createS3Credential(java.lang.String userId)

Description copied from interface: RgwAdmin

Create a new S3 credential pair for the specified user.

The credential will be automatically generated for the user. If you want to specify the credential, please use RgwAdmin.createS3Credential(String, String, String)

Specified by:

createS3Credential in interface RgwAdmin

Parameters:

userId - the specified user.

Returns:

S3 credentials associated with this user account.

removeS3Credential

public void removeS3Credential(java.lang.String userId,
                               java.lang.String accessKey)

Description copied from interface: RgwAdmin

Remove an existing S3 credential from the specified user.

Specified by:

removeS3Credential in interface RgwAdmin

Parameters:

userId - The specified user.

accessKey - The access key which is belonging to the credential to remove.

createS3CredentialForSubUser

public java.util.List<S3Credential> createS3CredentialForSubUser(java.lang.String userId,
                                                                 java.lang.String subUserId,
                                                                 java.lang.String accessKey,
                                                                 java.lang.String secretKey)

Description copied from interface: RgwAdmin

Create a new S3 credential for the specified subuser.

Specified by:

createS3CredentialForSubUser in interface RgwAdmin

Parameters:

userId - The specified user.

subUserId - the specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

accessKey - S3 access key.

secretKey - S3 secret key.

Returns:

S3 credentials associated with this subuser account.

createS3CredentialForSubUser

public java.util.List<S3Credential> createS3CredentialForSubUser(java.lang.String userId,
                                                                 java.lang.String subUserId)

Description copied from interface: RgwAdmin

Create a new S3 credential for the specified sub user.

The credential will be automatically generated for the user. If you want to specify the credential, please use RgwAdmin.createS3CredentialForSubUser(String, String, String, String)

Specified by:

createS3CredentialForSubUser in interface RgwAdmin

Parameters:

userId - the specified user.

subUserId - the specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

Returns:

S3 credentials created associated with this subuser account.

removeS3CredentialFromSubUser

public void removeS3CredentialFromSubUser(java.lang.String userId,
                                          java.lang.String subUserId,
                                          java.lang.String accessKey)

Description copied from interface: RgwAdmin

Remove an existing S3 credential from the specified sub user.

Specified by:

removeS3CredentialFromSubUser in interface RgwAdmin

Parameters:

userId - the specified user.

subUserId - the specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

accessKey - The access key which is belonging to the credential to remove.

createSwiftCredentialForSubUser

public SwiftCredential createSwiftCredentialForSubUser(java.lang.String userId,
                                                       java.lang.String subUserId,
                                                       java.lang.String password)

Description copied from interface: RgwAdmin

Create a new swift credential for the specified sub user.

Tip: a subuser can have only one swift credential.

Specified by:

createSwiftCredentialForSubUser in interface RgwAdmin

Parameters:

userId - The specified user.

subUserId - the specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

password - The specified swift password.

Returns:

The Swift credentials associated with this subuser account.

createSwiftCredentialForSubUser

public SwiftCredential createSwiftCredentialForSubUser(java.lang.String userId,
                                                       java.lang.String subUserId)

Description copied from interface: RgwAdmin

Create a new swift credential for the specified sub user.

The credential will be automatically generated for the user. If you want to specify it, please use RgwAdmin.createSwiftCredentialForSubUser(String, String, String)

Tip: a subuser can have only one swift credential.

Specified by:

createSwiftCredentialForSubUser in interface RgwAdmin

Parameters:

userId - The specified user.

subUserId - The specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

Returns:

The Swift credential associated with this subuser account.

removeSwiftCredentialFromSubUser

public void removeSwiftCredentialFromSubUser(java.lang.String userId,
                                             java.lang.String subUserId)

Description copied from interface: RgwAdmin

Remove the credential from the specified sub user.

Specified by:

removeSwiftCredentialFromSubUser in interface RgwAdmin

Parameters:

userId - the specified user.

subUserId - the specified sub user. Should not contain user id, i.e., bar instead of foo:bar.

removeBucket

public void removeBucket(java.lang.String bucketName)

Description copied from interface: RgwAdmin

Delete an existing bucket.

Note that the operation asks radosgw to purge objects in the bucket before deletion.

Specified by:

removeBucket in interface RgwAdmin

Parameters:

bucketName - The bucket to remove.

linkBucket

public void linkBucket(java.lang.String bucketName,
                       java.lang.String bucketId,
                       java.lang.String userId)

Description copied from interface: RgwAdmin

Link a bucket to a specified user, unlinking the bucket from any previous user.

Specified by:

linkBucket in interface RgwAdmin

Parameters:

bucketName - The bucket name to unlink.

bucketId - The bucket id to unlink. Example: dev.6607669.420. (You can get this by RgwAdmin.getBucketInfo(String))

userId - The user ID to link the bucket to.

unlinkBucket

public void unlinkBucket(java.lang.String bucketName,
                         java.lang.String userId)

Description copied from interface: RgwAdmin

Unlink a bucket from a specified user. Primarily useful for changing bucket ownership.

Specified by:

unlinkBucket in interface RgwAdmin

Parameters:

bucketName - The bucket to unlink.

userId - The user ID to unlink the bucket from.

checkBucketIndex

public java.util.Optional<java.lang.String> checkBucketIndex(java.lang.String bucketName,
                                                             boolean isCheckObjects,
                                                             boolean isFix)

Description copied from interface: RgwAdmin

Check the index of an existing bucket.

NOTE: to check multipart object accounting with check-objects, fix must be set to True.

Example response:

 [
 ]{
 }{
    "existing_header":{
       "usage":{
       }
    },
    "calculated_header":{
       "usage":{
       }
    }
 }
 

Specified by:

checkBucketIndex in interface RgwAdmin

Parameters:

bucketName - The bucket to return info on.

isCheckObjects - Check multipart object accounting. Example: True [False]

isFix - Also fix the bucket index when checking. Example: False [False]

Returns:

Status of bucket index.

listBucket

public java.util.List<java.lang.String> listBucket()

Description copied from interface: RgwAdmin

List all buckets.

Specified by:

listBucket in interface RgwAdmin

Returns:

Bucket list.

listBucket

public java.util.List<java.lang.String> listBucket(java.lang.String userId)

Description copied from interface: RgwAdmin

List buckets belong to a user.

Specified by:

listBucket in interface RgwAdmin

Parameters:

userId - The bucket owner we interested.

Returns:

Bucket list.

listBucketInfo

public java.util.List<BucketInfo> listBucketInfo()

Description copied from interface: RgwAdmin

Get information about buckets.

Specified by:

listBucketInfo in interface RgwAdmin

Returns:

The desired bucket information.

listBucketInfo

public java.util.List<BucketInfo> listBucketInfo(java.lang.String userId)

Description copied from interface: RgwAdmin

Get information about buckets under a given user.

Specified by:

listBucketInfo in interface RgwAdmin

Parameters:

userId - The user to retrieve bucket information for.

Returns:

The desired bucket information.

getBucketInfo

public java.util.Optional<BucketInfo> getBucketInfo(java.lang.String bucketName)

Description copied from interface: RgwAdmin

Get information about a bucket.

Specified by:

getBucketInfo in interface RgwAdmin

Parameters:

bucketName - The bucket to return info on.

Returns:

The desired bucket information.

createUser

public User createUser(java.lang.String userId)

Description copied from interface: RgwAdmin

Create a new user.

An S3 key pair will be created automatically and returned in the response. If you want to customize user properties or create a Swift user, use RgwAdmin.createUser(String, Map) instead.

Specified by:

createUser in interface RgwAdmin

Parameters:

userId - The user ID to be created.

Returns:

The user information.

createUser

public User createUser(java.lang.String userId,
                       java.util.Map<java.lang.String,java.lang.String> options)

Description copied from interface: RgwAdmin

Create a new user.

You can customize user properties or create a Swift user by set the parameters. Available parameters includes:

• display-name: The display name of the user to be created.
• email: The email address associated with the user.
• key-type: Key type to be generated, options are: swift, s3
• access-key: Specify access key.
• secret-key: Specify secret key.
• user-caps: User capabilities. Example: usage=read, write; users=read
• generate-key: Generate a new key pair and add to the existing keyring. Example: True [True]
• max-buckets: Specify the maximum number of buckets the user can own. Example: 500 [1000]
• suspended: Specify whether the user should be suspended. Example: False [False]

If only one of access-key or secret-key is provided, the omitted key will be automatically generated. By default, a generated key is added to the keyring without replacing an existing key pair. If access-key is specified and refers to an existing key owned by the user then it will be modified.

Specified by:

createUser in interface RgwAdmin

Parameters:

userId - The user ID to be created.

options - The user properties.

Returns:

The user information.

getUserInfo

public java.util.Optional<User> getUserInfo(java.lang.String userId)

Description copied from interface: RgwAdmin

Get user information.

Specified by:

getUserInfo in interface RgwAdmin

Parameters:

userId - The user for which the information is requested.

Returns:

The user information.

listUser

public java.util.List<java.lang.String> listUser()

Description copied from interface: RgwAdmin

Get the user list

Specified by:

listUser in interface RgwAdmin

Returns:

Id of users in the system.

listSubUser

public java.util.List<java.lang.String> listSubUser(java.lang.String userId)

Description copied from interface: RgwAdmin

Get the subuser list under a user

Specified by:

listSubUser in interface RgwAdmin

Parameters:

userId - The user ID under which subusers we interested to.

Returns:

The Id of subusers under the given user.

listUserInfo

public java.util.List<User> listUserInfo()

Description copied from interface: RgwAdmin

Get information about users exist in the system

Specified by:

listUserInfo in interface RgwAdmin

Returns:

Information of users in the system.

modifyUser

public User modifyUser(java.lang.String userId,
                       java.util.Map<java.lang.String,java.lang.String> parameters)

Description copied from interface: RgwAdmin

Modify a user.

Available parameters include:

• display-name: The display name of the user to be created.
• email: The email address associated with the user.
• key-type: Key type to be generated, options are: swift, s3
• access-key: Specify access key.
• secret-key: Specify secret key.
• user-caps: User capabilities. Example: usage=read, write; users=read
• generate-key: Generate a new key pair and add to the existing keyring. Example: True [True]
• max-buckets: Specify the maximum number of buckets the user can own. Example: 500 [1000]
• suspended: Specify whether the user should be suspended. Example: False [False]

Specified by:

modifyUser in interface RgwAdmin

Parameters:

userId - The user ID to be modified.

parameters - Optional parameters.

Returns:

The user information.

suspendUser

public void suspendUser(java.lang.String userId,
                        boolean suspend)

Description copied from interface: RgwAdmin

Suspend or resume a user

Specified by:

suspendUser in interface RgwAdmin

Parameters:

userId - The user ID to be suspended or resumed.

suspend - Set true to suspend the user and vice versa.

removeUser

public void removeUser(java.lang.String userId)

Description copied from interface: RgwAdmin

Remove an existing user.

Note that the buckets and objects belonging to the user will also be removed.

Specified by:

removeUser in interface RgwAdmin

Parameters:

userId - The user ID to be removed.

getUserQuota

public java.util.Optional<Quota> getUserQuota(java.lang.String userId)

Description copied from interface: RgwAdmin

Get user quota.

Specified by:

getUserQuota in interface RgwAdmin

Parameters:

userId - The user ID to get quota.

Returns:

user quota.

getBucketQuota

public java.util.Optional<Quota> getBucketQuota(java.lang.String userId)

Description copied from interface: RgwAdmin

Get bucket quota.

Specified by:

getBucketQuota in interface RgwAdmin

Parameters:

userId - The bucket owner ID to get quota.

Returns:

bucket quota.

getQuota

public java.util.Optional<Quota> getQuota(java.lang.String userId,
                                          java.lang.String quotaType)

setIndividualBucketQuota

public void setIndividualBucketQuota(java.lang.String userId,
                                     java.lang.String bucket,
                                     long maxObjects,
                                     long maxSizeKB)

Description copied from interface: RgwAdmin

Set or modify a quota on a given bucket. Note that you can get this quota via RgwAdmin.getBucketInfo(String)

Tips: To use this feature, you need Ceph v13.0.2 (mimic) or above.

Specified by:

setIndividualBucketQuota in interface RgwAdmin

Parameters:

userId - The bucket owner to set quota.

bucket - The bucket to set quota.

maxObjects - The max-objects setting allows you to specify the maximum number of objects. A negative value disables this setting.

maxSizeKB - The max-size option allows you to specify a quota for the maximum number of bytes. A negative value disables this setting.

setBucketQuota

public void setBucketQuota(java.lang.String userId,
                           long maxObjects,
                           long maxSizeKB)

Description copied from interface: RgwAdmin

Set or modify quotas on all buckets owned by a user.

Specified by:

setBucketQuota in interface RgwAdmin

Parameters:

userId - The bucket owner to set quota.

maxObjects - The max-objects setting allows you to specify the maximum number of objects. A negative value disables this setting.

maxSizeKB - The max-size option allows you to specify a quota for the maximum number of bytes. A negative value disables this setting.

setUserQuota

public void setUserQuota(java.lang.String userId,
                         long maxObjects,
                         long maxSizeKB)

Description copied from interface: RgwAdmin

Set or modify a quota on a user.

Specified by:

setUserQuota in interface RgwAdmin

Parameters:

userId - The user to set quota.

maxObjects - The max-objects setting allows you to specify the maximum number of objects. A negative value disables this setting.

maxSizeKB - The max-size option allows you to specify a quota for the maximum number of bytes. A negative value disables this setting.

setUserQuota

public void setUserQuota(java.lang.String userId,
                         java.lang.String quotaType,
                         long maxObjects,
                         long maxSizeKB)

removeObject

public void removeObject(java.lang.String bucketName,
                         java.lang.String objectKey)

Description copied from interface: RgwAdmin

Remove an existing object.

NOTE: Does not require the owner to be non-suspended.

Specified by:

removeObject in interface RgwAdmin

Parameters:

bucketName - The bucket containing the object to be removed.

objectKey - The object to remove.

getObjectPolicy

public java.util.Optional<java.lang.String> getObjectPolicy(java.lang.String bucketName,
                                                            java.lang.String objectKey)

Description copied from interface: RgwAdmin

Read the policy of an object.

Note that the term "policy" here does not stand for "S3 bucket policy". Instead, it represents S3 Access Control Policy (ACP).

We return JSON string instead of the concrete model here due to the server returns the internal data structure which is not well defined. For example:

 {
    "acl":{
       "acl_user_map":[
          {
             "user":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
             "acl":15
          }
       ],
       "acl_group_map":[
       ],
       "grant_map":[
          {
             "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
             "grant":{
                "type":{
                   "type":0
                },
                "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
                "email":"",
                "permission":{
                   "flags":15
                },
                "name":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
                "group":0,
                "url_spec":""
             }
          }
       ]
    },
    "owner":{
       "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
       "display_name":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19"
    }
 }
 

Specified by:

getObjectPolicy in interface RgwAdmin

Parameters:

bucketName - The bucket to which the object belong to.

objectKey - The object to read the policy from.

Returns:

If successful returns the policy.

getBucketPolicy

public java.util.Optional<java.lang.String> getBucketPolicy(java.lang.String bucketName)

Description copied from interface: RgwAdmin

Read the policy of a bucket.

Note that the term "policy" here does not stand for "S3 bucket policy". Instead, it represents S3 Access Control Policy (ACP).

We return JSON string instead of the concrete model here due to the server returns the internal data structure which is not well defined. For example:

 {
    "acl":{
       "acl_user_map":[
          {
             "user":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
             "acl":15
          }
       ],
       "acl_group_map":[
       ],
       "grant_map":[
          {
             "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
             "grant":{
                "type":{
                   "type":0
                },
                "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
                "email":"",
                "permission":{
                   "flags":15
                },
                "name":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
                "group":0,
                "url_spec":""
             }
          }
       ]
    },
    "owner":{
       "id":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19",
       "display_name":"rgwAdmin4jTest-6d6a2645-0219-4e49-8493-0bdc8cb00e19"
    }
 }
 

Specified by:

getBucketPolicy in interface RgwAdmin

Parameters:

bucketName - The bucket to read the policy from.

Returns:

If successful returns the policy.