程序包 club.zhcs.lina.auth.service

类 HttpServletAuthService

java.lang.Object

club.zhcs.lina.auth.service.HttpServletAuthService

所有已实现的接口:

AuthService

直接已知子类:

DefaultAuthService

public abstract class HttpServletAuthService
extends Object
implements AuthService

作者:

Kerbores(kerbores@riemann.tech)

字段概要

字段

修饰符和类型	字段	说明
protected static final String	TOKEN_EXPIRED

构造器概要

构造器

构造器	说明
HttpServletAuthService()

方法概要

修饰符和类型	方法	说明
void	addCookie(String name, String value, int age)	添加cookie
boolean	authentication(List<String> withoutAuthenticationUrlRegulars)	鉴权
String	authorizationHeaderKey()	认证头key
abstract CookieSettings	cookieSettings()	cookie 设置
abstract jakarta.servlet.http.HttpServletRequest	getRequest()
abstract jakarta.servlet.http.HttpServletResponse	getResponse()
abstract JWTDecoder	jwtDecoder()
abstract JWTEncoder	jwtEncoder()
AuthUser	login(AuthUser user)	用户登录
void	logout()	登出
Optional<AuthUser>	optionalUser()	尝试获取当前用户
boolean	pass(String uri, List<String> withoutAuthenticationUrlRegulars)
String	refreshToken()	获取 refresh token
String	refreshToken(String subject)	生成refreshToken
String	refreshTokenKey()	refresh token key ,可以接受从header/cookie和请求参数传入
boolean	skip()
String	subject(String token)	根据token获取subject信息
String	token()	获取token
String	token(String subject)	生成token
String	tokenKey()	token key ,可以接受从header/cookie和请求参数传入
AuthUser	tryRefreshToken(String refreshToken)
AuthUser	user()	获取当前登录用户
abstract UserDetailService	userDetailService()
String	userName()	获取用户名

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

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

从接口继承的方法 club.zhcs.lina.auth.service.AuthService

permissions, roles

字段详细资料

TOKEN_EXPIRED

protected static final String TOKEN_EXPIRED

另请参阅:

• 常量字段值

构造器详细资料

HttpServletAuthService

public HttpServletAuthService()

方法详细资料

getRequest

public abstract jakarta.servlet.http.HttpServletRequest getRequest()

getResponse

public abstract jakarta.servlet.http.HttpServletResponse getResponse()

userDetailService

public abstract UserDetailService userDetailService()

jwtEncoder

public abstract JWTEncoder jwtEncoder()

jwtDecoder

public abstract JWTDecoder jwtDecoder()

cookieSettings

public abstract CookieSettings cookieSettings()

cookie 设置

返回:

subject

public String subject(String token)

从接口复制的说明: AuthService

根据token获取subject信息

指定者:

subject 在接口中 AuthService

参数:

token -

返回:

另请参阅:

• AuthService.subject(java.lang.String)

token

public String token(String subject)

从接口复制的说明: AuthService

生成token

指定者:

token 在接口中 AuthService

参数:

subject -

返回:

另请参阅:

• AuthService.token(java.lang.String)

refreshToken

public String refreshToken(String subject)

从接口复制的说明: AuthService

生成refreshToken

指定者:

refreshToken 在接口中 AuthService

参数:

subject -

返回:

另请参阅:

• AuthService.refreshToken(java.lang.String)

login

public AuthUser login(AuthUser user)

从接口复制的说明: AuthService

用户登录

指定者:

login 在接口中 AuthService

参数:

user -

返回:

另请参阅:

• AuthService.login(club.zhcs.lina.auth.service.AuthUser)

logout

public void logout()

从接口复制的说明: AuthService

登出

指定者:

logout 在接口中 AuthService

另请参阅:

• AuthService.logout()

user

public AuthUser user()

从接口复制的说明: AuthService

获取当前登录用户

指定者:

user 在接口中 AuthService

返回:

另请参阅:

• AuthService.user()

userName

public String userName()

从接口复制的说明: AuthService

获取用户名

指定者:

userName 在接口中 AuthService

返回:

另请参阅:

• AuthService.userName()

tryRefreshToken

public AuthUser tryRefreshToken(String refreshToken)

参数:

refreshToken -

返回:

addCookie

public void addCookie(String name,
 String value,
 int age)

添加cookie

参数:

name - 名称

value - 值

age - 有效期(分钟)

authentication

public boolean authentication(List<String> withoutAuthenticationUrlRegulars)

从接口复制的说明: AuthService

鉴权

指定者:

authentication 在接口中 AuthService

参数:

withoutAuthenticationUrlRegulars -

返回:

另请参阅:

• AuthService.authentication(java.util.List)

pass

public boolean pass(String uri,
 List<String> withoutAuthenticationUrlRegulars)

参数:

uri -

withoutAuthenticationUrlRegulars -

返回:

skip

public boolean skip()

返回:

authorizationHeaderKey

public String authorizationHeaderKey()

认证头key

返回:

tokenKey

public String tokenKey()

token key ,可以接受从header/cookie和请求参数传入

返回:

refreshTokenKey

public String refreshTokenKey()

refresh token key ,可以接受从header/cookie和请求参数传入

返回:

token

public String token()

从接口复制的说明: AuthService

获取token

指定者:

token 在接口中 AuthService

返回:

另请参阅:

• AuthService.token()

refreshToken

public String refreshToken()

从接口复制的说明: AuthService

获取 refresh token

指定者:

refreshToken 在接口中 AuthService

返回:

另请参阅:

• AuthService.refreshToken()

optionalUser

public Optional<AuthUser> optionalUser()

从接口复制的说明: AuthService

尝试获取当前用户

指定者:

optionalUser 在接口中 AuthService

返回:

另请参阅:

• AuthService.optionalUser()