cn.omisheep.authz

类 AuHelper

java.lang.Object

cn.omisheep.authz.core.helper.BaseHelper

cn.omisheep.authz.AuHelper

public class AuHelper
extends BaseHelper

时间字符串均采用如下格式
"2d 3h 4m 5s 100ms"-> 2天3小时4分钟5秒100毫秒 用空格隔开

从以下版本开始:

1.0.0

版本:

1.2

作者:

zhouxinchen[1269670415@qq.com]

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	AuHelper.Cache 1、在开启Redis时为L2Cache(二级缓存)，默认情况下为普通的带时间策略的缓存 2、缓存策略： 2.1、若没有指定时间，默认为永久 2.2、在指定时间后，过期会删除key 2.3、若指定时间，L2环境下，本地时间会小于redis所存留的时间，在每次访问时，本地时间会重新计时，且成为热点key，加载速度更快 2.4、若指定时间，则会在redis里存一份，本地存一份，若其他实例修改，则会同步修改（默认实现为redis的消息队列） 3.L2Cache开启时会默认创建缓存消息通道，在修改其中
static class	AuHelper.Callback
static class	AuHelper.OpenAuth 1.注册客户端 AuHelper.OpenAuth.clientRegister(String, String) -> 返回客户端信息（客户端id，客户端name，客户端密钥，重定向url） 2.获取授权码 AuHelper.OpenAuth.createAuthorizationCode(String, String, String) -> 客户端id+登录用户+权限范围 、获得登录用户的授权码 3.验证授权码 AuHelper.OpenAuth.authorizeByCode(String, String, String)-> 利用授权码去获得IssueToken or 3.登录授权 AuHelper.OpenAuth.authorizeByPassword(String, String, String)-> 登录即可获得IssueToken
static class	AuHelper.RSA

字段概要

从类继承的字段 cn.omisheep.authz.core.helper.BaseHelper

cache, ctx, openAuthLibrary, permLibrary, properties, userDevicesDict

方法概要

限定符和类型	方法和说明
static void	addDeviceTypesTotalLimit(Collection<String> types, int total) 每[一种、多种]设备类型设置[共同]的最大登录数（最小为1），超出会挤出最长时间未访问的设备。
static void	addDeviceTypesTotalLimitAt(Object userId, Collection<String> types, int total) 每[一种、多种]设备类型设置[共同]的最大登录数（最小为1），超出会挤出最长时间未访问的设备。
static Object	authzModify(AuthzModifier authzModifier)
static void	changeMaximumDeviceTotal(int total) 登录设备总数默不做限制【total为-1不做限制，最小为1】，超出会挤出最长时间未访问的设备。
static void	changeMaximumTotalDeviceAt(Object userId, int total) 登录设备总数默不做限制【total为-1不做限制，最小为1】，超出会挤出最长时间未访问的设备。
static void	changeMaximumTotalSameTypeDevice(int total) 同类型设备最多登录数 默认 1个【count最小为1】，超出会挤出最长时间未访问的设备。
static void	changeMaximumTotalSameTypeDeviceAt(Object userId, int count) 同类型设备最多登录数 默认 1个【count最小为1】，超出会挤出最长时间未访问的设备。
static boolean	checkUserIsActive(Object userId) 判断某个用户是否有设备【在线/活跃】（默认60秒内）
static boolean	checkUserIsActive(Object userId, long ms) 判断某个用户是否【在线/活跃】
static boolean	checkUserIsActive(Object userId, String time) 判断某个用户是否【在线/活跃】
static void	denyDevice(Object userId, String deviceType, Date endDate) 【添加、修改】封禁 封禁 time时间
static void	denyDevice(Object userId, String deviceType, long ms) 【添加、修改】封禁 封禁 time时间
static void	denyDevice(Object userId, String deviceType, String deviceId, Date endDate) 【添加、修改】封禁 设备 time时间
static void	denyDevice(Object userId, String deviceType, String deviceId, long ms) 【添加、修改】封禁 设备 time时间
static void	denyIP(String ip, Date endDate) 【添加、修改】封禁 ip time时间
static void	denyIP(String ip, long ms) 【添加、修改】封禁 ip time时间
static void	denyIPRange(String ipRange, Date endDate) 【添加、修改】封禁 ipRange网段 time时间
static void	denyIPRange(String ipRange, long ms) 【添加、修改】封禁 ipRange网段 time时间
static void	denyUser(Object userId, Date endDate) 【添加、修改】封禁 device time时间
static void	denyUser(Object userId, long ms) 【添加、修改】封禁 device time时间
static List<DeviceDetails>	getActiveDevices() 所有【在线/活跃】用户详细设备信息 （默认60秒内）
static List<DeviceDetails>	getActiveDevices(long ms) 所有【在线/活跃】用户详细设备信息
static List<DeviceDetails>	getActiveDevices(String time) 所有【在线/活跃】用户详细设备信息
static List<Object>	getActiveUserIdList() 所有【在线/活跃】（默认60秒内）用户Id数组
static List<Object>	getActiveUserIdList(long ms) 所有【在线/活跃】用户Id列表
static List<Object>	getActiveUserIdList(String time) 所有【在线/活跃】用户Id列表
static Set<Blacklist.IP>	getAllDenyIPInfo() 得到所有的 封禁的ip信息
static Set<Blacklist.IPRangeDeny>	getAllDenyIPRangeInfo()
static Set<Blacklist.User>	getAllDenyUserInfo()
static Map<Object,List<DeviceDetails>>	getAllUserDevices() 查询所有用户信息，一个map userId->设备信息列表
static List<Object>	getAllUserId()
static String	getClientId()
static Blacklist.User	getDenyDeviceInfo(Object userId, String deviceType, String deviceId)
static Blacklist.IP	getDenyIPInfo(String ip)
static Set<Blacklist.User>	getDenyUserAndDeviceInfo(Object userId)
static Blacklist.User	getDenyUserInfo(Object userId)
static DeviceDetails	getDevice() 当前访问用户的设备
static DeviceDetails	getDeviceAt(Object userId, String deviceType, String deviceId) 获得指定设备信息
static String	getDeviceId()
static List<DeviceDetails>	getDevices() 当前访问用户的所有设备
static List<DeviceDetails>	getDevices(String deviceType) 当前访问用户的指定类型的所有设备
static List<DeviceDetails>	getDevicesAt(Object userId) 指定用户的所有设备
static List<DeviceDetails>	getDevicesAt(Object userId, String deviceType) 指定用户的指定类型的所有设备
static String	getDeviceType()
static HttpMeta	getHttpMeta() 若当前线程未绑定HttpRequest。
static int	getNumberOfActiveUser() 所有【在线/活跃】（默认60秒内）用户数量
static int	getNumberOfActiveUser(long ms) 所有【在线/活跃】用户数量
static int	getNumberOfActiveUser(String time) 所有【在线/活跃】用户数量
static List<DeviceCountInfo>	getOrUpdateDeviceTypesTotalLimit() 获得当前用户 可修改的 DeviceTypesTotalLimit list count >= 1 or count = -1
static List<DeviceCountInfo>	getOrUpdateDeviceTypesTotalLimitAt(Object userId) 获得任意用户 可修改的 DeviceTypesTotalLimit list count >= 1 or count = -1
static OS	getOS()
static Platform	getPlatform()
static AccessToken	getToken()
static UserAgent	getUserAgent()
static Object	getUserId()
static boolean	hasPermission(String... permission)
static boolean	hasPermissions(List<String> permissions)
static boolean	hasRole(String... role)
static boolean	hasRoles(List<String> roles)
static boolean	hasScope(List<String> scope)
static boolean	hasScope(String... scope)
static boolean	isLogin()
static boolean	isLoginById(Object userId, String id)
static boolean	isLoginById(String id)
static IssueToken	login(Object userId) 用户登录 若线程绑定了Request，则登录成功之后会默认给请求返回Cookie 过期时间为AccessToken的过期时间，若不需要，请自行删除
static IssueToken	login(Object userId, String deviceType) 用户登录 若线程绑定了Request，则登录成功之后会默认给请求返回Cookie 过期时间为AccessToken的过期时间，若不需要，请自行删除
static IssueToken	login(Object userId, String deviceType, String deviceId) 用户登录 若线程绑定了Request，则登录成功之后会默认给请求返回Cookie 过期时间为AccessToken的过期时间，若不需要，请自行删除
static void	logout() 注销当前用户当前设备
static void	logout(String deviceType) 注销当前用户所指定的类型的所有设备
static void	logout(String deviceType, String deviceId) 注销当前用户所指定的类型和id的设备
static void	logoutAll() 注销当前用户所有设备
static void	logoutAllAt(Object userId) 注销指定用户所有设备，建议用于管理员，如果某用户想通过自己id注销自己，建议加上参数权限判断
static void	logoutAt(Object userId, String deviceType) 注销指定用户所指定的类型的所有设备
static void	logoutAt(Object userId, String deviceType, String deviceId) 注销指定用户所指定的类型和id的设备
static void	logoutById(Object userId, String id) 退出指定用户指定登录标识的设备
static void	logoutById(String id) 退出当前用户指定登录标识的设备
static IssueToken	refreshToken(String refreshToken) access过期刷新接口。
static void	removeDenyDevice(Object userId, String deviceType) 移除封禁
static void	removeDenyDevice(Object userId, String deviceType, String deviceId) 移除封禁
static void	removeDenyIP(String ip) 移除封禁
static void	removeDenyIPRange(String ipRange) 移除封禁
static void	removeDenyUser(Object userId) 移除封禁

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

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

方法详细资料

login

@NonNull
public static IssueToken login(@NonNull
                                        Object userId)

用户登录

若线程绑定了Request，则登录成功之后会默认给请求返回Cookie
过期时间为AccessToken的过期时间，若不需要，请自行删除

参数:

userId - 用户id - 不为空

返回:

授权后的IssueToken(accessToken以及refreshToken)

login

@NonNull
public static IssueToken login(@NonNull
                                        Object userId,
                                        @NonNull
                                        String deviceType)

用户登录

若线程绑定了Request，则登录成功之后会默认给请求返回Cookie
过期时间为AccessToken的过期时间，若不需要，请自行删除

参数:

userId - 用户id - 不为空

deviceType - 设备系统类型 - 不为null 默认为user-agnet，若没有则为unknown

返回:

授权后的IssueToken(accessToken以及refreshToken)

login

@NonNull
public static IssueToken login(@NonNull
                                        Object userId,
                                        @NonNull
                                        String deviceType,
                                        @Nullable
                                        String deviceId)

用户登录

若线程绑定了Request，则登录成功之后会默认给请求返回Cookie
过期时间为AccessToken的过期时间，若不需要，请自行删除

参数:

userId - 用户id - 不为空

deviceType - 设备系统类型 - 不为空 默认为user-agnet，若没有则为unknown

deviceId - 设备id - 可为null

返回:

授权后的IssueToken(accessToken以及refreshToken)

refreshToken

@NonNull
public static IssueToken refreshToken(@NonNull
                                               String refreshToken)
                                        throws RefreshTokenExpiredException,
                                               TokenException

access过期刷新接口。 refreshToken 为一次性的，刷新之后会失效

如果使用单token，则直接使用accessToken即可，在accessToken过期时再重新登录。

使用双token时，accessToken过期时，可以利用refreshToken在此接口中刷新获得一个新的accessToken。

参数:

refreshToken - 与accessToken一起授予的refreshToken

返回:

IssueToken 刷新获得新的IssueToken(accessToken以及refreshToken)

抛出:

RefreshTokenExpiredException - refreshToken过期 RefreshTokenExpiredException

TokenException - refreshToken异常 TokenException

logout

public static void logout()
                   throws NotLoginException

注销当前用户当前设备

抛出:

NotLoginException

logout

public static void logout(@NonNull
                          String deviceType)
                   throws NotLoginException

注销当前用户所指定的类型的所有设备

参数:

deviceType - 指定设备类型

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

logout

public static void logout(@NonNull
                          String deviceType,
                          @Nullable
                          String deviceId)
                   throws NotLoginException

注销当前用户所指定的类型和id的设备

参数:

deviceType - 指定设备类型

deviceId - 指定设备id

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

logoutAll

public static void logoutAll()
                      throws NotLoginException

注销当前用户所有设备

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

logoutAllAt

public static void logoutAllAt(@NonNull
                               Object userId)

注销指定用户所有设备，建议用于管理员，如果某用户想通过自己id注销自己，建议加上参数权限判断

参数:

userId - 用户id

logoutAt

public static void logoutAt(@NonNull
                            Object userId,
                            @NonNull
                            String deviceType)

注销指定用户所指定的类型的所有设备

参数:

userId - 用户id

deviceType - 指定设备类型

logoutAt

public static void logoutAt(@NonNull
                            Object userId,
                            @NonNull
                            String deviceType,
                            @Nullable
                            String deviceId)

注销指定用户所指定的类型和id的设备

参数:

userId - 用户id

deviceType - 指定设备类型

deviceId - 指定设备id

logoutById

public static void logoutById(String id)
                       throws NotLoginException

退出当前用户指定登录标识的设备

参数:

id - 登录标识

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

logoutById

public static void logoutById(Object userId,
                              String id)

退出指定用户指定登录标识的设备

参数:

userId - 用户id

id - 登录标识

getAllUserDevices

@NonNull
public static Map<Object,List<DeviceDetails>> getAllUserDevices()

查询所有用户信息，一个map userId->设备信息列表

返回:

一个map userId->设备信息列表

getAllUserId

@NonNull
public static List<Object> getAllUserId()

返回:

所有当前有效登录用户的用户id

getDevices

@NonNull
public static List<DeviceDetails> getDevices(@NonNull
                                                      String deviceType)
                                               throws NotLoginException

当前访问用户的指定类型的所有设备

返回:

设备列表

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getDevices

@NonNull
public static List<DeviceDetails> getDevices()
                                               throws NotLoginException

当前访问用户的所有设备

返回:

设备列表

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getDevice

@Nullable
public static DeviceDetails getDevice()
                                         throws NotLoginException

当前访问用户的设备

返回:

设备列表

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getDevicesAt

@NonNull
public static List<DeviceDetails> getDevicesAt(@NonNull
                                                        Object userId)

指定用户的所有设备

返回:

设备列表

getDevicesAt

@NonNull
public static List<DeviceDetails> getDevicesAt(@NonNull
                                                        Object userId,
                                                        @NonNull
                                                        String deviceType)

指定用户的指定类型的所有设备

返回:

设备列表

getDeviceAt

@Nullable
public static DeviceDetails getDeviceAt(@NonNull
                                                  Object userId,
                                                  @NonNull
                                                  String deviceType,
                                                  @Nullable
                                                  String deviceId)

获得指定设备信息

参数:

userId - 指定userId

返回:

设备信息

addDeviceTypesTotalLimit

public static void addDeviceTypesTotalLimit(@NonNull
                                            Collection<String> types,
                                            int total)
                                     throws NotLoginException

每[一种、多种]设备类型设置[共同]的最大登录数（最小为1），超出会挤出最长时间未访问的设备。 count >= 1 or count = -1

参数:

types - deviceType

total - 数量

抛出:

NotLoginException

addDeviceTypesTotalLimitAt

public static void addDeviceTypesTotalLimitAt(@NonNull
                                              Object userId,
                                              @NonNull
                                              Collection<String> types,
                                              int total)

每[一种、多种]设备类型设置[共同]的最大登录数（最小为1），超出会挤出最长时间未访问的设备。 count >= 1 or count = -1

参数:

userId - 用户id

types - deviceType

total - 数量

getOrUpdateDeviceTypesTotalLimit

public static List<DeviceCountInfo> getOrUpdateDeviceTypesTotalLimit()
                                                              throws NotLoginException

获得当前用户 可修改的 DeviceTypesTotalLimit list count >= 1 or count = -1

抛出:

NotLoginException

getOrUpdateDeviceTypesTotalLimitAt

public static List<DeviceCountInfo> getOrUpdateDeviceTypesTotalLimitAt(@NonNull
                                                                       Object userId)

获得任意用户 可修改的 DeviceTypesTotalLimit list count >= 1 or count = -1

参数:

userId - 用户id

changeMaximumDeviceTotal

public static void changeMaximumDeviceTotal(int total)
                                     throws NotLoginException

登录设备总数默不做限制【total为-1不做限制，最小为1】，超出会挤出最长时间未访问的设备。 count >= 1

参数:

total - 总数

抛出:

NotLoginException

changeMaximumTotalDeviceAt

public static void changeMaximumTotalDeviceAt(@NonNull
                                              Object userId,
                                              int total)

登录设备总数默不做限制【total为-1不做限制，最小为1】，超出会挤出最长时间未访问的设备。 count >= 1

参数:

userId - 用户id

total - 总数

changeMaximumTotalSameTypeDevice

public static void changeMaximumTotalSameTypeDevice(int total)
                                             throws NotLoginException

同类型设备最多登录数 默认 1个【count最小为1】，超出会挤出最长时间未访问的设备。 count >= 1

参数:

total - 总数

抛出:

NotLoginException

changeMaximumTotalSameTypeDeviceAt

public static void changeMaximumTotalSameTypeDeviceAt(@NonNull
                                                      Object userId,
                                                      int count)

同类型设备最多登录数 默认 1个【count最小为1】，超出会挤出最长时间未访问的设备。 count >= 1

参数:

userId - 用户id

count - 数量

isLogin

public static boolean isLogin()

返回:

当前请求是否登录 true为登录、false为未登录

isLoginById

public static boolean isLoginById(@NonNull
                                  String id)

参数:

id - 登录标识

返回:

当前请求是否登录 true为登录、false为未登录

isLoginById

public static boolean isLoginById(@NonNull
                                  Object userId,
                                  @NonNull
                                  String id)

参数:

id - 登录标识

返回:

当前请求是否登录 true为登录、false为未登录

getHttpMeta

@NonNull
public static HttpMeta getHttpMeta()
                                     throws ThreadWebEnvironmentException

若当前线程未绑定HttpRequest。则抛出 ThreadWebEnvironmentException

返回:

获得当前请求的HttpMeta信息

抛出:

ThreadWebEnvironmentException - 线程Web环境异常

getUserAgent

@NonNull
public static UserAgent getUserAgent()
                                       throws ThreadWebEnvironmentException

返回:

获得当前请求的平台信息

抛出:

ThreadWebEnvironmentException

getPlatform

@NonNull
public static Platform getPlatform()
                                     throws ThreadWebEnvironmentException

返回:

获得当前请求的平台信息

抛出:

ThreadWebEnvironmentException

getOS

@NonNull
public static OS getOS()
                         throws ThreadWebEnvironmentException

返回:

获得当前请求的操作系统

抛出:

ThreadWebEnvironmentException

getToken

@NonNull
public static AccessToken getToken()
                                     throws NotLoginException

返回:

获得当前请求的Token信息

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getUserId

@NonNull
public static Object getUserId()
                                 throws NotLoginException

返回:

获得当前请求的userId

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getDeviceType

@NonNull
public static String getDeviceType()
                                     throws NotLoginException

返回:

获得当前请求的deviceType

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getDeviceId

@Nullable
public static String getDeviceId()
                                    throws NotLoginException

返回:

获得当前请求的deviceId

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

getClientId

@Nullable
public static String getClientId()
                                    throws NotLoginException

返回:

获得当前请求的clientId

抛出:

NotLoginException - 若未登录，抛出 NotLoginException

hasRole

public static boolean hasRole(@NonNull
                              String... role)

参数:

role - 所指定的角色

返回:

判断当前请求用户是否有指定角色 若未登录返回false

hasRoles

public static boolean hasRoles(@NonNull
                               List<String> roles)

参数:

roles - 所指定的角色

返回:

判断当前请求用户是否有指定角色 若未登录返回false

hasPermission

public static boolean hasPermission(@NonNull
                                    String... permission)

参数:

permission - 所指定的权限

返回:

判断当前请求用户是否有指定角色 若未登录返回false

hasPermissions

public static boolean hasPermissions(@NonNull
                                     List<String> permissions)

参数:

permissions - 所指定的权限

返回:

判断当前请求用户是否有指定角色

hasScope

public static boolean hasScope(@NonNull
                               String... scope)

参数:

scope - 所指定的访问范围

返回:

判断当前请求用户（oauth）是否有指定的访问权限

hasScope

public static boolean hasScope(@NonNull
                               List<String> scope)

参数:

scope - 所指定的访问范围

返回:

判断当前请求用户（oauth）是否有指定的访问权限

checkUserIsActive

public static boolean checkUserIsActive(@NonNull
                                        Object userId)

判断某个用户是否有设备【在线/活跃】（默认60秒内）

参数:

userId - 用户id

返回:

用户是否在线

checkUserIsActive

public static boolean checkUserIsActive(@NonNull
                                        Object userId,
                                        @NonNull
                                        String time)

判断某个用户是否【在线/活跃】

参数:

userId - 用户id

time - 时间间隔

返回:

用户是否在线

checkUserIsActive

public static boolean checkUserIsActive(@NonNull
                                        Object userId,
                                        long ms)

判断某个用户是否【在线/活跃】

参数:

userId - 用户id

ms - 时间间隔(ms)

返回:

用户是否在线

getNumberOfActiveUser

public static int getNumberOfActiveUser()

所有【在线/活跃】（默认60秒内）用户数量

返回:

用户id列表

getNumberOfActiveUser

public static int getNumberOfActiveUser(@NonNull
                                        String time)

所有【在线/活跃】用户数量

参数:

time - 时间间隔

返回:

用户id列表

getNumberOfActiveUser

public static int getNumberOfActiveUser(long ms)

所有【在线/活跃】用户数量

参数:

ms - 时间间隔(ms)

返回:

用户id列表

getActiveUserIdList

@NonNull
public static List<Object> getActiveUserIdList()

所有【在线/活跃】（默认60秒内）用户Id数组

返回:

用户id列表

getActiveUserIdList

@NonNull
public static List<Object> getActiveUserIdList(@NonNull
                                                        String time)

所有【在线/活跃】用户Id列表

参数:

time - 时间间隔

返回:

用户id列表

getActiveUserIdList

@NonNull
public static List<Object> getActiveUserIdList(long ms)

所有【在线/活跃】用户Id列表

参数:

ms - 时间间隔(ms)

返回:

用户id列表

getActiveDevices

@NonNull
public static List<DeviceDetails> getActiveDevices()

所有【在线/活跃】用户详细设备信息 （默认60秒内）

返回:

用户设备列表

getActiveDevices

@NonNull
public static List<DeviceDetails> getActiveDevices(long ms)

所有【在线/活跃】用户详细设备信息

参数:

ms - 时间间隔(ms)

返回:

用户设备列表

getActiveDevices

@NonNull
public static List<DeviceDetails> getActiveDevices(@NonNull
                                                            String time)

所有【在线/活跃】用户详细设备信息

参数:

time - 时间字符串 "2d 3h 4m 5s 100ms"-> 2天3小时4分钟5秒100毫秒

返回:

用户设备列表

denyIP

public static void denyIP(@NonNull
                          String ip,
                          @NonNull
                          long ms)

【添加、修改】封禁 ip time时间

参数:

ip - 封禁的ip

ms - 毫秒

denyIP

public static void denyIP(@NonNull
                          String ip,
                          @NonNull
                          Date endDate)

【添加、修改】封禁 ip time时间

参数:

ip - 封禁的ip

endDate - 过期日期

denyIPRange

public static void denyIPRange(@NonNull
                               String ipRange,
                               @NonNull
                               long ms)

【添加、修改】封禁 ipRange网段 time时间

参数:

ipRange - 封禁的ip范围 xx.xx.xx.xx/xx

ms - 毫秒

denyIPRange

public static void denyIPRange(@NonNull
                               String ipRange,
                               @NonNull
                               Date endDate)

【添加、修改】封禁 ipRange网段 time时间

参数:

ipRange - 封禁的ip范围 xx.xx.xx.xx/xx

endDate - 过期日期

denyUser

public static void denyUser(@NonNull
                            Object userId,
                            @NonNull
                            long ms)

【添加、修改】封禁 device time时间

参数:

userId - 封禁的userId

ms - 毫秒

denyUser

public static void denyUser(@NonNull
                            Object userId,
                            @NonNull
                            Date endDate)

【添加、修改】封禁 device time时间

参数:

userId - 封禁的userId

endDate - 过期日期

denyDevice

public static void denyDevice(@NonNull
                              Object userId,
                              @NonNull
                              String deviceType,
                              @NonNull
                              long ms)

【添加、修改】封禁 封禁 time时间

参数:

userId - 封禁的userId

deviceType - 封禁的设备类型

ms - 毫秒

denyDevice

public static void denyDevice(@NonNull
                              Object userId,
                              @NonNull
                              String deviceType,
                              @NonNull
                              Date endDate)

【添加、修改】封禁 封禁 time时间

参数:

userId - 封禁的userId

deviceType - 封禁的设备类型

endDate - 过期日期

denyDevice

public static void denyDevice(@NonNull
                              Object userId,
                              @NonNull
                              String deviceType,
                              @Nullable
                              String deviceId,
                              @NonNull
                              long ms)

【添加、修改】封禁 设备 time时间

参数:

userId - 封禁的userId

deviceType - 封禁的设备类型

deviceId - 封禁的设备id

ms - 毫秒

denyDevice

public static void denyDevice(@NonNull
                              Object userId,
                              @NonNull
                              String deviceType,
                              @Nullable
                              String deviceId,
                              @NonNull
                              Date endDate)

【添加、修改】封禁 设备 time时间

参数:

userId - 封禁的userId

deviceType - 封禁的设备类型

deviceId - 封禁的设备id

endDate - 过期日期

getAllDenyIPInfo

@NonNull
public static Set<Blacklist.IP> getAllDenyIPInfo()

得到所有的 封禁的ip信息

返回:

得到所有的 封禁的ip信息

getDenyIPInfo

@Nullable
public static Blacklist.IP getDenyIPInfo(String ip)

返回:

得到封禁的ip信息

getAllDenyIPRangeInfo

@NonNull
public static Set<Blacklist.IPRangeDeny> getAllDenyIPRangeInfo()

返回:

得到封禁的iprange信息

getAllDenyUserInfo

@NonNull
public static Set<Blacklist.User> getAllDenyUserInfo()

返回:

获得封禁用户的信息

getDenyUserAndDeviceInfo

@NonNull
public static Set<Blacklist.User> getDenyUserAndDeviceInfo(@NonNull
                                                                    Object userId)

参数:

userId - 指定用户id

返回:

获得指定的封禁用户的信息

getDenyUserInfo

@Nullable
public static Blacklist.User getDenyUserInfo(@NonNull
                                                       Object userId)

参数:

userId - 指定用户id

返回:

获得指定的封禁用户的信息

getDenyDeviceInfo

@Nullable
public static Blacklist.User getDenyDeviceInfo(@NonNull
                                                         Object userId,
                                                         @NonNull
                                                         String deviceType,
                                                         @Nullable
                                                         String deviceId)

参数:

userId - 指定用户id

deviceType - 指定设备deviceType

deviceId - 指定设备deviceId

返回:

封禁信息

removeDenyIP

public static void removeDenyIP(@NonNull
                                String ip)

移除封禁

参数:

ip - ip

removeDenyIPRange

public static void removeDenyIPRange(@NonNull
                                     String ipRange)

移除封禁

参数:

ipRange - ip范围

removeDenyUser

public static void removeDenyUser(@NonNull
                                  Object userId)

移除封禁

参数:

userId - 指定用户

removeDenyDevice

public static void removeDenyDevice(@NonNull
                                    Object userId,
                                    @NonNull
                                    String deviceType)

移除封禁

参数:

userId - 指定用户

deviceType - 指定设备类型

removeDenyDevice

public static void removeDenyDevice(@NonNull
                                    Object userId,
                                    @NonNull
                                    String deviceType,
                                    @NonNull
                                    String deviceId)

移除封禁

参数:

userId - 指定用户

deviceType - 指定设备类型

deviceId - 指定设备id

authzModify

@Nullable
public static Object authzModify(@NonNull
                                           AuthzModifier authzModifier)