cn.dev33.satoken.solon.integration

Class SaTokenInterceptor

java.lang.Object

cn.dev33.satoken.solon.integration.SaTokenInterceptor

All Implemented Interfaces:

cn.dev33.satoken.filter.SaFilter, org.noear.solon.core.route.RouterInterceptor

public class SaTokenInterceptor
extends Object
implements cn.dev33.satoken.filter.SaFilter, org.noear.solon.core.route.RouterInterceptor

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

Since:

1.12

Author:

noear

Field Summary

Fields

Modifier and Type	Field and Description
protected cn.dev33.satoken.filter.SaFilterAuthStrategy	auth 认证函数：每次请求执行
protected cn.dev33.satoken.filter.SaFilterAuthStrategy	beforeAuth 前置函数：在每次[认证函数]之前执行
protected cn.dev33.satoken.filter.SaFilterErrorStrategy	error 异常处理函数：每次[认证函数]发生异常时执行此函数
protected List<String>	excludeList 放行路由
protected List<String>	includeList 拦截路由
boolean	isAnnotation 是否打开注解鉴权

Constructor Summary

Constructors

Constructor and Description
SaTokenInterceptor()

Method Summary

Modifier and Type	Method and Description
SaTokenInterceptor	addExclude(String... paths) 添加 [放行路由]
SaTokenInterceptor	addInclude(String... paths) 添加 [拦截路由]
void	doIntercept(org.noear.solon.core.handle.Context ctx, org.noear.solon.core.handle.Handler mainHandler, org.noear.solon.core.route.RouterInterceptorChain chain)
List<String>	getExcludeList() 获取 [放行路由] 集合
List<String>	getIncludeList() 获取 [拦截路由] 集合
SaTokenInterceptor	setAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy auth) 写入[认证函数]: 每次请求执行
SaTokenInterceptor	setBeforeAuth(cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth) 写入[前置函数]：在每次[认证函数]之前执行
SaTokenInterceptor	setError(cn.dev33.satoken.filter.SaFilterErrorStrategy error) 写入[异常处理函数]：每次[认证函数]发生异常时执行此函数
SaTokenInterceptor	setExcludeList(List<String> pathList) 写入 [放行路由] 集合
SaTokenInterceptor	setIncludeList(List<String> pathList) 写入 [拦截路由] 集合

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.noear.solon.core.route.RouterInterceptor

pathPatterns, postArguments, postResult

Field Detail

isAnnotation

public boolean isAnnotation

是否打开注解鉴权

includeList

protected List<String> includeList

拦截路由

excludeList

protected List<String> excludeList

放行路由

auth

protected cn.dev33.satoken.filter.SaFilterAuthStrategy auth

认证函数：每次请求执行

error

protected cn.dev33.satoken.filter.SaFilterErrorStrategy error

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

beforeAuth

protected cn.dev33.satoken.filter.SaFilterAuthStrategy beforeAuth

前置函数：在每次[认证函数]之前执行

Constructor Detail

SaTokenInterceptor

public SaTokenInterceptor()

Method Detail

addInclude

public SaTokenInterceptor addInclude(String... paths)

添加 [拦截路由]

Specified by:

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

Parameters:

paths - 路由

Returns:

对象自身

addExclude

public SaTokenInterceptor addExclude(String... paths)

添加 [放行路由]

Specified by:

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

Parameters:

paths - 路由

Returns:

对象自身

setIncludeList

public SaTokenInterceptor setIncludeList(List<String> pathList)

写入 [拦截路由] 集合

Specified by:

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

Parameters:

pathList - 路由集合

Returns:

对象自身

setExcludeList

public SaTokenInterceptor setExcludeList(List<String> pathList)

写入 [放行路由] 集合

Specified by:

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

Parameters:

pathList - 路由集合

Returns:

对象自身

getIncludeList

public List<String> getIncludeList()

获取 [拦截路由] 集合

Returns:

see note

getExcludeList

public List<String> getExcludeList()

获取 [放行路由] 集合

Returns:

see note

setAuth

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

写入[认证函数]: 每次请求执行

Specified by:

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

Parameters:

auth - see note

Returns:

对象自身

setError

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

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

Specified by:

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

Parameters:

error - see note

Returns:

对象自身

setBeforeAuth

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

写入[前置函数]：在每次[认证函数]之前执行

Specified by:

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

Parameters:

beforeAuth - see note

Returns:

对象自身

doIntercept

public void doIntercept(org.noear.solon.core.handle.Context ctx,
                        org.noear.solon.core.handle.Handler mainHandler,
                        org.noear.solon.core.route.RouterInterceptorChain chain)
                 throws Throwable

Specified by:

doIntercept in interface org.noear.solon.core.route.RouterInterceptor

Throws:

Throwable