io.minio.admin

Class MinioAdminClient

java.lang.Object

io.minio.admin.MinioAdminClient

public class MinioAdminClient
extends Object

Client to perform MinIO administration operations.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MinioAdminClient.Builder Argument builder of MinioAdminClient.

Method Summary

Modifier and Type	Method and Description
void	addCannedPolicy(String name, String policy) Creates a policy.
void	addUpdateGroup(String group, Status groupStatus, List<String> members) Adds or updates a group.
void	addUser(String accessKey, UserInfo.Status status, String secretKey, String policyName, List<String> memberOf) Adds a user with the specified access and secret key.
static MinioAdminClient.Builder	builder()
void	clearBucketQuota(String bucketName) Reset bucket quota
void	deleteUser(String accessKey) Deletes a user by it's access key
long	getBucketQuota(String bucketName) get bucket quota size
DataUsageInfo	getDataUsageInfo() Get server/cluster data usage info
GroupInfo	getGroupInfo(String group) Obtains group info for a specified MinIO group.
UserInfo	getUserInfo(String accessKey) Obtains user info for a specified MinIO user.
void	ignoreCertCheck() Ignores check on server certificate for HTTPS connection.
Map<String,String>	listCannedPolicies() Lists all configured canned policies.
List<String>	listGroups() Obtains a list of all MinIO groups.
Map<String,UserInfo>	listUsers() Obtains a list of all MinIO users.
void	removeCannedPolicy(String name) Removes canned policy by name.
void	removeGroup(String group) Removes a group.
void	setAppInfo(String name, String version) Sets application's name/version to user agent.
void	setBucketQuota(String bucketName, long size, QuotaUnit unit) set bucket quota size
void	setPolicy(String userOrGroupName, boolean isGroup, String policyName) Sets a policy to a given user or group.
void	setTimeout(long connectTimeout, long writeTimeout, long readTimeout) Sets HTTP connect, write and read timeouts.
void	traceOff() Disables HTTP call tracing previously enabled.
void	traceOn(OutputStream traceStream) Enables HTTP call tracing and written to traceStream.

Methods inherited from class java.lang.Object

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

Method Detail

addUser

public void addUser(@Nonnull
                    String accessKey,
                    @Nonnull
                    UserInfo.Status status,
                    @Nullable
                    String secretKey,
                    @Nullable
                    String policyName,
                    @Nullable
                    List<String> memberOf)
             throws NoSuchAlgorithmException,
                    InvalidKeyException,
                    IOException,
                    org.bouncycastle.crypto.InvalidCipherTextException

Adds a user with the specified access and secret key.

Parameters:

accessKey - Access key.

status - Status.

secretKey - Secret key.

policyName - Policy name.

memberOf - List of group.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

org.bouncycastle.crypto.InvalidCipherTextException - thrown to indicate data cannot be encrypted/decrypted.

getUserInfo

public UserInfo getUserInfo(String accessKey)
                     throws NoSuchAlgorithmException,
                            InvalidKeyException,
                            IOException

Obtains user info for a specified MinIO user.

Parameters:

accessKey - Access Key.

Returns:

user info for the specified accessKey.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

listUsers

public Map<String,UserInfo> listUsers()
                               throws NoSuchAlgorithmException,
                                      InvalidKeyException,
                                      IOException,
                                      org.bouncycastle.crypto.InvalidCipherTextException

Obtains a list of all MinIO users.

Returns:

List of all users.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

org.bouncycastle.crypto.InvalidCipherTextException - thrown to indicate data cannot be encrypted/decrypted.

deleteUser

public void deleteUser(@Nonnull
                       String accessKey)
                throws NoSuchAlgorithmException,
                       InvalidKeyException,
                       IOException

Deletes a user by it's access key

Parameters:

accessKey - Access Key.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

addUpdateGroup

public void addUpdateGroup(@Nonnull
                           String group,
                           @Nullable
                           Status groupStatus,
                           @Nullable
                           List<String> members)
                    throws NoSuchAlgorithmException,
                           InvalidKeyException,
                           IOException

Adds or updates a group.

Parameters:

group - Group name.

groupStatus - Status.

members - Members of group.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

getGroupInfo

public GroupInfo getGroupInfo(String group)
                       throws NoSuchAlgorithmException,
                              InvalidKeyException,
                              IOException

Obtains group info for a specified MinIO group.

Parameters:

group - Group name.

Returns:

group info for the specified group.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

listGroups

public List<String> listGroups()
                        throws NoSuchAlgorithmException,
                               InvalidKeyException,
                               IOException

Obtains a list of all MinIO groups.

Returns:

List of all groups.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

removeGroup

public void removeGroup(@Nonnull
                        String group)
                 throws NoSuchAlgorithmException,
                        InvalidKeyException,
                        IOException

Removes a group.

Parameters:

group - Group name.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

setBucketQuota

public void setBucketQuota(@Nonnull
                           String bucketName,
                           long size,
                           @Nonnull
                           QuotaUnit unit)
                    throws IOException,
                           NoSuchAlgorithmException,
                           InvalidKeyException

set bucket quota size

Parameters:

bucketName - bucketName

size - the capacity of the bucket

unit - the quota unit of the size argument

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

getBucketQuota

public long getBucketQuota(String bucketName)
                    throws IOException,
                           NoSuchAlgorithmException,
                           InvalidKeyException

get bucket quota size

Parameters:

bucketName - bucketName

Returns:

bytes of bucket

Throws:

IOException

NoSuchAlgorithmException

InvalidKeyException

clearBucketQuota

public void clearBucketQuota(@Nonnull
                             String bucketName)
                      throws IOException,
                             NoSuchAlgorithmException,
                             InvalidKeyException

Reset bucket quota

Parameters:

bucketName - bucketName

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

addCannedPolicy

public void addCannedPolicy(@Nonnull
                            String name,
                            @Nonnull
                            String policy)
                     throws NoSuchAlgorithmException,
                            InvalidKeyException,
                            IOException

Creates a policy.

Example:
 // Assume policyJson contains below JSON string;
 // {
 //     "Statement": [
 //         {
 //             "Action": "s3:GetObject",
 //             "Effect": "Allow",
 //             "Principal": "*",
 //             "Resource": "arn:aws:s3:::my-bucketname/myobject*"
 //         }
 //     ],
 //     "Version": "2012-10-17"
 // }
 //
 client.addCannedPolicy("my-policy-name", policyJson);
 

Parameters:

name - Policy name.

policy - Policy as JSON string.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

setPolicy

public void setPolicy(@Nonnull
                      String userOrGroupName,
                      boolean isGroup,
                      @Nonnull
                      String policyName)
               throws NoSuchAlgorithmException,
                      InvalidKeyException,
                      IOException

Sets a policy to a given user or group.

Parameters:

userOrGroupName - User/Group name.

isGroup - Flag to denote userOrGroupName is a group name.

policyName - Policy name.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

listCannedPolicies

public Map<String,String> listCannedPolicies()
                                      throws NoSuchAlgorithmException,
                                             InvalidKeyException,
                                             IOException

Lists all configured canned policies.

Returns:

Map of policies, keyed by their name, with their actual policy as their value.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

removeCannedPolicy

public void removeCannedPolicy(@Nonnull
                               String name)
                        throws NoSuchAlgorithmException,
                               InvalidKeyException,
                               IOException

Removes canned policy by name.

Parameters:

name - Policy name.

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

getDataUsageInfo

public DataUsageInfo getDataUsageInfo()
                               throws IOException,
                                      NoSuchAlgorithmException,
                                      InvalidKeyException

Get server/cluster data usage info

Returns:

DataUsageInfo object

Throws:

NoSuchAlgorithmException - thrown to indicate missing of MD5 or SHA-256 digest library.

InvalidKeyException - thrown to indicate missing of HMAC SHA-256 library.

IOException - thrown to indicate I/O error on MinIO REST operation.

setTimeout

public void setTimeout(long connectTimeout,
                       long writeTimeout,
                       long readTimeout)

Sets HTTP connect, write and read timeouts. A value of 0 means no timeout, otherwise values must be between 1 and Integer.MAX_VALUE when converted to milliseconds.

Example:
 minioClient.setTimeout(TimeUnit.SECONDS.toMillis(10), TimeUnit.SECONDS.toMillis(10),
     TimeUnit.SECONDS.toMillis(30));
 

Parameters:

connectTimeout - HTTP connect timeout in milliseconds.

writeTimeout - HTTP write timeout in milliseconds.

readTimeout - HTTP read timeout in milliseconds.

ignoreCertCheck

public void ignoreCertCheck()
                     throws KeyManagementException,
                            NoSuchAlgorithmException

Ignores check on server certificate for HTTPS connection.

Example:
 client.ignoreCertCheck();
 

Throws:

KeyManagementException - thrown to indicate key management error.

NoSuchAlgorithmException - thrown to indicate missing of SSL library.

setAppInfo

public void setAppInfo(String name,
                       String version)

Sets application's name/version to user agent. For more information about user agent refer #rfc2616.

Parameters:

name - Your application name.

version - Your application version.

traceOn

public void traceOn(OutputStream traceStream)

Enables HTTP call tracing and written to traceStream.

Parameters:

traceStream - OutputStream for writing HTTP call tracing.

See Also:

traceOff()

traceOff

public void traceOff()
              throws IOException

Disables HTTP call tracing previously enabled.

Throws:

IOException - upon connection error

See Also:

traceOn(java.io.OutputStream)

builder

public static MinioAdminClient.Builder builder()