com.auth0.android.jwt

Class JWT

java.lang.Object

com.auth0.android.jwt.JWT

All Implemented Interfaces:

android.os.Parcelable

public class JWT
extends java.lang.Object
implements android.os.Parcelable

Wrapper class for values contained inside a Json Web Token (JWT).

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static android.os.Parcelable.Creator<JWT>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
JWT(java.lang.String token) Decode a given string JWT token.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
java.util.List<java.lang.String>	getAudience() Get the value of the "aud" claim, or an empty list if it's not available.
Claim	getClaim(java.lang.String name) Get a Claim given it's name.
java.util.Map<java.lang.String,Claim>	getClaims() Get all the Claims.
java.util.Date	getExpiresAt() Get the value of the "exp" claim, or null if it's not available.
java.util.Map<java.lang.String,java.lang.String>	getHeader() Get the Header values from this JWT as a Map of Strings.
java.lang.String	getId() Get the value of the "jti" claim, or null if it's not available.
java.util.Date	getIssuedAt() Get the value of the "iat" claim, or null if it's not available.
java.lang.String	getIssuer() Get the value of the "iss" claim, or null if it's not available.
java.util.Date	getNotBefore() Get the value of the "nbf" claim, or null if it's not available.
java.lang.String	getSignature() Get the Signature from this JWT as a Base64 encoded String.
java.lang.String	getSubject() Get the value of the "sub" claim, or null if it's not available.
boolean	isExpired(long leeway) Validates that this JWT was issued in the past and hasn't expired yet.
java.lang.String	toString() Returns the String representation of this JWT.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class java.lang.Object

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

Field Detail

CREATOR

public static final android.os.Parcelable.Creator<JWT> CREATOR

Constructor Detail

JWT

public JWT(@NonNull
           java.lang.String token)

Decode a given string JWT token.

Parameters:

token - the string JWT token.

Throws:

DecodeException - if the token cannot be decoded

Method Detail

getHeader

@NonNull
public java.util.Map<java.lang.String,java.lang.String> getHeader()

Get the Header values from this JWT as a Map of Strings.

Returns:

the Header values of the JWT.

getSignature

@NonNull
public java.lang.String getSignature()

Get the Signature from this JWT as a Base64 encoded String.

Returns:

the Signature of the JWT.

getIssuer

@Nullable
public java.lang.String getIssuer()

Get the value of the "iss" claim, or null if it's not available.

Returns:

the Issuer value or null.

getSubject

@Nullable
public java.lang.String getSubject()

Get the value of the "sub" claim, or null if it's not available.

Returns:

the Subject value or null.

getAudience

@Nullable
public java.util.List<java.lang.String> getAudience()

Get the value of the "aud" claim, or an empty list if it's not available.

Returns:

the Audience value or an empty list.

getExpiresAt

@Nullable
public java.util.Date getExpiresAt()

Get the value of the "exp" claim, or null if it's not available.

Returns:

the Expiration Time value or null.

getNotBefore

@Nullable
public java.util.Date getNotBefore()

Get the value of the "nbf" claim, or null if it's not available.

Returns:

the Not Before value or null.

getIssuedAt

@Nullable
public java.util.Date getIssuedAt()

Get the value of the "iat" claim, or null if it's not available.

Returns:

the Issued At value or null.

getId

@Nullable
public java.lang.String getId()

Get the value of the "jti" claim, or null if it's not available.

Returns:

the JWT ID value or null.

getClaim

@NonNull
public Claim getClaim(@NonNull
                               java.lang.String name)

Get a Claim given it's name. If the Claim wasn't specified in the JWT payload, a BaseClaim will be returned.

Parameters:

name - the name of the Claim to retrieve.

Returns:

a valid Claim.

getClaims

@NonNull
public java.util.Map<java.lang.String,Claim> getClaims()

Get all the Claims.

Returns:

a valid Map of Claims.

isExpired

public boolean isExpired(long leeway)

Validates that this JWT was issued in the past and hasn't expired yet.

Parameters:

leeway - the time leeway in seconds in which the token should still be considered valid.

Returns:

if this JWT has already expired or not.

toString

public java.lang.String toString()

Returns the String representation of this JWT.

Overrides:

toString in class java.lang.Object

Returns:

the String Token.

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable