com.datastrato.gravitino.client

Class GravitinoAdminClient

java.lang.Object

com.datastrato.gravitino.client.GravitinoClientBase

com.datastrato.gravitino.client.GravitinoAdminClient

All Implemented Interfaces:

SupportsMetalakes, java.io.Closeable, java.lang.AutoCloseable

public class GravitinoAdminClient
extends GravitinoClientBase
implements SupportsMetalakes

Gravitino Client for the administrator to interact with the Gravitino API, allowing the client to list, load, create, and alter Metalakes.

Normal users should use GravitinoClient to connect with the Gravitino server.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GravitinoAdminClient.AdminClientBuilder Builder class for constructing a GravitinoAdminClient.

Nested classes/interfaces inherited from class com.datastrato.gravitino.client.GravitinoClientBase

GravitinoClientBase.Builder<T>

Field Summary

Fields inherited from class com.datastrato.gravitino.client.GravitinoClientBase

API_METALAKES_IDENTIFIER_PATH, API_METALAKES_LIST_PATH, restClient

Method Summary

Modifier and Type	Method and Description
Group	addGroup(java.lang.String metalake, java.lang.String group) Adds a new Group.
User	addMetalakeAdmin(java.lang.String user) Adds a new metalake admin.
User	addUser(java.lang.String metalake, java.lang.String user) Adds a new User.
GravitinoMetalake	alterMetalake(NameIdentifier ident, MetalakeChange... changes) Alters a specific Metalake using the Gravitino API.
static GravitinoAdminClient.AdminClientBuilder	builder(java.lang.String uri) Creates a new builder for constructing a GravitinoClient.
GravitinoMetalake	createMetalake(NameIdentifier ident, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Creates a new Metalake using the Gravitino API.
Role	createRole(java.lang.String metalake, java.lang.String role, java.util.Map<java.lang.String,java.lang.String> properties, java.util.List<SecurableObject> securableObjects) Creates a new Role.
boolean	deleteRole(java.lang.String metalake, java.lang.String role) Deletes a Role.
boolean	dropMetalake(NameIdentifier ident) Drops a specific Metalake using the Gravitino API.
Group	getGroup(java.lang.String metalake, java.lang.String group) Gets a Group.
Role	getRole(java.lang.String metalake, java.lang.String role) Gets a Role.
User	getUser(java.lang.String metalake, java.lang.String user) Gets a User.
Group	grantRolesToGroup(java.lang.String metalake, java.util.List<java.lang.String> roles, java.lang.String group) Grant roles to a group.
User	grantRolesToUser(java.lang.String metalake, java.util.List<java.lang.String> roles, java.lang.String user) Grant roles to a user.
GravitinoMetalake[]	listMetalakes() Retrieves a list of Metalakes from the Gravitino API.
boolean	removeGroup(java.lang.String metalake, java.lang.String group) Removes a Group.
boolean	removeMetalakeAdmin(java.lang.String user) Removes a metalake admin.
boolean	removeUser(java.lang.String metalake, java.lang.String user) Removes a User.
Group	revokeRolesFromGroup(java.lang.String metalake, java.util.List<java.lang.String> roles, java.lang.String group) Revoke roles from a group.
User	revokeRolesFromUser(java.lang.String metalake, java.util.List<java.lang.String> roles, java.lang.String user) Revoke roles from a user.

Methods inherited from class com.datastrato.gravitino.client.GravitinoClientBase

checkVersion, clientVersion, close, getVersion, loadMetalake, serverVersion

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastrato.gravitino.SupportsMetalakes

loadMetalake, metalakeExists

Method Detail

listMetalakes

public GravitinoMetalake[] listMetalakes()

Retrieves a list of Metalakes from the Gravitino API.

Specified by:

listMetalakes in interface SupportsMetalakes

Returns:

An array of GravitinoMetalake objects representing the Metalakes.

createMetalake

public GravitinoMetalake createMetalake(NameIdentifier ident,
                                        java.lang.String comment,
                                        java.util.Map<java.lang.String,java.lang.String> properties)
                                 throws MetalakeAlreadyExistsException

Creates a new Metalake using the Gravitino API.

Specified by:

createMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the new Metalake.

comment - The comment for the new Metalake.

properties - The properties of the new Metalake.

Returns:

A GravitinoMetalake instance representing the newly created Metalake.

Throws:

MetalakeAlreadyExistsException - If a Metalake with the specified identifier already exists.

alterMetalake

public GravitinoMetalake alterMetalake(NameIdentifier ident,
                                       MetalakeChange... changes)
                                throws NoSuchMetalakeException,
                                       java.lang.IllegalArgumentException

Alters a specific Metalake using the Gravitino API.

Specified by:

alterMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the Metalake to be altered.

changes - The changes to be applied to the Metalake.

Returns:

A GravitinoMetalake instance representing the updated Metalake.

Throws:

NoSuchMetalakeException - If the specified Metalake does not exist.

java.lang.IllegalArgumentException - If the provided changes are invalid or not applicable.

dropMetalake

public boolean dropMetalake(NameIdentifier ident)

Drops a specific Metalake using the Gravitino API.

Specified by:

dropMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the Metalake to be dropped.

Returns:

True if the Metalake was successfully dropped, false otherwise.

addUser

public User addUser(java.lang.String metalake,
                    java.lang.String user)
             throws UserAlreadyExistsException,
                    NoSuchMetalakeException

Adds a new User.

Parameters:

metalake - The Metalake of the User.

user - The name of the User.

Returns:

The added User instance.

Throws:

UserAlreadyExistsException - If a User with the same name already exists.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If adding the User encounters storage issues.

removeUser

public boolean removeUser(java.lang.String metalake,
                          java.lang.String user)
                   throws NoSuchMetalakeException

Removes a User.

Parameters:

metalake - The Metalake of the User.

user - The name of the User.

Returns:

True if the User was successfully removed, false only when there's no such user, otherwise it will throw an exception.

Throws:

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If removing the User encounters storage issues.

getUser

public User getUser(java.lang.String metalake,
                    java.lang.String user)
             throws NoSuchUserException,
                    NoSuchMetalakeException

Gets a User.

Parameters:

metalake - The Metalake of the User.

user - The name of the User.

Returns:

The getting User instance.

Throws:

NoSuchUserException - If the User with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If getting the User encounters storage issues.

addGroup

public Group addGroup(java.lang.String metalake,
                      java.lang.String group)
               throws GroupAlreadyExistsException,
                      NoSuchMetalakeException

Adds a new Group.

Parameters:

metalake - The Metalake of the Group.

group - The name of the Group.

Returns:

The Added Group instance.

Throws:

GroupAlreadyExistsException - If a Group with the same name already exists.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If adding the Group encounters storage issues.

removeGroup

public boolean removeGroup(java.lang.String metalake,
                           java.lang.String group)
                    throws NoSuchMetalakeException

Removes a Group.

Parameters:

metalake - The Metalake of the Group.

group - THe name of the Group.

Returns:

True if the Group was successfully removed, false only when there's no such group, otherwise it will throw an exception.

Throws:

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If removing the Group encounters storage issues.

getGroup

public Group getGroup(java.lang.String metalake,
                      java.lang.String group)
               throws NoSuchGroupException,
                      NoSuchMetalakeException

Gets a Group.

Parameters:

metalake - The Metalake of the Group.

group - The name of the Group.

Returns:

The getting Group instance.

Throws:

NoSuchGroupException - If the Group with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If getting the Group encounters storage issues.

addMetalakeAdmin

public User addMetalakeAdmin(java.lang.String user)
                      throws UserAlreadyExistsException

Adds a new metalake admin.

Parameters:

user - The name of the User.

Returns:

The added User instance.

Throws:

UserAlreadyExistsException - If a metalake admin with the same name already exists.

java.lang.RuntimeException - If adding the User encounters storage issues.

removeMetalakeAdmin

public boolean removeMetalakeAdmin(java.lang.String user)

Removes a metalake admin.

Parameters:

user - The name of the User.

Returns:

True if the User was successfully removed, false only when there's no such metalake admin, otherwise it will throw an exception.

Throws:

java.lang.RuntimeException - If removing the User encounters storage issues.

getRole

public Role getRole(java.lang.String metalake,
                    java.lang.String role)
             throws NoSuchRoleException,
                    NoSuchMetalakeException

Gets a Role.

Parameters:

metalake - The Metalake of the Role.

role - The name of the Role.

Returns:

The getting Role instance.

Throws:

NoSuchRoleException - If the Role with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If getting the Role encounters storage issues.

deleteRole

public boolean deleteRole(java.lang.String metalake,
                          java.lang.String role)
                   throws NoSuchMetalakeException

Deletes a Role.

Parameters:

metalake - The Metalake of the Role.

role - The name of the Role.

Returns:

True if the Role was successfully deleted, false only when there's no such role, otherwise it will throw an exception.

Throws:

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If deleting the Role encounters storage issues.

createRole

public Role createRole(java.lang.String metalake,
                       java.lang.String role,
                       java.util.Map<java.lang.String,java.lang.String> properties,
                       java.util.List<SecurableObject> securableObjects)
                throws RoleAlreadyExistsException,
                       NoSuchMetalakeException

Creates a new Role.

Parameters:

metalake - The Metalake of the Role.

role - The name of the Role.

properties - The properties of the Role.

securableObjects - The securable objects of the Role.

Returns:

The created Role instance.

Throws:

RoleAlreadyExistsException - If a Role with the same name already exists.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If creating the Role encounters storage issues.

grantRolesToUser

public User grantRolesToUser(java.lang.String metalake,
                             java.util.List<java.lang.String> roles,
                             java.lang.String user)
                      throws NoSuchUserException,
                             NoSuchRoleException,
                             NoSuchMetalakeException

Grant roles to a user.

Parameters:

metalake - The metalake of the User.

user - The name of the User.

roles - The names of the Role.

Returns:

The Group after granted.

Throws:

NoSuchUserException - If the User with the given name does not exist.

NoSuchRoleException - If the Role with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If granting roles to a user encounters storage issues.

grantRolesToGroup

public Group grantRolesToGroup(java.lang.String metalake,
                               java.util.List<java.lang.String> roles,
                               java.lang.String group)
                        throws NoSuchGroupException,
                               NoSuchRoleException,
                               NoSuchMetalakeException

Grant roles to a group.

Parameters:

metalake - The metalake of the Group.

group - The name of the Group.

roles - The names of the Role.

Returns:

The Group after granted.

Throws:

NoSuchGroupException - If the Group with the given name does not exist.

NoSuchRoleException - If the Role with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If granting roles to a group encounters storage issues.

revokeRolesFromUser

public User revokeRolesFromUser(java.lang.String metalake,
                                java.util.List<java.lang.String> roles,
                                java.lang.String user)
                         throws NoSuchUserException,
                                NoSuchRoleException,
                                NoSuchMetalakeException

Revoke roles from a user.

Parameters:

metalake - The metalake of the User.

user - The name of the User.

roles - The names of the Role.

Returns:

The User after revoked.

Throws:

NoSuchUserException - If the User with the given name does not exist.

NoSuchRoleException - If the Role with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If revoking roles from a user encounters storage issues.

revokeRolesFromGroup

public Group revokeRolesFromGroup(java.lang.String metalake,
                                  java.util.List<java.lang.String> roles,
                                  java.lang.String group)
                           throws NoSuchGroupException,
                                  NoSuchRoleException,
                                  NoSuchMetalakeException

Revoke roles from a group.

Parameters:

metalake - The metalake of the Group.

group - The name of the Group.

roles - The names of the Role.

Returns:

The Group after revoked.

Throws:

NoSuchGroupException - If the Group with the given name does not exist.

NoSuchRoleException - If the Role with the given name does not exist.

NoSuchMetalakeException - If the Metalake with the given name does not exist.

java.lang.RuntimeException - If revoking roles from a group encounters storage issues.

builder

public static GravitinoAdminClient.AdminClientBuilder builder(java.lang.String uri)

Creates a new builder for constructing a GravitinoClient.

Parameters:

uri - The base URI for the Gravitino API.

Returns:

A new instance of the Builder class for constructing a GravitinoClient.