Package cn.dev33.satoken.httpauth.basic

Class SaHttpBasicTemplate

java.lang.Object

cn.dev33.satoken.httpauth.basic.SaHttpBasicTemplate

public class SaHttpBasicTemplate
extends Object

Sa-Token Http Basic 认证模块

Since:

1.26.0

Author:

click33

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_REALM	默认的 Realm 领域名称

Constructor Summary

Constructors

Constructor	Description
SaHttpBasicTemplate()

Method Summary

Modifier and Type	Method	Description
void	check()	对当前会话进行 Basic 校验（使用全局配置的账号密码），校验不通过则抛出异常
void	check(String account)	对当前会话进行 Basic 校验（手动设置账号密码），校验不通过则抛出异常
void	check(String realm, String account)	对当前会话进行 Basic 校验（手动设置 Realm 和 账号密码），校验不通过则抛出异常
String	getAuthorizationValue()	获取浏览器提交的 Http Basic 参数 （裁剪掉前缀并解码）
SaHttpBasicAccount	getHttpBasicAccount()	获取 Http Basic 账号密码对象
void	throwNotBasicAuthException(String realm)	在校验失败时，设置响应头，并抛出异常

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_REALM

public static final String DEFAULT_REALM

默认的 Realm 领域名称

See Also:

• Constant Field Values

Constructor Details

SaHttpBasicTemplate

public SaHttpBasicTemplate()

Method Details

throwNotBasicAuthException

public void throwNotBasicAuthException(String realm)

在校验失败时，设置响应头，并抛出异常

Parameters:

realm - 领域

getAuthorizationValue

public String getAuthorizationValue()

获取浏览器提交的 Http Basic 参数 （裁剪掉前缀并解码）

Returns:

值

getHttpBasicAccount

public SaHttpBasicAccount getHttpBasicAccount()

获取 Http Basic 账号密码对象

Returns:

/

check

public void check()

对当前会话进行 Basic 校验（使用全局配置的账号密码），校验不通过则抛出异常

check

public void check(String account)

对当前会话进行 Basic 校验（手动设置账号密码），校验不通过则抛出异常

Parameters:

account - 账号（格式为 user:password）

check

public void check(String realm,
 String account)

对当前会话进行 Basic 校验（手动设置 Realm 和 账号密码），校验不通过则抛出异常

Parameters:

realm - 领域

account - 账号（格式为 user:password）