org.apache.iotdb.db.auth.user

类 BasicUserManager

java.lang.Object

org.apache.iotdb.db.auth.user.BasicUserManager

所有已实现的接口:

IUserManager

直接已知子类:

LocalFileUserManager

public abstract class BasicUserManager
extends Object
implements IUserManager

This class stores information of each user in a separate file within a directory, and cache them in memory when a user is accessed.

构造器概要

构造器

构造器和说明
BasicUserManager(IUserAccessor accessor) BasicUserManager Constructor.

方法概要

限定符和类型	方法和说明
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.

从类继承的方法 java.lang.Object

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

构造器详细资料

BasicUserManager

public BasicUserManager(IUserAccessor accessor)
                 throws AuthException

BasicUserManager Constructor.

参数:

accessor - user accessor

抛出:

AuthException - Authentication Exception

方法详细资料

getUser

public User getUser(String username)
             throws AuthException

从接口复制的说明: IUserManager

Get a user object.

指定者:

getUser 在接口中 IUserManager

参数:

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

public boolean createUser(String username,
                          String password)
                   throws AuthException

从接口复制的说明: IUserManager

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

指定者:

createUser 在接口中 IUserManager

参数:

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

public boolean deleteUser(String username)
                   throws AuthException

从接口复制的说明: IUserManager

Delete a user.

指定者:

deleteUser 在接口中 IUserManager

参数:

username - the username of the user.

返回:

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

抛出:

AuthException - .

grantPrivilegeToUser

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

从接口复制的说明: IUserManager

Grant a privilege on a seriesPath to a user.

指定者:

grantPrivilegeToUser 在接口中 IUserManager

参数:

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

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

从接口复制的说明: IUserManager

Revoke a privilege on seriesPath from a user.

指定者:

revokePrivilegeFromUser 在接口中 IUserManager

参数:

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

public boolean updateUserPassword(String username,
                                  String newPassword)
                           throws AuthException

从接口复制的说明: IUserManager

Modify the password of a user.

指定者:

updateUserPassword 在接口中 IUserManager

参数:

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

public boolean grantRoleToUser(String roleName,
                               String username)
                        throws AuthException

从接口复制的说明: IUserManager

Add a role to a user.

指定者:

grantRoleToUser 在接口中 IUserManager

参数:

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

public boolean revokeRoleFromUser(String roleName,
                                  String username)
                           throws AuthException

从接口复制的说明: IUserManager

Revoke a role from a user.

指定者:

revokeRoleFromUser 在接口中 IUserManager

参数:

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

public void reset()
           throws AuthException

从接口复制的说明: IUserManager

Re-initialize this object.

指定者:

reset 在接口中 IUserManager

抛出:

AuthException

listAllUsers

public List<String> listAllUsers()

从接口复制的说明: IUserManager

List all users in the database.

指定者:

listAllUsers 在接口中 IUserManager

返回:

A list that contains all users'name.

isUserUseWaterMark

public boolean isUserUseWaterMark(String username)
                           throws AuthException

从接口复制的说明: IUserManager

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

指定者:

isUserUseWaterMark 在接口中 IUserManager

返回:

抛出:

AuthException - if the user does not exist

setUserUseWaterMark

public void setUserUseWaterMark(String username,
                                boolean useWaterMark)
                         throws AuthException

从接口复制的说明: IUserManager

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

指定者:

setUserUseWaterMark 在接口中 IUserManager

抛出:

AuthException - if the user does not exist.

replaceAllUsers

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

从接口复制的说明: IUserManager

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.

指定者:

replaceAllUsers 在接口中 IUserManager

参数:

users - new users info

抛出:

AuthException