org.hswebframework.web.authorization

Interface Authentication

All Superinterfaces:

Serializable

All Known Implementing Classes:

SimpleAuthentication

public interface Authentication
extends Serializable

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

• springmvc 入参方式: ResponseMessage myTest(Authorization auth){}
• 静态方法方式:AuthorizationHolder.get();
• 响应式方式: return Authentication.currentReactive().map(auth->....)

Since:

3.0

Author:

zhouhao

See Also:

ReactiveAuthenticationHolder, AuthenticationManager

Method Summary

Modifier and Type	Method and Description
Authentication	copy(BiPredicate<Permission,String> permissionFilter, Predicate<Dimension> dimension) copy为新的权限信息
static Optional<Authentication>	current() 非响应式环境适用
static reactor.core.publisher.Mono<Authentication>	currentReactive() 获取当前登录的用户权限信息
<T extends Serializable> Optional<T>	getAttribute(String name) 根据属性名获取属性值,返回一个Optional对象。 此方法可用于获取自定义的属性信息
Map<String,Serializable>	getAttributes()
default Optional<Dimension>	getDimension(DimensionType type, String id)
default Optional<Dimension>	getDimension(String type, String id)
List<Dimension>	getDimensions()
default List<Dimension>	getDimensions(DimensionType type)
default List<Dimension>	getDimensions(String type)
default Optional<Permission>	getPermission(String id) 根据权限id获取权限信息,权限不存在则返回null
List<Permission>	getPermissions()
User	getUser()
default boolean	hasDimension(DimensionType type, String id)
default boolean	hasDimension(String type, Collection<String> id)
default boolean	hasDimension(String type, String... id)
default boolean	hasPermission(String permissionId, Collection<String> actions)
default boolean	hasPermission(String permissionId, String... actions) 判断是否持有某权限以及对权限的可操作事件
Authentication	merge(Authentication source) 合并权限

Method Detail

currentReactive

static reactor.core.publisher.Mono<Authentication> currentReactive()

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

     public Mono<User> getUser(){
         return Authentication.currentReactive()
                 .switchIfEmpty(Mono.error(new UnAuthorizedException()))
                 .flatMap(autz->findUserByUserId(autz.getUser().getId()));
     }
 

Returns:

当前用户权限信息

Since:

4.0

See Also:

ReactiveAuthenticationHolder

current

static Optional<Authentication> current()

非响应式环境适用

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

Returns:

当前用户权限信息

See Also:

Optional

getUser

User getUser()

Returns:

用户信息

getDimensions

List<Dimension> getDimensions()

Returns:

用户所有维度

Since:

4.0

getPermissions

List<Permission> getPermissions()

Returns:

用户持有的权限集合

hasDimension

default boolean hasDimension(String type,
                             String... id)

hasDimension

default boolean hasDimension(String type,
                             Collection<String> id)

hasDimension

default boolean hasDimension(DimensionType type,
                             String id)

getDimension

default Optional<Dimension> getDimension(String type,
                                         String id)

getDimension

default Optional<Dimension> getDimension(DimensionType type,
                                         String id)

getDimensions

default List<Dimension> getDimensions(String type)

getDimensions

default List<Dimension> getDimensions(DimensionType type)

getPermission

default Optional<Permission> getPermission(String id)

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

Parameters:

id - 权限id

Returns:

权限信息

hasPermission

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

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

Parameters:

permissionId - 权限id Permission.getId()

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

Returns:

是否持有权限

hasPermission

default boolean hasPermission(String permissionId,
                              Collection<String> actions)

getAttribute

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

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

Type Parameters:

T - 属性值类型

Parameters:

name - 属性名

Returns:

Optional属性值

getAttributes

Map<String,Serializable> getAttributes()

Returns:

全部属性集合

merge

Authentication merge(Authentication source)

合并权限

Parameters:

source - 源权限信息

Returns:

合并后的信息

copy

Authentication copy(BiPredicate<Permission,String> permissionFilter,
                    Predicate<Dimension> dimension)

copy为新的权限信息

Parameters:

permissionFilter - 权限过滤

dimension - 维度过滤

Returns:

新的权限信息