icu.easyj.jwt

Interface JwtConstant

public interface JwtConstant

JWT常量

Author:

wangliang181230

Field Summary

Fields

Modifier and Type	Field and Description
static Date	DEFAULT_EXPIRES_AT 默认过期时间
static long	DEFAULT_LEEWAY 默认容忍时间：2秒
static String[]	JWT_SPECIAL_CLAIMS_KEYS JWT特殊声明的键值

Method Summary

Modifier and Type	Method and Description
default String	create(JwtInfo jwtInfo) 创建JWT
default String	create(String jwtId, Map<String,Object> claims) 创建JWT（永久不过期）
default String	create(String jwtId, Map<String,Object> claims, Date issuedAt) 创建JWT（永久不过期）
String	create(String jwtId, Map<String,Object> claims, Date issuedAt, Date expiresAt) 创建JWT
default String	create(String jwtId, Map<String,Object> claims, Date issuedAt, int expiredTime) 创建JWT
default String	create(String jwtId, Map<String,Object> claims, int expiredTime) 创建JWT（永久不过期）
static void	removeSpecialClaims(Map<String,Object> claims) 移除特殊声明信息
default JwtInfo	verify(String jwtStr) 解析JWT，默认容忍空间为2秒
JwtInfo	verify(String jwtStr, long leeway) 解析JWT
default JwtInfo	verify(String jwtStr, long leeway, int currentExpiredTime) 解析JWT

Field Detail

JWT_SPECIAL_CLAIMS_KEYS

static final String[] JWT_SPECIAL_CLAIMS_KEYS

JWT特殊声明的键值

DEFAULT_EXPIRES_AT

static final Date DEFAULT_EXPIRES_AT

默认过期时间

DEFAULT_LEEWAY

static final long DEFAULT_LEEWAY

默认容忍时间：2秒

See Also:

Constant Field Values

Method Detail

create

String create(String jwtId,
              Map<String,Object> claims,
              Date issuedAt,
              Date expiresAt)

创建JWT

Parameters:

jwtId - JWT的ID

claims - 私有声明

issuedAt - 签发时间

expiresAt - 过期时间，不能小于等于签发时间，为空时表示永久有效

Returns:

jwt 返回创建的JWT

create

default String create(String jwtId,
                      Map<String,Object> claims,
                      Date issuedAt,
                      int expiredTime)

创建JWT

Parameters:

jwtId - JWT的ID

claims - 私有声明

issuedAt - 签发时间

expiredTime - 过期时间，单位：秒。小于等于0时，永久有效。

Returns:

jwt 返回创建的JWT

create

default String create(JwtInfo jwtInfo)

创建JWT

Parameters:

jwtInfo - JWT信息

Returns:

jwt 返回创建的JWT

create

default String create(String jwtId,
                      Map<String,Object> claims,
                      Date issuedAt)

创建JWT（永久不过期）

Parameters:

jwtId - JWT的ID

claims - 私有声明

issuedAt - 签发时间

Returns:

jwt 返回创建的JWT

create

default String create(String jwtId,
                      Map<String,Object> claims,
                      int expiredTime)

创建JWT（永久不过期）

Parameters:

jwtId - JWT的ID

claims - 私有声明

expiredTime - 过期时间，单位：秒

Returns:

jwt 返回创建的JWT

create

default String create(String jwtId,
                      Map<String,Object> claims)

创建JWT（永久不过期）

Parameters:

jwtId - JWT的ID

claims - 私有声明

Returns:

jwt 返回创建的JWT

verify

JwtInfo verify(String jwtStr,
               long leeway)

解析JWT

Parameters:

jwtStr - JWT串

leeway - 容忍空间，单位：秒。当不能晚于当前时间时，向后容忍；不能早于向前容忍。

Returns:

jwtInfo 返回解析出的JWT信息

verify

default JwtInfo verify(String jwtStr)

解析JWT，默认容忍空间为2秒

Parameters:

jwtStr - JWT串

Returns:

jwt

verify

default JwtInfo verify(String jwtStr,
                       long leeway,
                       int currentExpiredTime)

解析JWT

Parameters:

jwtStr - JWT串

leeway - 容忍空间，单位：秒。当不能晚于当前时间时，向后容忍；不能早于向前容忍。

currentExpiredTime - 当前的过期时间，单位：秒。（作用是怕之前设置的时间过长，导致生成的JWT一直不会过期，使系统存在安全隐患。）

Returns:

jwt

removeSpecialClaims

static void removeSpecialClaims(Map<String,Object> claims)

移除特殊声明信息

Parameters:

claims - 声明