top.cenze.utils.plugins

类 ApiPlugin

java.lang.Object

top.cenze.utils.plugins.ApiPlugin

直接已知子类:

ApiAuthAspect

public abstract class ApiPlugin
extends Object

字段概要

字段

限定符和类型	字段和说明
private static String	API_ACCESS_PREFIX 开放接口访问缓存前缀

构造器概要

构造器

构造器和说明
ApiPlugin()

方法概要

限定符和类型	方法和说明
boolean	auth(javax.servlet.http.HttpServletRequest request) 接口鉴权，返回Boolean
boolean	auth(javax.servlet.http.HttpServletRequest request, boolean isAop) 接口鉴权，返回Boolean
boolean	exceedLimitCount(javax.servlet.http.HttpServletRequest request) 是否超过访问限制次数（配置的限制次数，限制时间范围，单位分钟）
abstract ApiAuthConfig	getAccessApiAuthConfig(String key) 获取各ip访问授权配置
abstract ApiAuthConfig	getApiAuthConfig(String apiUri) 获取授权配置
abstract String	getAuthSecret(String token) 获取token的访问密码
abstract Set<String>	getOpenApiUris() 获取开放接口uri列表
boolean	isOpenIgnoreCase(String requestUri) 接口是否开放的，忽略大小写，返回Boolean（无需登录即可访问，允许三方系统直接访问）
String	isOpenStrIgnoreCase(String requestUri) 接口是否开放的，忽略大小写，返回String（无需登录即可访问，允许三方系统直接访问）
abstract void	setAccessApiAuthConfig(String key, ApiAuthConfig authConfig) 缓存各ip访问授权配置

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

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

字段详细资料

API_ACCESS_PREFIX

private static final String API_ACCESS_PREFIX

开放接口访问缓存前缀

另请参阅:

常量字段值

构造器详细资料

ApiPlugin

public ApiPlugin()

方法详细资料

isOpenStrIgnoreCase

public String isOpenStrIgnoreCase(String requestUri)

接口是否开放的，忽略大小写，返回String（无需登录即可访问，允许三方系统直接访问）

参数:

requestUri - 当前请求的uri (ServletPath)

返回:

返回第一个被请求uri包含的接口uri

isOpenIgnoreCase

public boolean isOpenIgnoreCase(String requestUri)

接口是否开放的，忽略大小写，返回Boolean（无需登录即可访问，允许三方系统直接访问）

参数:

requestUri - 当前请求的uri (ServletPath)

返回:

返回是否为开放接口，true是，false否

getOpenApiUris

public abstract Set<String> getOpenApiUris()

获取开放接口uri列表

返回:

auth

public boolean auth(javax.servlet.http.HttpServletRequest request)

接口鉴权，返回Boolean

参数:

request - servlet请求

返回:

返回鉴权结果，通过true，未通过false

auth

public boolean auth(javax.servlet.http.HttpServletRequest request,
                    boolean isAop)

接口鉴权，返回Boolean

参数:

request - servlet请求

isAop - 是否为注解切入

返回:

返回鉴权结果，通过true，未通过false

getAuthSecret

public abstract String getAuthSecret(String token)

获取token的访问密码

参数:

token -

返回:

exceedLimitCount

public boolean exceedLimitCount(javax.servlet.http.HttpServletRequest request)

是否超过访问限制次数（配置的限制次数，限制时间范围，单位分钟）

参数:

request - 访问请求 servlet请求

返回:

超过true，未超过false

getApiAuthConfig

public abstract ApiAuthConfig getApiAuthConfig(String apiUri)

获取授权配置

参数:

apiUri -

getAccessApiAuthConfig

public abstract ApiAuthConfig getAccessApiAuthConfig(String key)

获取各ip访问授权配置

参数:

key -

setAccessApiAuthConfig

public abstract void setAccessApiAuthConfig(String key,
                                            ApiAuthConfig authConfig)

缓存各ip访问授权配置

参数:

key -

authConfig -