类 SaSsoServerConfig

java.lang.Object
cn.dev33.satoken.sso.config.SaSsoServerConfig
所有已实现的接口:
Serializable

public class SaSsoServerConfig extends Object implements Serializable
Sa-Token SSO 单点登录模块 配置类 (Server端)
从以下版本开始:
1.38.0
作者:
click33
另请参阅:
  • 字段详细资料

    • mode

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

      public long ticketTimeout
      Ticket有效期 (单位: 秒)
    • allowUrl

      public String allowUrl
      所有允许的授权回调地址,多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
    • homeRoute

      public String homeRoute
      主页路由:在 /sso/auth 登录后不指定 redirect 参数的情况下默认跳转的路由
    • isSlo

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

      public Boolean isHttp
      是否打开模式三(此值为 true 时将使用 http 请求:校验ticket值、单点注销、获取userinfo)
    • autoRenewTimeout

      public Boolean autoRenewTimeout
      是否在每次下发 ticket 时,自动续期 token 的有效期(根据全局 timeout 值)
    • maxRegClient

      public int maxRegClient
      在 Access-Session 上记录 Client 信息的最高数量(-1=无限),超过此值将进行自动清退处理,先进先出
    • isCheckSign

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

      public NotLoginViewFunction notLoginView
      SSO-Server端:未登录时返回的View
    • doLoginHandle

      public DoLoginHandleFunction doLoginHandle
      SSO-Server端:登录函数
    • checkTicketAppendData

      public CheckTicketAppendDataFunction checkTicketAppendData
      SSO-Server端:在校验 ticket 后,给 sso-client 端追加返回信息的函数
    • sendHttp

      public SendHttpFunction sendHttp
      SSO-Server端:发送Http请求的处理函数
  • 构造器详细资料

    • SaSsoServerConfig

      public SaSsoServerConfig()
  • 方法详细资料

    • getMode

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

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

      public long getTicketTimeout()
      返回:
      Ticket有效期 (单位: 秒)
    • setTicketTimeout

      public SaSsoServerConfig setTicketTimeout(long ticketTimeout)
      参数:
      ticketTimeout - Ticket有效期 (单位: 秒)
      返回:
      对象自身
    • getAllowUrl

      public String getAllowUrl()
      返回:
      所有允许的授权回调地址,多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
    • setAllowUrl

      public SaSsoServerConfig setAllowUrl(String allowUrl)
      参数:
      allowUrl - 所有允许的授权回调地址,多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
      返回:
      对象自身
    • getHomeRoute

      public String getHomeRoute()
      返回:
      主页路由:在 /sso/auth 登录后不指定 redirect 参数的情况下默认跳转的路由
    • setHomeRoute

      public SaSsoServerConfig setHomeRoute(String homeRoute)
      参数:
      homeRoute - 主页路由:在 /sso/auth 登录后不指定 redirect 参数的情况下默认跳转的路由
      返回:
      对象自身
    • getIsSlo

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

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

      public Boolean getIsHttp()
      返回:
      isHttp 是否打开模式三(此值为 true 时将使用 http 请求:校验ticket值、单点注销、获取userinfo)
    • setIsHttp

      public SaSsoServerConfig setIsHttp(Boolean isHttp)
      参数:
      isHttp - 是否打开模式三(此值为 true 时将使用 http 请求:校验ticket值、单点注销、获取userinfo)
      返回:
      对象自身
    • getAutoRenewTimeout

      public Boolean getAutoRenewTimeout()
      返回:
      是否在每次下发 ticket 时,自动续期 token 的有效期(根据全局 timeout 值)
    • setAutoRenewTimeout

      public SaSsoServerConfig setAutoRenewTimeout(Boolean autoRenewTimeout)
      参数:
      autoRenewTimeout - 是否在每次下发 ticket 时,自动续期 token 的有效期(根据全局 timeout 值)
      返回:
      对象自身
    • getMaxRegClient

      public int getMaxRegClient()
      返回:
      maxLoginClient 在 Access-Session 上记录 Client 信息的最高数量(-1=无限),超过此值将进行自动清退处理,先进先出
    • setMaxRegClient

      public SaSsoServerConfig setMaxRegClient(int maxRegClient)
      参数:
      maxRegClient - 在 Access-Session 上记录 Client 信息的最高数量(-1=无限),超过此值将进行自动清退处理,先进先出
      返回:
      对象自身
    • getIsCheckSign

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

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

      public SaSsoServerConfig setAllow(String... url)
      以数组形式写入允许的授权回调地址
      参数:
      url - 所有集合
      返回:
      对象自身
    • toString

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