程序包 com.xumumi.filter

接口 JwtLoginFilter

所有超级接口:
javax.servlet.Filter
所有已知实现类:
JwtLoginFilterImpl
public interface JwtLoginFilter
extends javax.servlet.Filter
JWT 登录过滤器接口
从以下版本开始:
1.9
作者:
XUMUMI

  • 方法详细资料

    • setRmbExpireTime

      void setRmbExpireTime​(long time)
      自定义记住我超时时间
      参数:
      time - 超时时长

    • setDefaultExpireTime

      void setDefaultExpireTime​(long time)
      自定义默认超时时长
      参数:
      time - 自定义 token 默认超时时长

    • setRmbValue

      void setRmbValue​(String value)
      自定义当记住我字段的值为和值时为启用记住我功能，默认值为 "true"
      参数:
      value - 字段值

    • setTokenName

      void setTokenName​(String name)
      自定义 token 名
      参数:
      name - 自定义 token 的 cookie 名

    • setRoleParameter

      void setRoleParameter​(String parameter)
      自定义角色字段名
      参数:
      parameter - 角色字段名

    • setRmbParameter

      void setRmbParameter​(String parameter)
      自定义记住我的字段名，默认值为 "remember"
      参数:
      parameter - 字段名

    • setUsernameParameter

      void setUsernameParameter​(String parameter)
      修改用户字段名
      参数:
      parameter - 字段名

    • setPasswordParameter

      void setPasswordParameter​(String parameter)
      修改密码字段名
      参数:
      parameter - 字段名

    • setClaimCallback

      void setClaimCallback​(Function<? super org.springframework.security.core.Authentication,​? extends Map<String,​String>> claim)
      自定义 token 中存放的额外信息
      参数:
      claim - 返回信息键值对的回调函数 该回调函数需要传入一个包含登录成功后的实体信息 Authentication 并生成一系列需要存入 token 的额外信息 claim 键值对表并返回

    • getCookies

      List<javax.servlet.http.Cookie> getCookies​(javax.servlet.http.HttpServletRequest request, org.springframework.security.core.Authentication authResult)
      成功时 cookies 的内容，在此基础上加入 token
      参数:
      request - 登录请求内容
      authResult - 认证成功获得的实体信息
      返回:
      cookie 列表

    • setSuccessCallback

      void setSuccessCallback​(ResultCallback<? super org.springframework.security.core.Authentication> success)
      自定义成功时返回的内容
      参数:
      success - 处理 Authentication 并返回一个可序列化对象的回调函数 该回调函数原型如下 Object success(String path, Authentication authResult) 传入的是调用页面和认证信息，返回一个可序列化的对象
      另请参阅:
      ResultCallback

    • setFailureCallback

      void setFailureCallback​(ResultCallback<? super org.springframework.security.core.AuthenticationException> failure)
      自定义失败时返回的内容
      参数:
      failure - 处理 AuthenticationException 并返回一个可序列化对象的回调函数 该回调函数原型如下 Object failure(String path, AuthenticationException exception) 传入的是调用页面和错误细节，返回一个可序列化对象
      另请参阅:
      ResultCallback

    • setCookiesCallback

      void setCookiesCallback​(CookiesCallback cookies)
      自定义成功时 cookies 的内容
      参数:
      cookies - 处理 Authentication 并返回一个 cookies 列表

    • setGuardCallback

      void setGuardCallback​(GuardCallback guard)
      自定义守卫拦截方式，比如验证码，频繁登录拦截等等
      参数:
      guard - 一个回调函数，该回调函数需要接受一个 HttpServletRequest 并对其进行分析，根据抛出异常以中断登录过程
      另请参阅:
      GuardCallback