org.hswebframework.web.authorization

接口 Authentication

所有超级接口:

Serializable

所有已知子接口:

MultiAuthentication

所有已知实现类:

SimpleAuthentication

public interface Authentication
extends Serializable

用户授权信息,当前登录用户的权限信息,包括用户的基本信息,角色,权限集合等常用信息
获取方式:

• springmvc 入参方式: ResponseMessage myTest(Authorization auth){}
• 静态方法方式:AuthorizationHolder.get();

从以下版本开始:

3.0

作者:

zhouhao

另请参阅:

AuthenticationHolder, AuthenticationManager

方法概要

限定符和类型	方法和说明
static Optional<Authentication>	current() 获取当前登录的用户权限信息 Authentication auth= Authentication.current().get(); //如果权限信息不存在将抛出NoSuchElementException建议使用下面的方式获取 Authentication auth=Authentication.current().orElse(null); //或者 Authentication auth=Authentication.current().orElseThrow(UnAuthorizedException::new);
<T extends Serializable> Optional<T>	getAttribute(String name) 根据属性名获取属性值,返回一个Optional对象。
Map<String,Serializable>	getAttributes() 获取全部属性,此属性为通过this#setAttribute(String, Serializable)或this#setAttributes(Map)设置的属性。
default Optional<Permission>	getPermission(String id) 根据权限id获取权限信息,权限不存在则返回null
List<Permission>	getPermissions()
default Optional<Role>	getRole(String id) 根据id获取角色,角色不存在则返回null
List<Role>	getRoles()
User	getUser()
default boolean	hasPermission(String permissionId, String... actions) 判断是否持有某权限以及对权限的可操作事件
default boolean	hasRole(String roleId)
<T extends Serializable> T	removeAttributes(String name) 删除属性,并返回被删除的值
void	setAttribute(String name, Serializable object) 设置一个属性值,如果属性名称已经存在,则将其覆盖。
void	setAttributes(Map<String,Serializable> attributes) 设置多个属性值,参数为map类型,key为属性名称,value为属性值

方法详细资料

current

static Optional<Authentication> current()

获取当前登录的用户权限信息

   Authentication auth= Authentication.current().get();
   //如果权限信息不存在将抛出NoSuchElementException建议使用下面的方式获取
   Authentication auth=Authentication.current().orElse(null);
   //或者
   Authentication auth=Authentication.current().orElseThrow(UnAuthorizedException::new);
 

返回:

返回Optional对象进行操作

另请参阅:

Optional, AuthenticationHolder

getUser

User getUser()

返回:

用户信息

getRoles

List<Role> getRoles()

返回:

用户持有的角色集合

getPermissions

List<Permission> getPermissions()

返回:

用户持有的权限集合

getRole

default Optional<Role> getRole(String id)

根据id获取角色,角色不存在则返回null

参数:

id - 角色id

返回:

角色信息

getPermission

default Optional<Permission> getPermission(String id)

根据权限id获取权限信息,权限不存在则返回null

参数:

id - 权限id

返回:

权限信息

hasPermission

default boolean hasPermission(String permissionId,
                              String... actions)

判断是否持有某权限以及对权限的可操作事件

参数:

permissionId - 权限id Permission.getId()

actions - 可操作事件 Permission.getActions() 如果为空,则不判断action,只判断permissionId

返回:

是否持有权限

hasRole

default boolean hasRole(String roleId)

参数:

roleId - 角色id Role.getId()

返回:

是否拥有某个角色

getAttribute

<T extends Serializable> Optional<T> getAttribute(String name)

根据属性名获取属性值,返回一个Optional对象。
此方法可用于获取自定义的属性信息

类型参数:

T - 属性值类型

参数:

name - 属性名

返回:

Optional属性值

setAttribute

void setAttribute(String name,
                  Serializable object)

设置一个属性值,如果属性名称已经存在,则将其覆盖。
注意:由于权限信息可能会被序列化,属性值必须实现Serializable接口

参数:

name - 属性名称

object - 属性值

另请参阅:

AuthenticationManager.sync(Authentication)

setAttributes

void setAttributes(Map<String,Serializable> attributes)

设置多个属性值,参数为map类型,key为属性名称,value为属性值

参数:

attributes - 属性值map

另请参阅:

AuthenticationManager.sync(Authentication)

removeAttributes

<T extends Serializable> T removeAttributes(String name)

删除属性,并返回被删除的值

类型参数:

T - 被删除的值类型

参数:

name - 属性名

返回:

被删除的值

另请参阅:

AuthenticationManager.sync(Authentication)

getAttributes

Map<String,Serializable> getAttributes()

获取全部属性,此属性为通过this#setAttribute(String, Serializable)或this#setAttributes(Map)设置的属性。

返回:

全部属性集合