程序包 cn.dev33.satoken.sso.config

类 SaSsoClientConfig

java.lang.Object
cn.dev33.satoken.sso.config.SaSsoClientConfig
所有已实现的接口:
Serializable
public class SaSsoClientConfig extends Object implements Serializable
Sa-Token SSO 单点登录模块 配置类 （Client端）
从以下版本开始:
1.30.0
作者:
click33
另请参阅:

  • 字段详细资料

    • mode

      public String mode
      指定当前系统集成 SSO 时使用的模式（约定型配置项，不对代码逻辑产生任何影响）

    • client

      public String client
      当前 Client 名称标识，用于和 ticket 码的互相锁定

    • serverUrl

      public String serverUrl
      配置 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、getDataUrl、sloUrl 属性前面，用以简化各种 url 配置

    • authUrl

      public String authUrl
      单独配置 Server 端单点登录授权地址

    • checkTicketUrl

      public String checkTicketUrl
      单独配置 Server 端的 ticket 校验地址

    • getDataUrl

      public String getDataUrl
      单独配置 Server 端查询数据 getData 地址

    • sloUrl

      public String sloUrl
      单独配置 Server 端单点注销地址

    • currSsoLogin

      public String currSsoLogin
      配置当前 Client 端的登录地址（为空时自动获取）

    • currSsoLogoutCall

      public String currSsoLogoutCall
      配置当前 Client 端的单点注销回调URL （为空时自动获取）

    • isSlo

      public Boolean isSlo
      是否打开单点注销功能

    • isHttp

      public Boolean isHttp
      是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、拉取数据getData）

    • isCheckSign

      public Boolean isCheckSign
      是否校验参数签名（方便本地调试用的一个配置项，生产环境请务必为true）

    • ticketResultHandle

      public TicketResultHandleFunction ticketResultHandle
      SSO-Client端：自定义校验 ticket 返回值的处理逻辑 （每次从认证中心获取校验 ticket 的结果后调用）

      参数：loginId, back

      返回值：返回给前端的值

    • sendHttp

      public SendHttpFunction sendHttp
      SSO-Client端：发送Http请求的处理函数

  • 构造器详细资料

    • SaSsoClientConfig

      public SaSsoClientConfig()

  • 方法详细资料

    • getMode

      public String getMode()
      获取 指定当前系统集成 SSO 时使用的模式（约定型配置项，不对代码逻辑产生任何影响）
      返回:
      /

    • setMode

      public void setMode(String mode)
      设置 指定当前系统集成 SSO 时使用的模式（约定型配置项，不对代码逻辑产生任何影响）
      参数:
      mode - /

    • getIsSlo

      public Boolean getIsSlo()
      返回:
      是否打开单点注销功能

    • setIsSlo

      public SaSsoClientConfig setIsSlo(Boolean isSlo)
      参数:
      isSlo - 是否打开单点注销功能
      返回:
      对象自身

    • getIsHttp

      public Boolean getIsHttp()
      返回:
      isHttp 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、拉取数据getData）

    • setIsHttp

      public SaSsoClientConfig setIsHttp(Boolean isHttp)
      参数:
      isHttp - 是否打开模式三（此值为 true 时将使用 http 请求：校验ticket值、单点注销、拉取数据getData）
      返回:
      对象自身

    • getClient

      public String getClient()
      返回:
      当前 Client 名称标识，用于和 ticket 码的互相锁定

    • setClient

      public SaSsoClientConfig setClient(String client)
      参数:
      client - 当前 Client 名称标识，用于和 ticket 码的互相锁定

    • getAuthUrl

      public String getAuthUrl()
      返回:
      配置的 Server 端单点登录授权地址

    • setAuthUrl

      public SaSsoClientConfig setAuthUrl(String authUrl)
      参数:
      authUrl - 配置 Server 端单点登录授权地址
      返回:
      对象自身

    • getCheckTicketUrl

      public String getCheckTicketUrl()
      返回:
      配置的 Server 端的 ticket 校验地址

    • setCheckTicketUrl

      public SaSsoClientConfig setCheckTicketUrl(String checkTicketUrl)
      参数:
      checkTicketUrl - 配置 Server 端的 ticket 校验地址
      返回:
      对象自身

    • getGetDataUrl

      public String getGetDataUrl()
      返回:
      Server 端查询数据 getData 地址

    • setGetDataUrl

      public SaSsoClientConfig setGetDataUrl(String getDataUrl)
      参数:
      getDataUrl - 配置 Server 端查询数据 getData 地址
      返回:
      对象自身

    • getSloUrl

      public String getSloUrl()
      返回:
      配置 Server 端单点注销地址

    • setSloUrl

      public SaSsoClientConfig setSloUrl(String sloUrl)
      参数:
      sloUrl - 配置 Server 端单点注销地址
      返回:
      对象自身

    • getCurrSsoLogin

      public String getCurrSsoLogin()
      返回:
      配置当前 Client 端的登录地址（为空时自动获取）

    • setCurrSsoLogin

      public SaSsoClientConfig setCurrSsoLogin(String currSsoLogin)
      参数:
      currSsoLogin - 配置当前 Client 端的登录地址（为空时自动获取）
      返回:
      对象自身

    • getCurrSsoLogoutCall

      public String getCurrSsoLogoutCall()
      返回:
      配置当前 Client 端的单点注销回调URL （为空时自动获取）

    • setCurrSsoLogoutCall

      public SaSsoClientConfig setCurrSsoLogoutCall(String currSsoLogoutCall)
      参数:
      currSsoLogoutCall - 配置当前 Client 端的单点注销回调URL （为空时自动获取）
      返回:
      对象自身

    • getServerUrl

      public String getServerUrl()
      返回:
      配置的 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、getDataUrl、sloUrl 属性前面，用以简化各种 url 配置

    • setServerUrl

      public SaSsoClientConfig setServerUrl(String serverUrl)
      参数:
      serverUrl - 配置 Server 端主机总地址，拼接在 authUrl、checkTicketUrl、getDataUrl、sloUrl 属性前面，用以简化各种 url 配置
      返回:
      对象自身

    • getIsCheckSign

      public Boolean getIsCheckSign()
      获取 是否校验参数签名（方便本地调试用的一个配置项，生产环境请务必为true）
      返回:
      isCheckSign 是否校验参数签名（方便本地调试用的一个配置项，生产环境请务必为true）

    • setIsCheckSign

      public SaSsoClientConfig setIsCheckSign(Boolean isCheckSign)
      设置 是否校验参数签名（方便本地调试用的一个配置项，生产环境请务必为true）
      参数:
      isCheckSign - 是否校验参数签名（方便本地调试用的一个配置项，生产环境请务必为true）

    • toString

      public String toString()
      覆盖:
      toString 在类中 Object

    • splicingAuthUrl

      public String splicingAuthUrl()
      返回:
      获取拼接url：Server 端单点登录授权地址

    • splicingCheckTicketUrl

      public String splicingCheckTicketUrl()
      返回:
      获取拼接url：Server 端的 ticket 校验地址

    • splicingGetDataUrl

      public String splicingGetDataUrl()
      返回:
      获取拼接url：Server 端查询数据 getData 地址

    • splicingSloUrl

      public String splicingSloUrl()
      返回:
      获取拼接url：Server 端单点注销地址