io.jsonwebtoken

Interface Jwt<H extends Header,P>

Type Parameters:

H - the type of the JWT header

P - the type of the JWT payload, either a content byte array or a Claims instance.

All Known Subinterfaces:

Jwe<B>, Jws<P>, ProtectedJwt<H,P>

public interface Jwt<H extends Header,P>

An expanded (not compact/serialized) JSON Web Token.

Since:

0.1

Field Summary

Fields

Modifier and Type	Field and Description
static JwtVisitor<Jwt<Header,Claims>>	UNSECURED_CLAIMS Visitor implementation that ensures the visited JWT is an unsecured Claims JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.
static JwtVisitor<Jwt<Header,byte[]>>	UNSECURED_CONTENT Visitor implementation that ensures the visited JWT is an unsecured content JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	accept(JwtVisitor<T> visitor) Invokes the specified visitor's appropriate type-specific visit method based on this JWT's type.
P	getBody() Deprecated. since 0.12.0 because it has been renamed to getPayload(). 'Payload' (not body) is what the JWT specifications call this property, so it has been renamed to reflect the correct JWT nomenclature/taxonomy.
H	getHeader() Returns the JWT Header or null if not present.
P	getPayload() Returns the JWT payload, either a byte[] or a Claims instance.

Field Detail

UNSECURED_CONTENT

static final JwtVisitor<Jwt<Header,byte[]>> UNSECURED_CONTENT

Visitor implementation that ensures the visited JWT is an unsecured content JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.

Since:

0.12.0

See Also:

SupportedJwtVisitor.onUnsecuredContent(Jwt)

UNSECURED_CLAIMS

static final JwtVisitor<Jwt<Header,Claims>> UNSECURED_CLAIMS

Visitor implementation that ensures the visited JWT is an unsecured Claims JWT (one not cryptographically signed or encrypted) and rejects all others with an UnsupportedJwtException.

Since:

0.12.0

See Also:

SupportedJwtVisitor.onUnsecuredClaims(Jwt)

Method Detail

getHeader

H getHeader()

Returns the JWT Header or null if not present.

Returns:

the JWT Header or null if not present.

getBody

@Deprecated
P getBody()

Deprecated. since 0.12.0 because it has been renamed to getPayload(). 'Payload' (not body) is what the JWT specifications call this property, so it has been renamed to reflect the correct JWT nomenclature/taxonomy.

Returns the JWT payload, either a byte[] or a Claims instance. Use getPayload() instead, as this method will be removed prior to the 1.0 release.

Returns:

the JWT payload, either a byte[] or a Claims instance.

getPayload

P getPayload()

Returns the JWT payload, either a byte[] or a Claims instance. If the payload is a byte array, and if the JWT creator set the (optional) contentType header value, the application may inspect the contentType value to determine how to convert the byte array to the final content type as desired.

Returns:

the JWT payload, either a byte[] or a Claims instance.

Since:

0.12.0

accept

<T> T accept(JwtVisitor<T> visitor)

Invokes the specified visitor's appropriate type-specific visit method based on this JWT's type.

Type Parameters:

T - the value type returned from the visit method.

Parameters:

visitor - the visitor to invoke.

Returns:

the value returned from visitor's visit method implementation.