io.jsonwebtoken

Class Jwts

java.lang.Object

io.jsonwebtoken.Jwts

public final class Jwts
extends Object

Factory class useful for creating instances of JWT interfaces. Using this factory class can be a good alternative to tightly coupling your code to implementation classes.

Since:

0.1

Method Summary

Methods

Modifier and Type	Method and Description
static JwtBuilder	builder() Returns a new JwtBuilder instance that can be configured and then used to create JWT compact serialized strings.
static Claims	claims() Returns a new Claims instance to be used as a JWT body.
static Claims	claims(Map<String,Object> claims) Returns a new Claims instance populated with the specified name/value pairs.
static Header	header() Creates a new Header instance suitable for plaintext (not digitally signed) JWTs.
static Header	header(Map<String,Object> header) Creates a new Header instance suitable for plaintext (not digitally signed) JWTs, populated with the specified name/value pairs.
static JwsHeader	jwsHeader() Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's).
static JwsHeader	jwsHeader(Map<String,Object> header) Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's), populated with the specified name/value pairs.
static JwtParser	parser() Returns a new JwtParser instance that can be configured and then used to parse JWT strings.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

header

public static Header header()

Creates a new Header instance suitable for plaintext (not digitally signed) JWTs. As this is a less common use of JWTs, consider using the jwsHeader() factory method instead if you will later digitally sign the JWT.

Returns:

a new Header instance suitable for plaintext (not digitally signed) JWTs.

header

public static Header header(Map<String,Object> header)

Creates a new Header instance suitable for plaintext (not digitally signed) JWTs, populated with the specified name/value pairs. As this is a less common use of JWTs, consider using the jwsHeader(java.util.Map) factory method instead if you will later digitally sign the JWT.

Returns:

a new Header instance suitable for plaintext (not digitally signed) JWTs.

jwsHeader

public static JwsHeader jwsHeader()

Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's).

Returns:

a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's).

See Also:

JwtBuilder.setHeader(Header)

jwsHeader

public static JwsHeader jwsHeader(Map<String,Object> header)

Returns a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's), populated with the specified name/value pairs.

Returns:

a new JwsHeader instance suitable for digitally signed JWTs (aka 'JWS's), populated with the specified name/value pairs.

See Also:

JwtBuilder.setHeader(Header)

claims

public static Claims claims()

Returns a new Claims instance to be used as a JWT body.

Returns:

a new Claims instance to be used as a JWT body.

claims

public static Claims claims(Map<String,Object> claims)

Returns a new Claims instance populated with the specified name/value pairs.

Parameters:

claims - the name/value pairs to populate the new Claims instance.

Returns:

a new Claims instance populated with the specified name/value pairs.

parser

public static JwtParser parser()

Returns a new JwtParser instance that can be configured and then used to parse JWT strings.

Returns:

a new JwtParser instance that can be configured and then used to parse JWT strings.

builder

public static JwtBuilder builder()

Returns a new JwtBuilder instance that can be configured and then used to create JWT compact serialized strings.

Returns:

a new JwtBuilder instance that can be configured and then used to create JWT compact serialized strings.