Module bus.auth
Package org.miaixz.bus.auth.metric.jwt

Interface JWTRegister<T extends JWTRegister<T>>

Type Parameters:
T - 实现此接口的类的类型
All Known Implementing Classes:
JWT, JWTPayload
public interface JWTRegister<T extends JWTRegister<T>>
注册的标准载荷（Payload）声明
Since:
Java 17+
Author:
Kimi Liu

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    AUDIENCE
    接收jwt的一方
    static final String
    EXPIRES_AT
    jwt的过期时间，这个过期时间必须要大于签发时间
    static final String
    ISSUED_AT
    jwt的签发时间
    static final String
    ISSUER
    jwt签发者
    static final String
    JWT_ID
    jwt的唯一身份标识，主要用来作为一次性token,从而回避重放攻击。
    static final String
    NOT_BEFORE
    生效时间，定义在什么时间之前，该jwt都是不可用的.
    static final String
    SUBJECT
    jwt所面向的用户

  • Method Summary

    Modifier and Type
    Method
    Description
    default T
    setAudience(String... audience)
    设置接收jwt的一方("aud")的Payload值
    default T
    setExpiresAt(Date expiresAt)
    设置jwt的过期时间("exp")的Payload值，这个过期时间必须要大于签发时间
    default T
    setIssuedAt(Date issuedAt)
    设置jwt的签发时间("iat")
    default T
    setIssuer(String issuer)
    设置 jwt签发者("iss")的Payload值
    default T
    setJWTId(String jwtId)
    设置jwt的唯一身份标识("jti")
    default T
    setNotBefore(Date notBefore)
    设置不可用时间点界限("nbf")的Payload值
    T
    setPayload(String name, Object value)
    设置Payload值
    default T
    setSubject(String subject)
    设置jwt所面向的用户("sub")的Payload值

  • Field Details

  • Method Details

    • setIssuer

      default T setIssuer(String issuer)
      设置 jwt签发者("iss")的Payload值
      Parameters:
      issuer - jwt签发者
      Returns:
      this

    • setSubject

      default T setSubject(String subject)
      设置jwt所面向的用户("sub")的Payload值
      Parameters:
      subject - jwt所面向的用户
      Returns:
      this

    • setAudience

      default T setAudience(String... audience)
      设置接收jwt的一方("aud")的Payload值
      Parameters:
      audience - 接收jwt的一方
      Returns:
      this

    • setExpiresAt

      default T setExpiresAt(Date expiresAt)
      设置jwt的过期时间("exp")的Payload值，这个过期时间必须要大于签发时间
      Parameters:
      expiresAt - jwt的过期时间
      Returns:
      this
      See Also:

    • setNotBefore

      default T setNotBefore(Date notBefore)
      设置不可用时间点界限("nbf")的Payload值
      Parameters:
      notBefore - 不可用时间点界限，在这个时间点之前，jwt不可用
      Returns:
      this

    • setIssuedAt

      default T setIssuedAt(Date issuedAt)
      设置jwt的签发时间("iat")
      Parameters:
      issuedAt - 签发时间
      Returns:
      this

    • setJWTId

      default T setJWTId(String jwtId)
      设置jwt的唯一身份标识("jti")
      Parameters:
      jwtId - 唯一身份标识
      Returns:
      this

    • setPayload

      T setPayload(String name, Object value)
      设置Payload值
      Parameters:
      name - payload名
      value - payload值
      Returns:
      this