cn.dev33.satoken.session

类 SaSession

java.lang.Object

cn.dev33.satoken.session.SaSession

所有已实现的接口:

java.io.Serializable

public class SaSession
extends java.lang.Object
implements java.io.Serializable

session会话

作者:

kong

另请参阅:

序列化表格

构造器概要

构造器

构造器和说明
SaSession() 构建一个 session对象
SaSession(java.lang.String id) 构建一个 session对象

方法概要

限定符和类型	方法和说明
void	addTokenSign(TokenSign tokenSign) 添加一个token签名
java.util.Set<java.lang.String>	attributeKeys() 返回当前session会话所有key
void	clearAttribute() 清空所有值
boolean	containsAttribute(java.lang.String key) 是否含有指定key
java.lang.Object	getAttribute(java.lang.String key) 取出一个值
java.lang.Object	getAttribute(java.lang.String key, java.lang.Object defaultValue) 取值，并指定取不到值时的默认值
long	getCreateTime() 返回当前会话创建时间
java.util.Map<java.lang.String,java.lang.Object>	getDataMap() 获取数据集合（如果更新map里的值，请调用session.update()方法避免数据过时 ）
java.lang.String	getId() 获取此会话id
TokenSign	getTokenSign(java.lang.String tokenValue) 查找一个token签名
java.util.List<TokenSign>	getTokenSignList() 返回token签名列表
void	logout() 注销会话(注销后，此session会话将不再存储服务器上)
void	logoutByTokenSignCountToZero() 如果这个token的tokenSign数量为零，则直接注销会话
void	removeAttribute(java.lang.String key) 移除一个值
void	removeTokenSign(java.lang.String tokenValue) 移除一个token签名
void	setAttribute(java.lang.String key, java.lang.Object value) 写入一个值
void	update() 将这个session从持久库更新一下

从类继承的方法 java.lang.Object

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

构造器详细资料

SaSession

public SaSession()

构建一个 session对象

SaSession

public SaSession(java.lang.String id)

构建一个 session对象

参数:

id - session的id

方法详细资料

getId

public java.lang.String getId()

获取此会话id

返回:

此会话的id

getCreateTime

public long getCreateTime()

返回当前会话创建时间

返回:

时间戳

getTokenSignList

public java.util.List<TokenSign> getTokenSignList()

返回token签名列表

返回:

token签名列表

getTokenSign

public TokenSign getTokenSign(java.lang.String tokenValue)

查找一个token签名

参数:

tokenValue - token值

返回:

查找到的tokenSign

addTokenSign

public void addTokenSign(TokenSign tokenSign)

添加一个token签名

参数:

tokenSign - token签名

removeTokenSign

public void removeTokenSign(java.lang.String tokenValue)

移除一个token签名

参数:

tokenValue - token名称

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.Object value)

写入一个值

参数:

key - 名称

value - 值

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

取出一个值

参数:

key - 名称

返回:

值

getAttribute

public java.lang.Object getAttribute(java.lang.String key,
                                     java.lang.Object defaultValue)

取值，并指定取不到值时的默认值

参数:

key - 名称

defaultValue - 取不到值的时候返回的默认值

返回:

value

removeAttribute

public void removeAttribute(java.lang.String key)

移除一个值

参数:

key - 要移除的值的名字

clearAttribute

public void clearAttribute()

清空所有值

containsAttribute

public boolean containsAttribute(java.lang.String key)

是否含有指定key

参数:

key - 是否含有指定值

返回:

是否含有

attributeKeys

public java.util.Set<java.lang.String> attributeKeys()

返回当前session会话所有key

返回:

所有值的key列表

getDataMap

public java.util.Map<java.lang.String,java.lang.Object> getDataMap()

获取数据集合（如果更新map里的值，请调用session.update()方法避免数据过时 ）

返回:

返回底层储存值的map对象

update

public void update()

将这个session从持久库更新一下

logout

public void logout()

注销会话(注销后，此session会话将不再存储服务器上)

logoutByTokenSignCountToZero

public void logoutByTokenSignCountToZero()

如果这个token的tokenSign数量为零，则直接注销会话