org.apache.iotdb.db.auth.user

接口 IUserManager

所有已知实现类:

BasicUserManager, LocalFileUserManager

public interface IUserManager

This interface provides accesses to users.

方法概要

限定符和类型	方法和说明
boolean	createUser(String username, String password) Create a user with given username and password.
boolean	deleteUser(String username) Delete a user.
User	getUser(String username) Get a user object.
boolean	grantPrivilegeToUser(String username, String path, int privilegeId) Grant a privilege on a seriesPath to a user.
boolean	grantRoleToUser(String roleName, String username) Add a role to a user.
boolean	isUserUseWaterMark(String userName) Whether data water-mark is enabled for user 'userName'.
List<String>	listAllUsers() List all users in the database.
void	replaceAllUsers(Map<String,User> users) clear all old users info, replace the old users with the new one.
void	reset() Re-initialize this object.
boolean	revokePrivilegeFromUser(String username, String path, int privilegeId) Revoke a privilege on seriesPath from a user.
boolean	revokeRoleFromUser(String roleName, String username) Revoke a role from a user.
void	setUserUseWaterMark(String userName, boolean useWaterMark) Enable or disable data water-mark for user 'userName'.
boolean	updateUserPassword(String username, String newPassword) Modify the password of a user.

方法详细资料

getUser

User getUser(String username)
      throws AuthException

Get a user object.

参数:

username - The name of the user.

返回:

A user object whose name is username or null if such user does not exist.

抛出:

AuthException - if an exception is raised when interacting with the lower storage.

createUser

boolean createUser(String username,
                   String password)
            throws AuthException

Create a user with given username and password. New users will only be granted no privileges.

参数:

username - is not null or empty

password - is not null or empty

返回:

True if the user is successfully created, false when the user already exists.

抛出:

AuthException - if the given username or password is illegal.

deleteUser

boolean deleteUser(String username)
            throws AuthException

Delete a user.

参数:

username - the username of the user.

返回:

True if the user is successfully deleted, false if the user does not exists.

抛出:

AuthException - .

grantPrivilegeToUser

boolean grantPrivilegeToUser(String username,
                             String path,
                             int privilegeId)
                      throws AuthException

Grant a privilege on a seriesPath to a user.

参数:

username - The username of the user to which the privilege should be added.

path - The seriesPath on which the privilege takes effect. If the privilege is a seriesPath-free privilege, this should be "root".

privilegeId - An integer that represents a privilege.

返回:

True if the permission is successfully added, false if the permission already exists.

抛出:

AuthException - If the user does not exist or the privilege or the seriesPath is illegal.

revokePrivilegeFromUser

boolean revokePrivilegeFromUser(String username,
                                String path,
                                int privilegeId)
                         throws AuthException

Revoke a privilege on seriesPath from a user.

参数:

username - The username of the user from which the privilege should be removed.

path - The seriesPath on which the privilege takes effect. If the privilege is a seriesPath-free privilege, this should be "root".

privilegeId - An integer that represents a privilege.

返回:

True if the permission is successfully revoked, false if the permission does not exists.

抛出:

AuthException - If the user does not exist or the privilege or the seriesPath is illegal.

updateUserPassword

boolean updateUserPassword(String username,
                           String newPassword)
                    throws AuthException

Modify the password of a user.

参数:

username - The user whose password is to be modified.

newPassword - The new password.

返回:

True if the password is successfully modified, false if the new password is illegal.

抛出:

AuthException - If the user does not exists.

grantRoleToUser

boolean grantRoleToUser(String roleName,
                        String username)
                 throws AuthException

Add a role to a user.

参数:

roleName - The name of the role to be added.

username - The name of the user to which the role is added.

返回:

True if the role is successfully added, false if the role already exists.

抛出:

AuthException - If the user does not exist.

revokeRoleFromUser

boolean revokeRoleFromUser(String roleName,
                           String username)
                    throws AuthException

Revoke a role from a user.

参数:

roleName - The name of the role to be removed.

username - The name of the user from which the role is removed.

返回:

True if the role is successfully removed, false if the role does not exist.

抛出:

AuthException - If the user does not exist.

reset

void reset()
    throws AuthException

Re-initialize this object.

抛出:

AuthException

listAllUsers

List<String> listAllUsers()

List all users in the database.

返回:

A list that contains all users'name.

isUserUseWaterMark

boolean isUserUseWaterMark(String userName)
                    throws AuthException

Whether data water-mark is enabled for user 'userName'.

参数:

userName -

返回:

抛出:

AuthException - if the user does not exist

setUserUseWaterMark

void setUserUseWaterMark(String userName,
                         boolean useWaterMark)
                  throws AuthException

Enable or disable data water-mark for user 'userName'.

参数:

userName -

useWaterMark -

抛出:

AuthException - if the user does not exist.

replaceAllUsers

void replaceAllUsers(Map<String,User> users)
              throws AuthException

clear all old users info, replace the old users with the new one. The caller should guarantee that no other methods of this interface are invoked concurrently when this method is called.

参数:

users - new users info

抛出:

AuthException