类的使用
cn.dev33.satoken.stp.parameter.SaLoginParameter

使用SaLoginParameter的程序包

程序包	说明
cn.dev33.satoken.listener
cn.dev33.satoken.stp
cn.dev33.satoken.stp.parameter

cn.dev33.satoken.listener中SaLoginParameter的使用

参数类型为SaLoginParameter的cn.dev33.satoken.listener中的方法

修饰符和类型	方法	说明
static void	SaTokenEventCenter.doLogin(String loginType, Object loginId, String tokenValue, SaLoginParameter loginParameter)	事件发布：xx 账号登录
void	SaTokenListener.doLogin(String loginType, Object loginId, String tokenValue, SaLoginParameter loginParameter)	每次登录时触发
void	SaTokenListenerForLog.doLogin(String loginType, Object loginId, String tokenValue, SaLoginParameter loginParameter)	每次登录时触发
void	SaTokenListenerForSimple.doLogin(String loginType, Object loginId, String tokenValue, SaLoginParameter loginParameter)

cn.dev33.satoken.stp中SaLoginParameter的使用

cn.dev33.satoken.stp中SaLoginParameter的子类

修饰符和类型	类	说明
class	SaLoginModel	已过时。

返回SaLoginParameter的cn.dev33.satoken.stp中的方法

修饰符和类型	方法	说明
static SaLoginParameter	SaLoginConfig.create()	已过时。 静态方法获取一个 SaLoginParameter 对象
SaLoginParameter	StpLogic.createSaLoginParameter()	根据当前配置对象创建一个 SaLoginParameter 对象
static SaLoginParameter	StpUtil.createSaLoginParameter()	根据当前配置对象创建一个 SaLoginParameter 对象
static SaLoginParameter	SaLoginConfig.setActiveTimeout(long activeTimeout)	已过时。
static SaLoginParameter	SaLoginConfig.setDevice(String device)	已过时。
static SaLoginParameter	SaLoginConfig.setExtra(String key, Object value)	已过时。 写入扩展数据（只在jwt模式下生效）
static SaLoginParameter	SaLoginConfig.setExtraData(Map<String,Object> extraData)	已过时。
static SaLoginParameter	SaLoginConfig.setIsLastingCookie(Boolean isLastingCookie)	已过时。
static SaLoginParameter	SaLoginConfig.setIsWriteHeader(Boolean isWriteHeader)	已过时。
static SaLoginParameter	SaLoginConfig.setTimeout(long timeout)	已过时。
static SaLoginParameter	SaLoginConfig.setToken(String token)	已过时。
static SaLoginParameter	SaLoginConfig.setTokenSignTag(Map<String,Object> tokenSignTag)	已过时。 设置 本次登录挂载到 TokenSign 的数据

参数类型为SaLoginParameter的cn.dev33.satoken.stp中的方法

修饰符和类型	方法	说明
protected void	StpLogic.checkLoginArgs(Object id, SaLoginParameter loginParameter)	校验登录时的参数有效性，如果有问题会打印警告或抛出异常
String	StpLogic.createLoginSession(Object id, SaLoginParameter loginParameter)	创建指定账号 id 的登录会话数据
static String	StpUtil.createLoginSession(Object id, SaLoginParameter loginParameter)	创建指定账号 id 的登录会话数据
protected String	StpLogic.distUsableToken(Object id, SaLoginParameter loginParameter)	为指定账号 id 的登录操作，分配一个可用的 token
int	StpLogic.getConfigOfMaxTryTimes(SaLoginParameter loginParameter)	返回全局配置的 maxTryTimes 值，在每次创建 token 时，对其唯一性测试的最高次数（-1=不测试）
void	StpLogic.login(Object id, SaLoginParameter loginParameter)	会话登录，并指定所有登录参数 Model
static void	StpUtil.login(Object id, SaLoginParameter loginParameter)	会话登录，并指定所有登录参数 Model
void	StpLogic.setTokenValue(String tokenValue, SaLoginParameter loginParameter)	在当前会话写入指定 token 值
static void	StpUtil.setTokenValue(String tokenValue, SaLoginParameter loginParameter)	在当前会话写入指定 token 值

cn.dev33.satoken.stp.parameter中SaLoginParameter的使用

返回SaLoginParameter的cn.dev33.satoken.stp.parameter中的方法

修饰符和类型	方法	说明
static SaLoginParameter	SaLoginParameter.create()	静态方法获取一个 SaLoginParameter 对象
SaLoginParameter	SaLoginParameter.setActiveTimeout(long activeTimeout)
SaLoginParameter	SaLoginParameter.setDefaultValues(SaTokenConfig config)	根据 SaTokenConfig 对象初始化默认值
SaLoginParameter	SaLoginParameter.setDevice(String device)	已过时。
SaLoginParameter	SaLoginParameter.setDeviceId(String deviceId)	设置 此次登录的客户端设备id
SaLoginParameter	SaLoginParameter.setDeviceType(String deviceType)
SaLoginParameter	SaLoginParameter.setExtra(String key, Object value)	写入扩展数据（只在jwt模式下生效）
SaLoginParameter	SaLoginParameter.setExtraData(Map<String,Object> extraData)
SaLoginParameter	SaLoginParameter.setIsConcurrent(Boolean isConcurrent)
SaLoginParameter	SaLoginParameter.setIsLastingCookie(Boolean isLastingCookie)
SaLoginParameter	SaLoginParameter.setIsShare(Boolean isShare)
SaLoginParameter	SaLoginParameter.setIsWriteHeader(Boolean isWriteHeader)
SaLoginParameter	SaLoginParameter.setMaxLoginCount(int maxLoginCount)
SaLoginParameter	SaLoginParameter.setMaxTryTimes(int maxTryTimes)
SaLoginParameter	SaLoginParameter.setOverflowLogoutMode(SaLogoutMode overflowLogoutMode)	设置 溢出 maxLoginCount 的客户端，将以何种方式注销下线 (LOGOUT=注销下线, KICKOUT=踢人下线, REPLACED=顶人下线)
SaLoginParameter	SaLoginParameter.setReplacedRange(SaReplacedRange replacedRange)	当 isConcurrent=false 时，顶人下线的范围 (CURR_DEVICE_TYPE=当前指定的设备类型端, ALL_DEVICE_TYPE=所有设备类型端)
SaLoginParameter	SaLoginParameter.setTerminalExtra(String key, Object value)	写入本次登录挂载到 SaTerminalInfo 的自定义扩展数据
SaLoginParameter	SaLoginParameter.setTerminalExtraData(Map<String,Object> terminalExtraData)	设置 本次登录挂载到 SaTerminalInfo 的自定义扩展数据
SaLoginParameter	SaLoginParameter.setTimeout(long timeout)
SaLoginParameter	SaLoginParameter.setToken(String token)