SaSsoConfig (sa-token-sso 1.31.1.temp API)

java.lang.Object
- cn.dev33.satoken.config.SaSsoConfig

所有已实现的接口:

java.io.Serializable
```
public class SaSsoConfig
extends java.lang.Object
implements java.io.Serializable
```
Sa-Token SSO 单点登录模块配置类 Model

作者:

kong

另请参阅:

序列化表格

字段概要

字段
限定符和类型	字段和说明
`java.lang.String`	`allowUrl` 所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
`java.lang.String`	`authUrl` 配置 Server 端单点登录授权地址
`java.lang.String`	`checkTicketUrl` 配置 Server 端的 ticket 校验地址
`java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object>`	`doLoginHandle` SSO-Server端：登录函数
`java.lang.Boolean`	`isHttp` 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo）
`java.lang.Boolean`	`isSlo` 是否打开单点注销功能
`java.util.function.Supplier<java.lang.Object>`	`notLoginView` SSO-Server端：未登录时返回的View
`java.lang.String`	`secretkey` 接口调用秘钥 (用于SSO模式三单点注销的接口通信身份校验)
`java.util.function.Function<java.lang.String,java.lang.String>`	`sendHttp` SSO-Client端：发送Http请求的处理函数
`java.lang.String`	`serverUrl` 配置 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面，用以简化各种 url 配置
`java.lang.String`	`sloUrl` 配置 Server 端单点注销地址
`java.lang.String`	`ssoLogoutCall` 配置当前 Client 端的单点注销回调URL （为空时自动获取）
`java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object>`	`ticketResultHandle` SSO-Client端：自定义校验Ticket返回值的处理逻辑（每次从认证中心获取校验Ticket的结果后调用）参数：loginId, back 返回值：返回给前端的值
`long`	`ticketTimeout` Ticket有效期 (单位: 秒)
`long`	`timestampDisparity` 接口调用时的时间戳允许的差距（单位：ms），-1代表不校验差距
`java.lang.String`	`userinfoUrl` 配置 Server 端查询 userinfo 地址

构造器概要

构造器
构造器和说明

SaSsoConfig()

构造器
构造器和说明
`SaSsoConfig()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`java.lang.String`	`getAllowUrl()`
`java.lang.String`	`getAuthUrl()`
`java.lang.String`	`getCheckTicketUrl()`
`java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object>`	`getDoLoginHandle()`
`java.lang.Boolean`	`getIsHttp()`
`java.lang.Boolean`	`getIsSlo()`
`java.util.function.Supplier<java.lang.Object>`	`getNotLoginView()`
`java.lang.String`	`getSecretkey()`
`java.util.function.Function<java.lang.String,java.lang.String>`	`getSendHttp()`
`java.lang.String`	`getServerUrl()`
`java.lang.String`	`getSloUrl()`
`java.lang.String`	`getSsoLogoutCall()`
`java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object>`	`getTicketResultHandle()`
`long`	`getTicketTimeout()`
`long`	`getTimestampDisparity()`
`java.lang.String`	`getUserinfoUrl()`
`SaSsoConfig`	`setAllow(java.lang.String... url)` 以数组形式写入允许的授权回调地址
`SaSsoConfig`	`setAllowUrl(java.lang.String allowUrl)`
`SaSsoConfig`	`setAuthUrl(java.lang.String authUrl)`
`SaSsoConfig`	`setCheckTicketUrl(java.lang.String checkTicketUrl)`
`SaSsoConfig`	`setDoLoginHandle(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> doLoginHandle)`
`SaSsoConfig`	`setIsHttp(java.lang.Boolean isHttp)`
`SaSsoConfig`	`setIsSlo(java.lang.Boolean isSlo)`
`SaSsoConfig`	`setNotLoginView(java.util.function.Supplier<java.lang.Object> notLoginView)`
`SaSsoConfig`	`setSecretkey(java.lang.String secretkey)`
`SaSsoConfig`	`setSendHttp(java.util.function.Function<java.lang.String,java.lang.String> sendHttp)`
`SaSsoConfig`	`setServerUrl(java.lang.String serverUrl)`
`SaSsoConfig`	`setSloUrl(java.lang.String sloUrl)`
`SaSsoConfig`	`setSsoLogoutCall(java.lang.String ssoLogoutCall)`
`SaSsoConfig`	`setTicketResultHandle(java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object> ticketResultHandle)`
`SaSsoConfig`	`setTicketTimeout(long ticketTimeout)`
`SaSsoConfig`	`setTimestampDisparity(long timestampDisparity)`
`SaSsoConfig`	`setUserinfoUrl(java.lang.String userinfoUrl)`
`java.lang.String`	`splicingAuthUrl()`
`java.lang.String`	`splicingCheckTicketUrl()`
`java.lang.String`	`splicingSloUrl()`
`java.lang.String`	`splicingUserinfoUrl()`
`java.lang.String`	`toString()`

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - ticketTimeout
```
public long ticketTimeout
```
    Ticket有效期 (单位: 秒)
  - allowUrl
```
public java.lang.String allowUrl
```
    所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
  - isSlo
```
public java.lang.Boolean isSlo
```
    是否打开单点注销功能
  - isHttp
```
public java.lang.Boolean isHttp
```
    是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo）
  - secretkey
```
public java.lang.String secretkey
```
    接口调用秘钥 (用于SSO模式三单点注销的接口通信身份校验)
  - authUrl
```
public java.lang.String authUrl
```
    配置 Server 端单点登录授权地址
  - checkTicketUrl
```
public java.lang.String checkTicketUrl
```
    配置 Server 端的 ticket 校验地址
  - userinfoUrl
```
public java.lang.String userinfoUrl
```
    配置 Server 端查询 userinfo 地址
  - sloUrl
```
public java.lang.String sloUrl
```
    配置 Server 端单点注销地址
  - ssoLogoutCall
```
public java.lang.String ssoLogoutCall
```
    配置当前 Client 端的单点注销回调URL （为空时自动获取）
  - serverUrl
```
public java.lang.String serverUrl
```
    配置 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面，用以简化各种 url 配置
  - timestampDisparity
```
public long timestampDisparity
```
    接口调用时的时间戳允许的差距（单位：ms），-1代表不校验差距
  - notLoginView
```
public java.util.function.Supplier<java.lang.Object> notLoginView
```
    SSO-Server端：未登录时返回的View
  - doLoginHandle
```
public java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> doLoginHandle
```
    SSO-Server端：登录函数
  - ticketResultHandle
```
public java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object> ticketResultHandle
```
    SSO-Client端：自定义校验Ticket返回值的处理逻辑（每次从认证中心获取校验Ticket的结果后调用）
    参数：loginId, back
    返回值：返回给前端的值
  - sendHttp
```
public java.util.function.Function<java.lang.String,java.lang.String> sendHttp
```
    SSO-Client端：发送Http请求的处理函数
- 构造器详细资料
  - SaSsoConfig
```
public SaSsoConfig()
```
- 方法详细资料
  - getTicketTimeout
```
public long getTicketTimeout()
```
    返回:
    
    Ticket有效期 (单位: 秒)
  - setTicketTimeout
```
public SaSsoConfig setTicketTimeout(long ticketTimeout)
```
    参数:
    
    ticketTimeout - Ticket有效期 (单位: 秒)
    
    返回:
    
    对象自身
  - getAllowUrl
```
public java.lang.String getAllowUrl()
```
    返回:
    
    所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
  - setAllowUrl
```
public SaSsoConfig setAllowUrl(java.lang.String allowUrl)
```
    参数:
    
    allowUrl - 所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
    
    返回:
    
    对象自身
  - getIsSlo
```
public java.lang.Boolean getIsSlo()
```
    返回:
    
    是否打开单点注销功能
  - setIsSlo
```
public SaSsoConfig setIsSlo(java.lang.Boolean isSlo)
```
    参数:
    
    isSlo - 是否打开单点注销功能
    
    返回:
    
    对象自身
  - getIsHttp
```
public java.lang.Boolean getIsHttp()
```
    返回:
    
    isHttp 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo）
  - setIsHttp
```
public SaSsoConfig setIsHttp(java.lang.Boolean isHttp)
```
    参数:
    
    isHttp - 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、获取userinfo）
    
    返回:
    
    对象自身
  - getSecretkey
```
public java.lang.String getSecretkey()
```
    返回:
    
    接口调用秘钥 (用于SSO模式三单点注销的接口通信身份校验)
  - setSecretkey
```
public SaSsoConfig setSecretkey(java.lang.String secretkey)
```
    参数:
    
    secretkey - 接口调用秘钥 (用于SSO模式三单点注销的接口通信身份校验)
    
    返回:
    
    对象自身
  - getAuthUrl
```
public java.lang.String getAuthUrl()
```
    返回:
    
    配置的 Server 端单点登录授权地址
  - setAuthUrl
```
public SaSsoConfig setAuthUrl(java.lang.String authUrl)
```
    参数:
    
    authUrl - 配置 Server 端单点登录授权地址
    
    返回:
    
    对象自身
  - getCheckTicketUrl
```
public java.lang.String getCheckTicketUrl()
```
    返回:
    
    配置的 Server 端的 ticket 校验地址
  - setCheckTicketUrl
```
public SaSsoConfig setCheckTicketUrl(java.lang.String checkTicketUrl)
```
    参数:
    
    checkTicketUrl - 配置 Server 端的 ticket 校验地址
    
    返回:
    
    对象自身
  - getUserinfoUrl
```
public java.lang.String getUserinfoUrl()
```
    返回:
    
    配置的 Server 端查询 userinfo 地址
  - setUserinfoUrl
```
public SaSsoConfig setUserinfoUrl(java.lang.String userinfoUrl)
```
    参数:
    
    userinfoUrl - 配置 Server 端查询 userinfo 地址
    
    返回:
    
    对象自身
  - getSloUrl
```
public java.lang.String getSloUrl()
```
    返回:
    
    配置 Server 端单点注销地址
  - setSloUrl
```
public SaSsoConfig setSloUrl(java.lang.String sloUrl)
```
    参数:
    
    sloUrl - 配置 Server 端单点注销地址
    
    返回:
    
    对象自身
  - getSsoLogoutCall
```
public java.lang.String getSsoLogoutCall()
```
    返回:
    
    配置当前 Client 端的单点注销回调URL （为空时自动获取）
  - setSsoLogoutCall
```
public SaSsoConfig setSsoLogoutCall(java.lang.String ssoLogoutCall)
```
    参数:
    
    ssoLogoutCall - 配置当前 Client 端的单点注销回调URL （为空时自动获取）
    
    返回:
    
    对象自身
  - getServerUrl
```
public java.lang.String getServerUrl()
```
    返回:
    
    配置的 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面，用以简化各种 url 配置
  - setServerUrl
```
public SaSsoConfig setServerUrl(java.lang.String serverUrl)
```
    参数:
    
    serverUrl - 配置 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、userinfoUrl、sloUrl 属性前面，用以简化各种 url 配置
    
    返回:
    
    对象自身
  - getTimestampDisparity
```
public long getTimestampDisparity()
```
    返回:
    
    接口调用时的时间戳允许的差距（单位：ms），-1代表不校验差距
  - setTimestampDisparity
```
public SaSsoConfig setTimestampDisparity(long timestampDisparity)
```
    参数:
    
    timestampDisparity - 接口调用时的时间戳允许的差距（单位：ms），-1代表不校验差距
    
    返回:
    
    对象自身
  - toString
```
public java.lang.String toString()
```
    覆盖:
    
    toString 在类中 java.lang.Object
  - splicingAuthUrl
```
public java.lang.String splicingAuthUrl()
```
    返回:
    
    获取拼接url：Server 端单点登录授权地址
  - splicingCheckTicketUrl
```
public java.lang.String splicingCheckTicketUrl()
```
    返回:
    
    获取拼接url：Server 端的 ticket 校验地址
  - splicingUserinfoUrl
```
public java.lang.String splicingUserinfoUrl()
```
    返回:
    
    获取拼接url：Server 端查询 userinfo 地址
  - splicingSloUrl
```
public java.lang.String splicingSloUrl()
```
    返回:
    
    获取拼接url：Server 端单点注销地址
  - setAllow
```
public SaSsoConfig setAllow(java.lang.String... url)
```
    以数组形式写入允许的授权回调地址
    
    参数:
    
    url - 所有集合
    
    返回:
    
    对象自身
  - setNotLoginView
```
public SaSsoConfig setNotLoginView(java.util.function.Supplier<java.lang.Object> notLoginView)
```
    参数:
    
    notLoginView - SSO-Server端：未登录时返回的View
    
    返回:
    
    对象自身
  - getNotLoginView
```
public java.util.function.Supplier<java.lang.Object> getNotLoginView()
```
    返回:
    
    函数 SSO-Server端：未登录时返回的View
  - setDoLoginHandle
```
public SaSsoConfig setDoLoginHandle(java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> doLoginHandle)
```
    参数:
    
    doLoginHandle - SSO-Server端：登录函数
    
    返回:
    
    对象自身
  - getDoLoginHandle
```
public java.util.function.BiFunction<java.lang.String,java.lang.String,java.lang.Object> getDoLoginHandle()
```
    返回:
    
    函数 SSO-Server端：登录函数
  - setTicketResultHandle
```
public SaSsoConfig setTicketResultHandle(java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object> ticketResultHandle)
```
    参数:
    
    ticketResultHandle - SSO-Client端：自定义校验Ticket返回值的处理逻辑（每次从认证中心获取校验Ticket的结果后调用）
    
    返回:
    
    对象自身
  - getTicketResultHandle
```
public java.util.function.BiFunction<java.lang.Object,java.lang.String,java.lang.Object> getTicketResultHandle()
```
    返回:
    
    函数 SSO-Client端：自定义校验Ticket返回值的处理逻辑（每次从认证中心获取校验Ticket的结果后调用）
  - setSendHttp
```
public SaSsoConfig setSendHttp(java.util.function.Function<java.lang.String,java.lang.String> sendHttp)
```
    参数:
    
    sendHttp - SSO-Client端：发送Http请求的处理函数
    
    返回:
    
    对象自身
  - getSendHttp
```
public java.util.function.Function<java.lang.String,java.lang.String> getSendHttp()
```
    返回:
    
    函数 SSO-Client端：发送Http请求的处理函数

类 SaSsoConfig

字段概要

构造器概要

方法概要

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

字段详细资料

ticketTimeout

allowUrl

isSlo

isHttp

secretkey

authUrl

checkTicketUrl

userinfoUrl

sloUrl

ssoLogoutCall

serverUrl

timestampDisparity

notLoginView

doLoginHandle

ticketResultHandle

sendHttp

构造器详细资料

SaSsoConfig

方法详细资料

getTicketTimeout

setTicketTimeout

getAllowUrl

setAllowUrl

getIsSlo

setIsSlo

getIsHttp

setIsHttp

getSecretkey

setSecretkey

getAuthUrl

setAuthUrl

getCheckTicketUrl

setCheckTicketUrl

getUserinfoUrl

setUserinfoUrl

getSloUrl

setSloUrl

getSsoLogoutCall

setSsoLogoutCall

getServerUrl

setServerUrl

getTimestampDisparity

setTimestampDisparity

toString

splicingAuthUrl

splicingCheckTicketUrl

splicingUserinfoUrl

splicingSloUrl

setAllow

setNotLoginView

getNotLoginView

setDoLoginHandle

getDoLoginHandle

setTicketResultHandle

getTicketResultHandle

setSendHttp

getSendHttp