com.atlassian.asap.api

Class JwtBuilder

java.lang.Object

com.atlassian.asap.api.JwtBuilder

public final class JwtBuilder
extends Object

A fluent builder for constructing a Jwt object.

Field Summary

Fields

Modifier and Type	Field and Description
static Duration	DEFAULT_LIFETIME Token lifetime, unless a specific lifetime is explicitly set.

Method Summary

Modifier and Type	Method and Description
JwtBuilder	algorithm(SigningAlgorithm alg) Sets the algorithm (alg) jws header.
JwtBuilder	audience(Iterable<String> aud) Sets the audience (aud) claim.
JwtBuilder	audience(String... aud) Sets the audience (aud) claim.
Jwt	build()
static JwtBuilder	copyJwt(Jwt prototype) Returns a builder initialised to make an identical copy of the given original Jwt.
JwtBuilder	customClaims(javax.json.JsonObject customClaims) Sets the custom claims for this jwt.
JwtBuilder	expirationTime(Instant expiry) Sets the expiration time (exp) claim.
JwtBuilder	issuedAt(Instant iat) Set the issued at (iat) claim.
JwtBuilder	issuer(String iss) Set the issuer (iss) claim.
JwtBuilder	jwtId(String jti) Set the jwt id (jti) claim.
JwtBuilder	keyId(String keyId) Sets the key id jws header.
static JwtBuilder	newFromPrototype(Jwt jwtPrototype) Construct a JWT builder initialised from a prototype JWT.
static JwtBuilder	newJwt() Construct a simple jwt builder initialised with default claim values as follows: nbf, iat claim set to current system time exp claim set current time plus default expiry as defined in DEFAULT_LIFETIME jti claim set to a random UUID.
JwtBuilder	notBefore(Optional<Instant> nbf) Set the not before (nbf) claim.
JwtBuilder	subject(Optional<String> sub) Sets the subject (sub) claim for this jwt.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIFETIME

public static final Duration DEFAULT_LIFETIME

Token lifetime, unless a specific lifetime is explicitly set. This is the time span between the iat and the exp claims.

Method Detail

newJwt

public static JwtBuilder newJwt()

Construct a simple jwt builder initialised with default claim values as follows:

• nbf, iat claim set to current system time
• exp claim set current time plus default expiry as defined in DEFAULT_LIFETIME
• jti claim set to a random UUID.
• alg header set to SigningAlgorithm.RS256.

Returns:

a new fluent builder

newFromPrototype

public static JwtBuilder newFromPrototype(Jwt jwtPrototype)

Construct a JWT builder initialised from a prototype JWT. Time claims are rebased to the current time, and the jti is set to a random UUID.

Parameters:

jwtPrototype - Jwt to use as prototype

Returns:

a new fluent builder

copyJwt

public static JwtBuilder copyJwt(Jwt prototype)

Returns a builder initialised to make an identical copy of the given original Jwt.

Parameters:

prototype - Jwt to use as original

Returns:

a Jwt builder initialised to be an identical copy of the original

keyId

public JwtBuilder keyId(String keyId)

Sets the key id jws header.

Parameters:

keyId - the key id for the jws header of this jwt

Returns:

the fluent builder

algorithm

public JwtBuilder algorithm(SigningAlgorithm alg)

Sets the algorithm (alg) jws header.

Parameters:

alg - the alg for the jws header of this jwt

Returns:

the fluent builder

audience

public JwtBuilder audience(Iterable<String> aud)

Sets the audience (aud) claim.

Parameters:

aud - an iterable containing one or more audiences for the jwt

Returns:

the fluent builder

audience

public JwtBuilder audience(String... aud)

Sets the audience (aud) claim.

Parameters:

aud - one or more audiences for the jwt

Returns:

the fluent builder

expirationTime

public JwtBuilder expirationTime(Instant expiry)

Sets the expiration time (exp) claim.

Parameters:

expiry - the expiration time

Returns:

the fluent builder

issuedAt

public JwtBuilder issuedAt(Instant iat)

Set the issued at (iat) claim.

Parameters:

iat - the issued at time

Returns:

the fluent builder

issuer

public JwtBuilder issuer(String iss)

Set the issuer (iss) claim.

Parameters:

iss - the issuer

Returns:

the fluent builder

jwtId

public JwtBuilder jwtId(String jti)

Set the jwt id (jti) claim.

Parameters:

jti - a unique id for the jwt

Returns:

the fluent builder

notBefore

public JwtBuilder notBefore(Optional<Instant> nbf)

Set the not before (nbf) claim.

Parameters:

nbf - the not before date

Returns:

the fluent builder

subject

public JwtBuilder subject(Optional<String> sub)

Sets the subject (sub) claim for this jwt.

Parameters:

sub - the subject

Returns:

the fluent builder

customClaims

public JwtBuilder customClaims(javax.json.JsonObject customClaims)

Sets the custom claims for this jwt. Any previously set custom claim is discarded. If any of the custom claims conflicts with a registered claim, the registered claim takes precedence.

Parameters:

customClaims - the custom claims

Returns:

the fluent builder

build

public Jwt build()

Returns:

a serializable JWT object representing all the values specified to this builder

Throws:

NullPointerException - if some required parameter has not been specified