Package org.rootservices.jwt.serialization

Class JwtSerde

java.lang.Object

org.rootservices.jwt.serialization.JwtSerde

public class JwtSerde
extends java.lang.Object

A Serializer and Deserializer that converts: - a jwt as a string to a instance of a JsonWebToken. - a JsonWebToken to its string representation.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COULD_NOT_COMBINE_JWT_MEMBERS
static java.lang.String	COULD_NOT_COMBINE_SIGN_INPUTS
static java.lang.String	COULD_NOT_SERIALIZE
static java.lang.String	INVALID_JSON
int	JWE_LENGTH
int	JWS_LENGTH
int	JWT_LENGTH
static java.lang.String	JWT_SPLITTER
static java.lang.String	THIS_IS_A_JWE
static java.lang.String	TOO_MANY_MEMBERS

Constructor Summary

Constructors

Constructor	Description
JwtSerde(Serdes serdes, java.util.Base64.Encoder encoder, java.util.Base64.Decoder decoder)

Method Summary

Modifier and Type	Method	Description
protected java.io.ByteArrayOutputStream	compact(java.util.List<byte[]> members, java.lang.Boolean forSigning)
java.io.ByteArrayOutputStream	compactJwt(JsonWebToken jwt)
protected JsonWebToken	jws(java.lang.String[] jwsParts, java.lang.Class claimClass, java.lang.String jwtAsText)
protected JsonWebToken	jwt(java.lang.String[] jwtParts, java.lang.Class claimClass, java.lang.String jwtAsText)
byte[]	makeSignInput(Header header, Claims claims)
protected java.util.List<byte[]>	membersForSigning(Header header, Claims claims)
protected java.lang.Boolean	shouldAppendDelimiter(int i, int numberOfMembers, java.lang.Boolean forSigning)	Deteremines if a "." should be appended to the current index of a compact jwt.
JsonWebToken	stringToJwt(java.lang.String jwtAsText, java.lang.Class claimClass)

Methods inherited from class java.lang.Object

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

Field Detail

JWT_SPLITTER

public static final java.lang.String JWT_SPLITTER

See Also:

Constant Field Values

INVALID_JSON

public static final java.lang.String INVALID_JSON

See Also:

Constant Field Values

COULD_NOT_SERIALIZE

public static final java.lang.String COULD_NOT_SERIALIZE

See Also:

Constant Field Values

THIS_IS_A_JWE

public static final java.lang.String THIS_IS_A_JWE

See Also:

Constant Field Values

TOO_MANY_MEMBERS

public static final java.lang.String TOO_MANY_MEMBERS

See Also:

Constant Field Values

COULD_NOT_COMBINE_JWT_MEMBERS

public static final java.lang.String COULD_NOT_COMBINE_JWT_MEMBERS

See Also:

Constant Field Values

COULD_NOT_COMBINE_SIGN_INPUTS

public static final java.lang.String COULD_NOT_COMBINE_SIGN_INPUTS

See Also:

Constant Field Values

JWT_LENGTH

public final int JWT_LENGTH

See Also:

Constant Field Values

JWS_LENGTH

public final int JWS_LENGTH

See Also:

Constant Field Values

JWE_LENGTH

public final int JWE_LENGTH

See Also:

Constant Field Values

Constructor Detail

JwtSerde

public JwtSerde(Serdes serdes,
                java.util.Base64.Encoder encoder,
                java.util.Base64.Decoder decoder)

Method Detail

makeSignInput

public byte[] makeSignInput(Header header,
                            Claims claims)
                     throws JwtToJsonException

Throws:

JwtToJsonException

membersForSigning

protected java.util.List<byte[]> membersForSigning(Header header,
                                                   Claims claims)
                                            throws JwtToJsonException

Throws:

JwtToJsonException

compactJwt

public java.io.ByteArrayOutputStream compactJwt(JsonWebToken jwt)
                                         throws JwtToJsonException

Throws:

JwtToJsonException

stringToJwt

public JsonWebToken stringToJwt(java.lang.String jwtAsText,
                                java.lang.Class claimClass)
                         throws JsonToJwtException,
                                InvalidJWT

Throws:

JsonToJwtException

InvalidJWT

jwt

protected JsonWebToken jwt(java.lang.String[] jwtParts,
                           java.lang.Class claimClass,
                           java.lang.String jwtAsText)
                    throws JsonToJwtException

Throws:

JsonToJwtException

jws

protected JsonWebToken jws(java.lang.String[] jwsParts,
                           java.lang.Class claimClass,
                           java.lang.String jwtAsText)
                    throws JsonToJwtException

Throws:

JsonToJwtException

compact

protected java.io.ByteArrayOutputStream compact(java.util.List<byte[]> members,
                                                java.lang.Boolean forSigning)
                                         throws java.io.IOException

Throws:

java.io.IOException

shouldAppendDelimiter

protected java.lang.Boolean shouldAppendDelimiter(int i,
                                                  int numberOfMembers,
                                                  java.lang.Boolean forSigning)

Deteremines if a "." should be appended to the current index of a compact jwt. When its not for signing Then a unsecure jwt will have a trailing "." Then a secure jwt (signed) will not have a trailing "." When its for signing Then a unsecure jwt will not have a trailing "."

Parameters:

i - the current index of the jwt

numberOfMembers - the number of members in the jwt

forSigning - is it being compacted to be signed.

Returns:

true if a "." should be appended. false if not.