索引

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|常量字段值|所有程序包|序列化表格

A

accessToken - 类中的变量 cool.scx.ext.auth.BaseAccount

认证 TOKEN

accountType - 类中的变量 cool.scx.ext.auth.BaseAccount

账号类型

add(Session...) - 类中的方法 cool.scx.ext.auth.type.SessionStore

put.

addAll(Collection<Session>) - 类中的方法 cool.scx.ext.auth.type.SessionStore

a

addThirdPartyLoginHandler(String, ThirdPartyLoginHandler<?>) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

添加一个 第三方的 loginHandler

ADMIN - enum class 中的枚举常量 cool.scx.ext.auth.type.DeviceType

后台管理

ANDROID - enum class 中的枚举常量 cool.scx.ext.auth.type.DeviceType

安卓设备

apiPerms - 类中的变量 cool.scx.ext.auth.PermsModel

api 访问权限

apiPerms() - record class中的方法 cool.scx.ext.auth.type.Perms

返回 apiPerms 记录组件的值。

ApiPerms - cool.scx.ext.auth.annotation中的Annotation Interface

权限注解

ApiPermsInterceptor - cool.scx.ext.auth中的类

拦截器 用于校验权限

ApiPermsInterceptor(BaseAuthHandler<BaseUser>) - 类的构造器 cool.scx.ext.auth.ApiPermsInterceptor

Constructor for PermsAnnotationInterceptor.

APPLE - enum class 中的枚举常量 cool.scx.ext.auth.type.DeviceType

苹果设备

AuthException - cool.scx.ext.auth.exception中的异常错误

认证异常父类

AuthException() - 异常错误的构造器 cool.scx.ext.auth.exception.AuthException

Constructor for AuthException.

AuthException(Exception) - 异常错误的构造器 cool.scx.ext.auth.exception.AuthException

Constructor for AuthException.

authHandler - 类中的变量 cool.scx.ext.auth.BaseAuthApi

a

AuthHelper - cool.scx.ext.auth中的类

AuthHelper class.

AuthHelper() - 类的构造器 cool.scx.ext.auth.AuthHelper

AuthModule - cool.scx.ext.auth中的类

OrganizationModule class.

AuthModule() - 类的构造器 cool.scx.ext.auth.AuthModule

avatar - 类中的变量 cool.scx.ext.auth.BaseUser

用户头像 id 此处存储的是 位于 uploadFile 表中的 id

avatar - 类中的变量 cool.scx.ext.auth.type.UserInfo

头像

B

BaseAccount - cool.scx.ext.auth中的类

账号表 处理登录信息用

BaseAccount() - 类的构造器 cool.scx.ext.auth.BaseAccount

BaseAuthApi<T extends BaseUser> - cool.scx.ext.auth中的类

默认认证 api 推荐使用 也可以不用此 api 但需要将 自定义 AuthHandler 的实现中的方法清空

BaseAuthApi(BaseAuthHandler<T>, BaseModelService<T>) - 类的构造器 cool.scx.ext.auth.BaseAuthApi

a

BaseAuthHandler<U extends BaseUser> - cool.scx.ext.auth中的类

Abstract BaseAuthHandler class.

BaseAuthHandler(BaseModelService<U>) - 类的构造器 cool.scx.ext.auth.BaseAuthHandler

Constructor for BaseAuthHandler.

BaseUser - cool.scx.ext.auth中的类

核心用户类

BaseUser() - 类的构造器 cool.scx.ext.auth.BaseUser

BIND_WEBSOCKET_BY_TOKEN - 类中的静态变量 cool.scx.ext.auth.AuthModule

bindWebSocketByToken(WSMessage<?>) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

根据 token 绑定 websocket

C

changeAccessToken(String, String, String) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

以密码举例 这就是修改密码

changePasswordByAdmin(String, Long) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

changePasswordByAdmin(String, Long) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

通过管理员修改用户密码 (不需要原密码)

changePasswordBySelf(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

changePasswordBySelf(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

修改当前登录用户的 密码

changeUniqueID(String, String, String) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

以密码距离 这就是修改用户名

changeUserAvatar(String) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

changeUsernameBySelf(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

changeUsernameBySelf(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

修改当前登录用户的 用户名

checkNeedChangeUserByID(Long) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

根据 id 获取 用户 和 get 的区别是返回值永远不为空且只包含 [id, password, username] 三个字段 如果对应 id 的用户未找到则抛出移除

checkNewUsername(String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

检查新用户名 (验空和是否重复)

checkNewUsername(String, Long) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

检查新用户名 (验空和是否重复)

checkPassword(String, String) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

校验密码

checkPerms() - annotation interface 中的元素 cool.scx.ext.auth.annotation.ApiPerms

是否校验权限

cool.scx.ext.auth - 程序包 cool.scx.ext.auth

cool.scx.ext.auth.annotation - 程序包 cool.scx.ext.auth.annotation

cool.scx.ext.auth.exception - 程序包 cool.scx.ext.auth.exception

cool.scx.ext.auth.type - 程序包 cool.scx.ext.auth.type

D

DeviceType - cool.scx.ext.auth.type中的Enum Class

登录设备类型

E

emailAddress - 类中的变量 cool.scx.ext.auth.BaseUser

邮箱地址

emailAddress - 类中的变量 cool.scx.ext.auth.type.UserInfo

邮箱地址

equals(Object) - record class中的方法 cool.scx.ext.auth.type.Perms

指示某个其他对象是否“等于”此对象。

F

findThirdPartyLoginHandler(String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

根据名称查找第三方的 loginHandler

G

getByLoginDevice(DeviceType) - 类中的方法 cool.scx.ext.auth.type.SessionStore

getByLoginDevice.

getByToken(String) - 类中的方法 cool.scx.ext.auth.type.SessionStore

getByToken.

getByUniqueID(String) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

getByUniqueID.

getByUserID(Long) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

根据用户 ID 获取账号

getByUserID(Long) - 类中的方法 cool.scx.ext.auth.type.SessionStore

getByUserID.

getByWebSocket(ServerWebSocket) - 类中的方法 cool.scx.ext.auth.type.SessionStore

getByWebSocket

getCurrentSession() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

getCurrentUser() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

getCurrentUser(RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

getCurrentUserByToken(String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

getCurrentUserByWebSocket(ServerWebSocket) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

getLoginUserByWebSocketID.

getDeviceTypeByHeader(RoutingContext) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

获取用户的设备

getMessage() - 异常错误中的方法 cool.scx.ext.auth.exception.AuthException

getPerms() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

getPerms(U) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

根据用户获取 权限串

getToken(RoutingContext) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

根据 设备类型自行判断 获取 token

getTokenFromCookie(RoutingContext) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

根据 cookie 获取 token

getTokenFromHeader(RoutingContext) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

根据 Header 获取 token

H

handle(RoutingContext) - 类中的方法 cool.scx.ext.auth.ScxAuthCookieHandler

hashCode() - record class中的方法 cool.scx.ext.auth.type.Perms

返回此对象的哈希代码值。

hasPerm(String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

查看当前登录用户是否有对应的权限 此处查看的一般为通用权限

I

id - 类中的变量 cool.scx.ext.auth.type.UserInfo

id

info(RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

init(Scx) - 类中的静态方法 cool.scx.ext.auth.AuthModule

initAuth.

isAdmin - 类中的变量 cool.scx.ext.auth.BaseUser

是否为超级管理员

isAdmin - 类中的变量 cool.scx.ext.auth.type.UserInfo

是否为管理员

L

loggedInClients() - 类中的方法 cool.scx.ext.auth.type.SessionStore

getAllAlreadyLoginClients.

loggedInClientTable() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

alreadyLoginClientMap.

login(String, String, RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

login(String, String, RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

loginByThirdParty(String, String, String, RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

loginByThirdParty(String, String, String, RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

loginDevice() - 类中的方法 cool.scx.ext.auth.type.Session

logout(RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

logout(RoutingContext) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

M

mergePermsModels(List<PermsModel>) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

mergePermsModels.

N

name() - 类中的方法 cool.scx.ext.auth.AuthModule

O

of(String) - enum class中的静态方法 cool.scx.ext.auth.type.DeviceType

of.

P

pageElementPerms - 类中的变量 cool.scx.ext.auth.PermsModel

前台页面元素权限 (如 输入框, 按钮 等)

pageElementPerms - 类中的变量 cool.scx.ext.auth.type.UserInfo

页面元素权限

pageElementPerms() - record class中的方法 cool.scx.ext.auth.type.Perms

返回 pageElementPerms 记录组件的值。

pagePerms - 类中的变量 cool.scx.ext.auth.PermsModel

前台页面权限

pagePerms - 类中的变量 cool.scx.ext.auth.type.UserInfo

页面权限

pagePerms() - record class中的方法 cool.scx.ext.auth.type.Perms

返回 pagePerms 记录组件的值。

password - 类中的变量 cool.scx.ext.auth.BaseUser

密码

perms - 类中的变量 cool.scx.ext.auth.PermsModel

具体业务权限 (后台用)

perms - 类中的变量 cool.scx.ext.auth.type.UserInfo

通用权限

perms() - record class中的方法 cool.scx.ext.auth.type.Perms

返回 perms 记录组件的值。

Perms - cool.scx.ext.auth.type中的Record Class

权限包装器

Perms(Set<String>, Set<String>, Set<String>, Set<String>) - record class的构造器 cool.scx.ext.auth.type.Perms

创建 Perms 记录的实例。

PermsModel - cool.scx.ext.auth中的类

若 model 需要存储权限可以继承此类 提供四个权限存储字段 权限实体类

PermsModel() - 类的构造器 cool.scx.ext.auth.PermsModel

phoneNumber - 类中的变量 cool.scx.ext.auth.BaseUser

电话号码

phoneNumber - 类中的变量 cool.scx.ext.auth.type.UserInfo

密码

preHandle(RoutingContext, ScxRouteHandler) - 类中的方法 cool.scx.ext.auth.ApiPermsInterceptor

R

readSessionFromFile() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

从文件中读取 LoginItem

removeByLoginDevice(DeviceType) - 类中的方法 cool.scx.ext.auth.type.SessionStore

removeByLoginDevice.

removeByToken(String) - 类中的方法 cool.scx.ext.auth.type.SessionStore

removeByToken.

removeByUserID(Long) - 类中的方法 cool.scx.ext.auth.type.SessionStore

removeByUserID.

removeByWebSocket(ServerWebSocket) - 类中的方法 cool.scx.ext.auth.type.SessionStore

removeByWebSocket

S

SCX_AUTH_DEVICE_KEY - 类中的静态变量 cool.scx.ext.auth.BaseAuthHandler

获取 设备 的标识字段

SCX_AUTH_TOKEN_KEY - 类中的静态变量 cool.scx.ext.auth.BaseAuthHandler

获取 token 的标识字段

SCX_SESSION_CACHE_PATH - 类中的静态变量 cool.scx.ext.auth.BaseAuthHandler

SESSION_CACHE 存储路径 默认为 AppRoot 下的 scx-session.cache 文件

ScxAuthCookieHandler - cool.scx.ext.auth中的类

ScxAuthCookieHandler class.

ScxAuthCookieHandler() - 类的构造器 cool.scx.ext.auth.ScxAuthCookieHandler

Session - cool.scx.ext.auth.type中的类

已经登录的客户端

Session(String, Long, DeviceType) - 类的构造器 cool.scx.ext.auth.type.Session

Constructor for LoggedInClient.

SESSION_STORE - 类中的变量 cool.scx.ext.auth.BaseAuthHandler

存储所有的登录的客户端

SessionStore - cool.scx.ext.auth.type中的类

AlreadyLoginClientMap class.

SessionStore() - 类的构造器 cool.scx.ext.auth.type.SessionStore

signup(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

signup(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

signup(String, String, T) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

signup.

signupByThirdParty(String, String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthApi

signupByThirdParty(String, String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

a

start(Scx) - 类中的方法 cool.scx.ext.auth.AuthModule

stop(Scx) - 类中的方法 cool.scx.ext.auth.AuthModule

T

THIRD_PARTY_LOGIN_HANDLER_MAP - 类中的变量 cool.scx.ext.auth.BaseAuthHandler

第三方登录 login handler 映射

ThirdPartyLoginHandler<T extends BaseUser> - cool.scx.ext.auth中的接口

ThirdPartyLoginHandler interface.

toBaseVo() - 异常错误中的方法 cool.scx.ext.auth.exception.AuthException

方便将异常转换为 BaseVo 以便前台识别

token() - 类中的方法 cool.scx.ext.auth.type.Session

toString() - record class中的方法 cool.scx.ext.auth.type.Perms

返回此记录的字符串表示形式。

tryGetAuthToken(RoutingContext, DeviceType) - 类中的静态方法 cool.scx.ext.auth.AuthHelper

尝试获取一个可以作为认证的 Token 具体获取方式由设备类型决定

tryLogin(String, String) - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

尝试使用 用户名和密码进行登录

tryLogin(String, String) - 接口中的方法 cool.scx.ext.auth.ThirdPartyLoginHandler

tryLogin.

U

uniqueID - 类中的变量 cool.scx.ext.auth.BaseAccount

唯一ID

UNKNOWN - enum class 中的枚举常量 cool.scx.ext.auth.type.DeviceType

未知

UnknownDeviceException - cool.scx.ext.auth.exception中的异常错误

未知设备异常

UnknownDeviceException() - 异常错误的构造器 cool.scx.ext.auth.exception.UnknownDeviceException

UnknownLoginHandlerException - cool.scx.ext.auth.exception中的异常错误

未知 登录 Handler

UnknownLoginHandlerException() - 异常错误的构造器 cool.scx.ext.auth.exception.UnknownLoginHandlerException

UnknownUserException - cool.scx.ext.auth.exception中的异常错误

未知 (未找到) 用户异常

UnknownUserException() - 异常错误的构造器 cool.scx.ext.auth.exception.UnknownUserException

userID() - 异常错误中的方法 cool.scx.ext.auth.exception.WrongPasswordException

userID() - 类中的方法 cool.scx.ext.auth.type.Session

UserInfo - cool.scx.ext.auth.type中的类

todo 如果移除此类 getUserInfo 直接返回 { user : xxx, perms : xxx } 会不会更好 ?

UserInfo(BaseUser, Perms) - 类的构造器 cool.scx.ext.auth.type.UserInfo

Constructor for ScxUserInfo.

username - 类中的变量 cool.scx.ext.auth.BaseUser

用户名 (注意 !!!

username - 类中的变量 cool.scx.ext.auth.type.UserInfo

用户名

UsernameAlreadyExistsException - cool.scx.ext.auth.exception中的异常错误

UsernameAlreadyExists class.

UsernameAlreadyExistsException() - 异常错误的构造器 cool.scx.ext.auth.exception.UsernameAlreadyExistsException

userService - 类中的变量 cool.scx.ext.auth.BaseAuthApi

a

userService - 类中的变量 cool.scx.ext.auth.BaseAuthHandler

用户

V

value() - annotation interface 中的元素 cool.scx.ext.auth.annotation.ApiPerms

权限字符串值 当为空(默认)时会以 类名称 + ":" 方法名 为值

valueOf(String) - enum class中的静态方法 cool.scx.ext.auth.type.DeviceType

Returns the enum constant of this class with the specified name.

values() - enum class中的静态方法 cool.scx.ext.auth.type.DeviceType

Returns an array containing the constants of this enum class, in the order they are declared.

W

WEBSITE - enum class 中的枚举常量 cool.scx.ext.auth.type.DeviceType

网页

webSocket - 类中的变量 cool.scx.ext.auth.type.Session

对应的 webSocket

writeSessionToFile() - 类中的方法 cool.scx.ext.auth.BaseAuthHandler

写入 LoginItem 到文件中

WrongPasswordException - cool.scx.ext.auth.exception中的异常错误

密码错误异常

WrongPasswordException() - 异常错误的构造器 cool.scx.ext.auth.exception.WrongPasswordException

Constructor for WrongPasswordException.

WrongPasswordException(Exception) - 异常错误的构造器 cool.scx.ext.auth.exception.WrongPasswordException

Constructor for WrongPasswordException.

WrongPasswordException(Long) - 异常错误的构造器 cool.scx.ext.auth.exception.WrongPasswordException

A B C D E F G H I L M N O P R S T U V W
All Classes and Interfaces|常量字段值|所有程序包|序列化表格