org.apache.iotdb.db.auth.role

类 BasicRoleManager

java.lang.Object

org.apache.iotdb.db.auth.role.BasicRoleManager

所有已实现的接口:

IRoleManager

直接已知子类:

LocalFileRoleManager

public abstract class BasicRoleManager
extends Object
implements IRoleManager

This class reads roles from local files through LocalFileRoleAccessor and manages them in a hash map.

方法概要

限定符和类型	方法和说明
boolean	createRole(String rolename) Create a role with given rolename.
boolean	deleteRole(String rolename) Delete a role.
Role	getRole(String rolename) Get a role object.
boolean	grantPrivilegeToRole(String rolename, String path, int privilegeId) Grant a privilege on a seriesPath to a role.
List<String>	listAllRoles() List all roles in the database.
void	replaceAllRoles(Map<String,Role> roles) clear all old roles info, replace the old roles with the new one.
void	reset() Re-initialize this object.
boolean	revokePrivilegeFromRole(String rolename, String path, int privilegeId) Revoke a privilege on seriesPath from a role.

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

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

方法详细资料

getRole

public Role getRole(String rolename)
             throws AuthException

从接口复制的说明: IRoleManager

Get a role object.

指定者:

getRole 在接口中 IRoleManager

参数:

rolename - The name of the role.

返回:

A role object whose name is rolename or null if such role does not exist.

抛出:

AuthException - if exception is raised while getting the role.

createRole

public boolean createRole(String rolename)
                   throws AuthException

从接口复制的说明: IRoleManager

Create a role with given rolename. New roles will only be granted no privileges.

指定者:

createRole 在接口中 IRoleManager

参数:

rolename - is not null or empty

返回:

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

抛出:

AuthException - f the given rolename is iIllegal.

deleteRole

public boolean deleteRole(String rolename)
                   throws AuthException

从接口复制的说明: IRoleManager

Delete a role.

指定者:

deleteRole 在接口中 IRoleManager

参数:

rolename - the rolename of the role.

返回:

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

抛出:

AuthException - if exception is raised while finding the role.

grantPrivilegeToRole

public boolean grantPrivilegeToRole(String rolename,
                                    String path,
                                    int privilegeId)
                             throws AuthException

从接口复制的说明: IRoleManager

Grant a privilege on a seriesPath to a role.

指定者:

grantPrivilegeToRole 在接口中 IRoleManager

参数:

rolename - The rolename of the role 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 role does not exist or the privilege or the seriesPath is illegal.

revokePrivilegeFromRole

public boolean revokePrivilegeFromRole(String rolename,
                                       String path,
                                       int privilegeId)
                                throws AuthException

从接口复制的说明: IRoleManager

Revoke a privilege on seriesPath from a role.

指定者:

revokePrivilegeFromRole 在接口中 IRoleManager

参数:

rolename - The rolename of the role from which the privilege should be removed.

path - The seriesPath on which the privilege takes effect. If the privilege is a seriesPath-free privilege like 'CREATE_USER', 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 role does not exist or the privilege or the seriesPath is illegal.

reset

public void reset()

从接口复制的说明: IRoleManager

Re-initialize this object.

指定者:

reset 在接口中 IRoleManager

listAllRoles

public List<String> listAllRoles()

从接口复制的说明: IRoleManager

List all roles in the database.

指定者:

listAllRoles 在接口中 IRoleManager

返回:

A list that contains names of all roles.

replaceAllRoles

public void replaceAllRoles(Map<String,Role> roles)
                     throws AuthException

从接口复制的说明: IRoleManager

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

指定者:

replaceAllRoles 在接口中 IRoleManager

参数:

roles - new roles info

抛出:

AuthException