Package com.google.crypto.tink.jwt

Class RawJwt

java.lang.Object

com.google.crypto.tink.jwt.RawJwt

@Immutable
public final class RawJwt
extends java.lang.Object

An unencoded and unsigned JSON Web Token (JWT).

It contains all payload claims and a subset of the headers. It does not contain any headers that depend on the key, such as "alg" or "kid", because these headers are chosen when the token is signed and encoded, and should not be chosen by the user. This ensures that the key can be changed without any changes to the user code.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RawJwt.Builder	Builder for RawJwt

Method Summary

Modifier and Type	Method	Description
java.util.Set<java.lang.String>	customClaimNames()	Returns all custom claim names.
java.util.List<java.lang.String>	getAudiences()
java.lang.Boolean	getBooleanClaim(java.lang.String name)
java.time.Instant	getExpiration()
java.time.Instant	getIssuedAt()
java.lang.String	getIssuer()
java.lang.String	getJsonArrayClaim(java.lang.String name)
java.lang.String	getJsonObjectClaim(java.lang.String name)
java.lang.String	getJsonPayload()
java.lang.String	getJwtId()
java.time.Instant	getNotBefore()
java.lang.Double	getNumberClaim(java.lang.String name)
java.lang.String	getStringClaim(java.lang.String name)
java.lang.String	getSubject()
java.lang.String	getTypeHeader()
boolean	hasAudiences()
boolean	hasBooleanClaim(java.lang.String name)
boolean	hasExpiration()
boolean	hasIssuedAt()
boolean	hasIssuer()
boolean	hasJsonArrayClaim(java.lang.String name)
boolean	hasJsonObjectClaim(java.lang.String name)
boolean	hasJwtId()
boolean	hasNotBefore()
boolean	hasNumberClaim(java.lang.String name)
boolean	hasStringClaim(java.lang.String name)
boolean	hasSubject()
boolean	hasTypeHeader()
boolean	isNullClaim(java.lang.String name)
static RawJwt.Builder	newBuilder()	Returns a new RawJwt.Builder.
java.lang.String	toString()	Returns a brief description of a RawJwt object.

Methods inherited from class java.lang.Object

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

Method Detail

newBuilder

public static RawJwt.Builder newBuilder()

Returns a new RawJwt.Builder.

getJsonPayload

public java.lang.String getJsonPayload()

hasBooleanClaim

public boolean hasBooleanClaim(java.lang.String name)

getBooleanClaim

public java.lang.Boolean getBooleanClaim(java.lang.String name)
                                  throws JwtInvalidException

Throws:

JwtInvalidException

hasNumberClaim

public boolean hasNumberClaim(java.lang.String name)

getNumberClaim

public java.lang.Double getNumberClaim(java.lang.String name)
                                throws JwtInvalidException

Throws:

JwtInvalidException

hasStringClaim

public boolean hasStringClaim(java.lang.String name)

getStringClaim

public java.lang.String getStringClaim(java.lang.String name)
                                throws JwtInvalidException

Throws:

JwtInvalidException

isNullClaim

public boolean isNullClaim(java.lang.String name)

hasJsonObjectClaim

public boolean hasJsonObjectClaim(java.lang.String name)

getJsonObjectClaim

public java.lang.String getJsonObjectClaim(java.lang.String name)
                                    throws JwtInvalidException

Throws:

JwtInvalidException

hasJsonArrayClaim

public boolean hasJsonArrayClaim(java.lang.String name)

getJsonArrayClaim

public java.lang.String getJsonArrayClaim(java.lang.String name)
                                   throws JwtInvalidException

Throws:

JwtInvalidException

hasTypeHeader

public boolean hasTypeHeader()

getTypeHeader

public java.lang.String getTypeHeader()
                               throws JwtInvalidException

Throws:

JwtInvalidException

hasIssuer

public boolean hasIssuer()

getIssuer

public java.lang.String getIssuer()
                           throws JwtInvalidException

Throws:

JwtInvalidException

hasSubject

public boolean hasSubject()

getSubject

public java.lang.String getSubject()
                            throws JwtInvalidException

Throws:

JwtInvalidException

hasJwtId

public boolean hasJwtId()

getJwtId

public java.lang.String getJwtId()
                          throws JwtInvalidException

Throws:

JwtInvalidException

hasAudiences

public boolean hasAudiences()

getAudiences

public java.util.List<java.lang.String> getAudiences()
                                              throws JwtInvalidException

Throws:

JwtInvalidException

hasExpiration

public boolean hasExpiration()

getExpiration

public java.time.Instant getExpiration()
                                throws JwtInvalidException

Throws:

JwtInvalidException

hasNotBefore

public boolean hasNotBefore()

getNotBefore

public java.time.Instant getNotBefore()
                               throws JwtInvalidException

Throws:

JwtInvalidException

hasIssuedAt

public boolean hasIssuedAt()

getIssuedAt

public java.time.Instant getIssuedAt()
                              throws JwtInvalidException

Throws:

JwtInvalidException

customClaimNames

public java.util.Set<java.lang.String> customClaimNames()

Returns all custom claim names.

toString

public java.lang.String toString()

Returns a brief description of a RawJwt object. The exact details of the representation are unspecified and subject to change.

Overrides:

toString in class java.lang.Object