Package club.zhcs.lina.auth.service

Class HttpServletAuthService

java.lang.Object

club.zhcs.lina.auth.service.HttpServletAuthService

All Implemented Interfaces:

AuthService

Direct Known Subclasses:

DefaultAuthService

public abstract class HttpServletAuthService
extends Object
implements AuthService

Author:

Kerbores(kerbores@riemann.tech)

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	TOKEN_EXPIRED

Constructor Summary

Constructors

Constructor	Description
HttpServletAuthService()

Method Summary

Modifier and Type	Method	Description
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()	获取用户名

Methods inherited from class java.lang.Object

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

Methods inherited from interface club.zhcs.lina.auth.service.AuthService

permissions, roles

Field Details

TOKEN_EXPIRED

protected static final String TOKEN_EXPIRED

See Also:

• Constant Field Values

Constructor Details

HttpServletAuthService

public HttpServletAuthService()

Method Details

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 设置

Returns:

subject

public String subject(String token)

Description copied from interface: AuthService

根据token获取subject信息

Specified by:

subject in interface AuthService

Parameters:

token -

Returns:

See Also:

• AuthService.subject(java.lang.String)

token

public String token(String subject)

Description copied from interface: AuthService

生成token

Specified by:

token in interface AuthService

Parameters:

subject -

Returns:

See Also:

• AuthService.token(java.lang.String)

refreshToken

public String refreshToken(String subject)

Description copied from interface: AuthService

生成refreshToken

Specified by:

refreshToken in interface AuthService

Parameters:

subject -

Returns:

See Also:

• AuthService.refreshToken(java.lang.String)

login

public AuthUser login(AuthUser user)

Description copied from interface: AuthService

用户登录

Specified by:

login in interface AuthService

Parameters:

user -

Returns:

See Also:

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

logout

public void logout()

Description copied from interface: AuthService

登出

Specified by:

logout in interface AuthService

See Also:

• AuthService.logout()

user

public AuthUser user()

Description copied from interface: AuthService

获取当前登录用户

Specified by:

user in interface AuthService

Returns:

See Also:

• AuthService.user()

userName

public String userName()

Description copied from interface: AuthService

获取用户名

Specified by:

userName in interface AuthService

Returns:

See Also:

• AuthService.userName()

tryRefreshToken

public AuthUser tryRefreshToken(String refreshToken)

Parameters:

refreshToken -

Returns:

addCookie

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

添加cookie

Parameters:

name - 名称

value - 值

age - 有效期(分钟)

authentication

public boolean authentication(List<String> withoutAuthenticationUrlRegulars)

Description copied from interface: AuthService

鉴权

Specified by:

authentication in interface AuthService

Parameters:

withoutAuthenticationUrlRegulars -

Returns:

See Also:

• AuthService.authentication(java.util.List)

pass

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

Parameters:

uri -

withoutAuthenticationUrlRegulars -

Returns:

skip

public boolean skip()

Returns:

authorizationHeaderKey

public String authorizationHeaderKey()

认证头key

Returns:

tokenKey

public String tokenKey()

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

Returns:

refreshTokenKey

public String refreshTokenKey()

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

Returns:

token

public String token()

Description copied from interface: AuthService

获取token

Specified by:

token in interface AuthService

Returns:

See Also:

• AuthService.token()

refreshToken

public String refreshToken()

Description copied from interface: AuthService

获取 refresh token

Specified by:

refreshToken in interface AuthService

Returns:

See Also:

• AuthService.refreshToken()

optionalUser

public Optional<AuthUser> optionalUser()

Description copied from interface: AuthService

尝试获取当前用户

Specified by:

optionalUser in interface AuthService

Returns:

See Also:

• AuthService.optionalUser()