cn.dev33.satoken.solon.integration

Class SaTokenFilter

java.lang.Object

cn.dev33.satoken.solon.integration.SaTokenFilter

All Implemented Interfaces:

cn.dev33.satoken.filter.SaFilter, org.noear.solon.core.handle.Filter

public class SaTokenFilter
extends Object
implements cn.dev33.satoken.filter.SaFilter, org.noear.solon.core.handle.Filter

sa-token 基于路由的过滤式鉴权（增加了注解的处理）；使用优先级要低些 对静态文件有处理效果 order: -100 (SaTokenInterceptor 和 SaTokenFilter 二选一；不要同时用)

Since:

1.10

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
cn.dev33.satoken.filter.SaFilterAuthStrategy	auth 认证函数：每次请求执行
cn.dev33.satoken.filter.SaFilterAuthStrategy	beforeAuth 前置函数：在每次[认证函数]之前执行 注意点：前置认证函数将不受 includeList 与 excludeList 的限制，所有路由的请求都会进入 beforeAuth
cn.dev33.satoken.filter.SaFilterErrorStrategy	error 异常处理函数：每次[认证函数]发生异常时执行此函数
List<String>	excludeList 放行路由
List<String>	includeList 拦截路由
boolean	isAnnotation 是否打开注解鉴权

Constructor Summary

Constructors

Constructor and Description
SaTokenFilter()

Method Summary

Modifier and Type	Method and Description
SaTokenFilter	addExclude(String... paths)
SaTokenFilter	addInclude(String... paths)
void	doFilter(org.noear.solon.core.handle.Context ctx, org.noear.solon.core.handle.FilterChain chain)
List<String>	getExcludeList() 获取 [放行路由] 集合
List<String>	getIncludeList() 获取 [拦截路由] 集合
SaTokenFilter	setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth)
SaTokenFilter	setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth)
SaTokenFilter	setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error)
SaTokenFilter	setExcludeList(List<String> pathList)
SaTokenFilter	setIncludeList(List<String> pathList)

Methods inherited from class java.lang.Object

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

Field Detail

isAnnotation

public boolean isAnnotation

是否打开注解鉴权

includeList

public List<String> includeList

拦截路由

excludeList

public List<String> excludeList

放行路由

auth

public cn.dev33.satoken.filter.SaFilterAuthStrategy auth

认证函数：每次请求执行

error

public cn.dev33.satoken.filter.SaFilterErrorStrategy error

异常处理函数：每次[认证函数]发生异常时执行此函数

beforeAuth

public cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth

前置函数：在每次[认证函数]之前执行 注意点：前置认证函数将不受 includeList 与 excludeList 的限制，所有路由的请求都会进入 beforeAuth

Constructor Detail

SaTokenFilter

public SaTokenFilter()

Method Detail

addInclude

public SaTokenFilter addInclude(String... paths)

Specified by:

addInclude in interface cn.dev33.satoken.filter.SaFilter

addExclude

public SaTokenFilter addExclude(String... paths)

Specified by:

addExclude in interface cn.dev33.satoken.filter.SaFilter

setIncludeList

public SaTokenFilter setIncludeList(List<String> pathList)

Specified by:

setIncludeList in interface cn.dev33.satoken.filter.SaFilter

setExcludeList

public SaTokenFilter setExcludeList(List<String> pathList)

Specified by:

setExcludeList in interface cn.dev33.satoken.filter.SaFilter

getIncludeList

public List<String> getIncludeList()

获取 [拦截路由] 集合

Returns:

see note

getExcludeList

public List<String> getExcludeList()

获取 [放行路由] 集合

Returns:

see note

setAuth

public SaTokenFilter setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth)

Specified by:

setAuth in interface cn.dev33.satoken.filter.SaFilter

setError

public SaTokenFilter setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error)

Specified by:

setError in interface cn.dev33.satoken.filter.SaFilter

setBeforeAuth

public SaTokenFilter setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth)

Specified by:

setBeforeAuth in interface cn.dev33.satoken.filter.SaFilter

doFilter

public void doFilter(org.noear.solon.core.handle.Context ctx,
                     org.noear.solon.core.handle.FilterChain chain)
              throws Throwable

Specified by:

doFilter in interface org.noear.solon.core.handle.Filter

Throws:

Throwable