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

类 SaSsoUtil

java.lang.Object
cn.dev33.satoken.sso.template.SaSsoUtil
public class SaSsoUtil extends Object
Sa-Token-SSO 单点登录模块 工具类
从以下版本开始:
1.30.0
作者:
click33

  • 构造器详细资料

    • SaSsoUtil

      public SaSsoUtil()

  • 方法详细资料

    • createTicket

      public static String createTicket(Object loginId, String client)
      根据 账号id 创建一个 Ticket码
      参数:
      loginId - 账号id
      client - 客户端标识
      返回:
      Ticket码

    • deleteTicket

      public static void deleteTicket(String ticket)
      删除 Ticket
      参数:
      ticket - Ticket码

    • deleteTicketIndex

      public static void deleteTicketIndex(Object loginId)
      删除 Ticket索引
      参数:
      loginId - 账号id

    • getLoginId

      public static Object getLoginId(String ticket)
      根据 Ticket码 获取账号id，如果Ticket码无效则返回null
      参数:
      ticket - Ticket码
      返回:
      账号id

    • getLoginId

      public static <T> T getLoginId(String ticket, Class<T> cs)
      根据 Ticket码 获取账号id，并转换为指定类型
      类型参数:
      T - 要转换的类型
      参数:
      ticket - Ticket码
      cs - 要转换的类型
      返回:
      账号id

    • checkTicket

      public static Object checkTicket(String ticket)
      校验 Ticket 码，获取账号id，如果此ticket是有效的，则立即删除
      参数:
      ticket - Ticket码
      返回:
      账号id

    • checkTicket

      public static Object checkTicket(String ticket, String client)
      校验ticket码，获取账号id，如果此ticket是有效的，则立即删除
      参数:
      ticket - Ticket码
      client - client 标识
      返回:
      账号id

    • getAllowUrl

      public static String getAllowUrl()
      获取：所有允许的授权回调地址，多个用逗号隔开 (不在此列表中的URL将禁止下放ticket)
      返回:
      see note

    • checkRedirectUrl

      public static void checkRedirectUrl(String url)
      校验重定向url合法性
      参数:
      url - 下放ticket的url地址

    • buildCheckTicketUrl

      public static String buildCheckTicketUrl(String ticket, String ssoLogoutCallUrl)
      构建URL：校验ticket的URL
      参数:
      ticket - ticket码
      ssoLogoutCallUrl - 单点注销时的回调URL
      返回:
      构建完毕的URL

    • registerSloCallbackUrl

      public static void registerSloCallbackUrl(Object loginId, String client, String sloCallbackUrl)
      为指定账号id注册单点注销回调URL
      参数:
      loginId - 账号id
      client - 指定客户端标识，可为null
      sloCallbackUrl - 单点注销时的回调URL

    • buildSloUrl

      public static String buildSloUrl(Object loginId)
      构建URL：单点注销URL
      参数:
      loginId - 要注销的账号id
      返回:
      单点注销URL

    • ssoLogout

      public static void ssoLogout(Object loginId)
      指定账号单点注销 (以Server方发起)
      参数:
      loginId - 指定账号

    • getData

      public static Object getData(Map<String,Object> paramMap)
      获取：查询数据
      参数:
      paramMap - 查询参数
      返回:
      查询结果

    • getData

      public static Object getData(String path, Map<String,Object> paramMap)
      根据自定义 path 查询数据 （此方法需要配置 sa-token.sso.server-url 地址）
      参数:
      path - 自定义 path
      paramMap - 查询参数
      返回:
      查询结果

    • buildServerAuthUrl

      public static String buildServerAuthUrl(String clientLoginUrl, String back)
      构建URL：Server端 单点登录地址
      参数:
      clientLoginUrl - Client端登录地址
      back - 回调路径
      返回:
      [SSO-Server端-认证地址 ]

    • buildRedirectUrl

      public static String buildRedirectUrl(Object loginId, String client, String redirect)
      构建URL：Server端向Client下放ticket的地址
      参数:
      loginId - 账号id
      client - 客户端标识
      redirect - Client端提供的重定向地址
      返回:
      see note

    • buildGetDataUrl

      public static String buildGetDataUrl(Map<String,Object> paramMap)
      构建URL：Server端 getData 地址，带签名等参数
      参数:
      paramMap - 查询参数
      返回:
      /

    • buildCustomPathUrl

      public static String buildCustomPathUrl(String path, Map<String,Object> paramMap)
      构建URL：Server 端自定义 path 地址，带签名等参数 （此方法需要配置 sa-token.sso.server-url 地址）
      参数:
      paramMap - 请求参数
      返回:
      /