com.auth0.jwt

Class JWT

java.lang.Object

com.auth0.jwt.JWT

All Implemented Interfaces:

DecodedJWT, Header, Payload, Signature

public abstract class JWT
extends java.lang.Object
implements DecodedJWT

Constructor Summary

Constructors

Constructor and Description
JWT()

Method Summary

Modifier and Type	Method and Description
static JWTCreator.Builder	create() Returns a JWT builder used to create and sign jwt tokens
static JWT	decode(java.lang.String token) Decode a given JWT token.
static Verification	require(Algorithm algorithm) Returns a JWTVerifier builder with the algorithm to be used to validate token signature.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.auth0.jwt.interfaces.DecodedJWT

getToken

Methods inherited from interface com.auth0.jwt.interfaces.Payload

getAudience, getClaim, getClaims, getExpiresAt, getId, getIssuedAt, getIssuer, getNotBefore, getSubject

Methods inherited from interface com.auth0.jwt.interfaces.Header

getAlgorithm, getContentType, getHeaderClaim, getKeyId, getType

Methods inherited from interface com.auth0.jwt.interfaces.Signature

getSignature

Constructor Detail

JWT

public JWT()

Method Detail

decode

public static JWT decode(java.lang.String token)
                  throws JWTDecodeException

Decode a given JWT token.

Note that this method doesn't verify the token's signature! Use it only if you trust the token or you already verified it.

Parameters:

token - with jwt format as string.

Returns:

a decoded token.

Throws:

JWTDecodeException - if any part of the token contained an invalid jwt or JSON format of each of the jwt parts.

require

public static Verification require(Algorithm algorithm)

Returns a JWTVerifier builder with the algorithm to be used to validate token signature.

Parameters:

algorithm - that will be used to verify the token's signature.

Returns:

JWTVerifier builder

Throws:

java.lang.IllegalArgumentException - if the provided algorithm is null.

create

public static JWTCreator.Builder create()

Returns a JWT builder used to create and sign jwt tokens

Returns:

a jwt token builder.