org.hswebframework.web.authorization

接口 Permission

所有超级接口:

Serializable

所有已知实现类:

SimplePermission

public interface Permission
extends Serializable

用户持有的权限信息,包含了权限基本信息、可操作范围(action)、行,列级权限控制规则。 是用户权限的重要接口。

从以下版本开始:

3.0

作者:

zhouhao

另请参阅:

Authentication

嵌套类概要

嵌套类

限定符和类型	接口和说明
static interface	Permission.DataAccessPredicate<T extends DataAccessConfig> 数据权限查找判断逻辑接口

字段概要

字段

限定符和类型	字段和说明
static String	ACTION_ADD 新增
static String	ACTION_DELETE 删除
static String	ACTION_DISABLE 禁用
static String	ACTION_ENABLE 启用
static String	ACTION_EXPORT 导出
static String	ACTION_GET 获取明细
static String	ACTION_IMPORT 导入
static String	ACTION_QUERY 查询
static String	ACTION_UPDATE 更新

方法概要

限定符和类型	方法和说明
default <T extends DataAccessConfig> Optional<T>	findDataAccess(Permission.DataAccessPredicate<T> configPredicate) 查找数据权限配置
default Set<String>	findDenyFields(String action) 获取不能执行操作的字段
default Optional<FieldFilterDataAccessConfig>	findFieldFilter(String action) 查找字段过滤的数据权限配置(列级数据权限),比如:不查询某些字段
default Set<Object>	findScope(Permission.DataAccessPredicate<ScopeDataAccessConfig> predicate)
default Set<Object>	findScope(String action, String type, String scopeType) 查找数据范围权限控制配置(行级数据权限),比如: 只能查询本机构的数据
Set<String>	getActions() 用户对此权限的可操作事件(按钮) ⚠️:任何时候都不应该对返回的Set进行写操作
Set<DataAccessConfig>	getDataAccesses() 用户对此权限持有的数据权限信息, 用于数据级别的控制 ⚠️:任何时候都不应该对返回的Set进行写操作
String	getId()
static Permission.DataAccessPredicate<ScopeDataAccessConfig>	scope(String action, String type, String scopeType) 构造一个数据范围权限控制配置查找逻辑

字段详细资料

ACTION_QUERY

static final String ACTION_QUERY

查询

另请参阅:

常量字段值

ACTION_GET

static final String ACTION_GET

获取明细

另请参阅:

常量字段值

ACTION_ADD

static final String ACTION_ADD

新增

另请参阅:

常量字段值

ACTION_UPDATE

static final String ACTION_UPDATE

更新

另请参阅:

常量字段值

ACTION_DELETE

static final String ACTION_DELETE

删除

另请参阅:

常量字段值

ACTION_IMPORT

static final String ACTION_IMPORT

导入

另请参阅:

常量字段值

ACTION_EXPORT

static final String ACTION_EXPORT

导出

另请参阅:

常量字段值

ACTION_DISABLE

static final String ACTION_DISABLE

禁用

另请参阅:

常量字段值

ACTION_ENABLE

static final String ACTION_ENABLE

启用

另请参阅:

常量字段值

方法详细资料

getId

String getId()

返回:

权限ID，权限的唯一标识

getActions

Set<String> getActions()

用户对此权限的可操作事件(按钮)

⚠️:任何时候都不应该对返回的Set进行写操作

返回:

如果没有配置返回空Collections.emptySet(),不会返回null.

getDataAccesses

Set<DataAccessConfig> getDataAccesses()

用户对此权限持有的数据权限信息, 用于数据级别的控制

⚠️:任何时候都不应该对返回的Set进行写操作

返回:

如果没有配置返回空Collections.emptySet(),不会返回null.

另请参阅:

DataAccessConfig, DataAccessController

findDataAccess

default <T extends DataAccessConfig> Optional<T> findDataAccess(Permission.DataAccessPredicate<T> configPredicate)

查找数据权限配置

类型参数:

T - 数据权限配置类型

参数:

configPredicate - 数据权限配置匹配规则

返回:

Optional

另请参阅:

this#scope(String, String, String)

findFieldFilter

default Optional<FieldFilterDataAccessConfig> findFieldFilter(String action)

查找字段过滤的数据权限配置(列级数据权限),比如:不查询某些字段

参数:

action - 权限操作类型 ACTION_QUERY

返回:

Optional

另请参阅:

FieldFilterDataAccessConfig, FieldFilterDataAccessConfig.getFields()

findDenyFields

default Set<String> findDenyFields(String action)

获取不能执行操作的字段

参数:

action - 权限操作

返回:

未配置时返回空set, 不会返回null

findScope

default Set<Object> findScope(String action,
                              String type,
                              String scopeType)

查找数据范围权限控制配置(行级数据权限),比如: 只能查询本机构的数据

参数:

type - 范围类型标识,由具体的实现定义,如: 机构范围

scopeType - 范围类型,由具体的实现定义,如: 只能查看自己所在机构

action - 权限操作 ACTION_QUERY

返回:

未配置时返回空set, 不会返回null

findScope

default Set<Object> findScope(Permission.DataAccessPredicate<ScopeDataAccessConfig> predicate)

scope

static Permission.DataAccessPredicate<ScopeDataAccessConfig> scope(String action,
                                                                   String type,
                                                                   String scopeType)

构造一个数据范围权限控制配置查找逻辑

参数:

type - 范围类型标识,由具体的实现定义,如: 机构范围

scopeType - 范围类型,由具体的实现定义,如: 只能查看自己所在机构

action - 权限操作 ACTION_QUERY

返回:

Permission.DataAccessPredicate