SaTokenContext (sa-token-core 1.45.0 API)

All Known Subinterfaces:: SaTokenContextForReadOnly

All Known Implementing Classes:: SaTokenContextDefaultImpl, SaTokenContextForThreadLocal

public interface SaTokenContext

Sa-Token 上下文处理器

上下文处理器封装了当前应用环境的底层操作，是 Sa-Token 对接不同 web 框架的关键，详细可参考在线文档 “自定义 SaTokenContext 指南”章节

Since:: 1.16.0
Author:: click33

Method Summary

Modifier and Type

Method

Description

void

clearContext()

清除化上下文

SaTokenContextModelBox

getModelBox()

获取 Box 对象

default SaRequest

getRequest()

获取当前上下文的 Request 包装对象

default SaResponse

getResponse()

获取当前上下文的 Response 包装对象

default SaStorage

getStorage()

获取当前上下文的 Storage 包装对象

boolean

isValid()

判断当前上下文是否可用

void

setContext(SaRequest req, SaResponse res, SaStorage stg)

初始化上下文

Method Details
- setContext
  
  void setContext(SaRequest req, SaResponse res, SaStorage stg)
  
  初始化上下文
  
  Parameters:
  
  req - /
  
  res - /
  
  stg - /
- clearContext
  
  void clearContext()
  
  清除化上下文
- isValid
  
  boolean isValid()
  
  判断当前上下文是否可用
  
  Returns:
  
  /
- getModelBox
  
  SaTokenContextModelBox getModelBox()
  
  获取 Box 对象
- getRequest
  
  default SaRequest getRequest()
  
  获取当前上下文的 Request 包装对象
  Returns:
  
  /
  
  See Also:
  
  SaRequest
- getResponse
  
  default SaResponse getResponse()
  
  获取当前上下文的 Response 包装对象
  Returns:
  
  /
  
  See Also:
  
  SaResponse
- getStorage
  
  default SaStorage getStorage()
  
  获取当前上下文的 Storage 包装对象
  Returns:
  
  /
  
  See Also:
  
  SaStorage