com.atlassian.jwt.writer

Interface JwtJsonBuilder

public interface JwtJsonBuilder

Utility for generating JSON payloads for JWTs.

Since:

1.0

Method Summary

Modifier and Type	Method and Description
JwtJsonBuilder	audience(String aud) Sets the 'aud' parameter.
String	build()
JwtJsonBuilder	claim(String name, Object obj) Adds an arbitrary claim.
JwtJsonBuilder	expirationTime(long exp) Sets the 'exp' parameter.
boolean	isClaimSet(String name)
JwtJsonBuilder	issuedAt(long iat) Sets the 'iat' parameter.
JwtJsonBuilder	issuer(String iss) Sets the 'iss' parameter.
JwtJsonBuilder	jwtId(String jti) Sets the 'jti' parameter.
JwtJsonBuilder	notBefore(long nbf) Sets the 'nbf' parameter.
JwtJsonBuilder	queryHash(String qsh) Sets the 'qsh' parameter
JwtJsonBuilder	subject(String sub) Sets the 'sub' parameter.
JwtJsonBuilder	type(String typ) Sets the 'typ' parameter.

Method Detail

audience

@Nonnull
JwtJsonBuilder audience(@Nonnull
                                 String aud)

Sets the 'aud' parameter.

expirationTime

@Nonnull
JwtJsonBuilder expirationTime(long exp)

Sets the 'exp' parameter.

isClaimSet

boolean isClaimSet(@Nonnull
                   String name)

Parameters:

name - the claim to check

Returns:

true if the name claim is set, otherwise false

Since:

1.6

issuedAt

@Nonnull
JwtJsonBuilder issuedAt(long iat)

Sets the 'iat' parameter.

issuer

@Nonnull
JwtJsonBuilder issuer(@Nonnull
                               String iss)

Sets the 'iss' parameter.

jwtId

@Nonnull
JwtJsonBuilder jwtId(@Nonnull
                              String jti)

Sets the 'jti' parameter.

notBefore

@Nonnull
JwtJsonBuilder notBefore(long nbf)

Sets the 'nbf' parameter.

subject

@Nonnull
JwtJsonBuilder subject(@Nonnull
                                String sub)

Sets the 'sub' parameter.

type

@Nonnull
JwtJsonBuilder type(@Nonnull
                             String typ)

Sets the 'typ' parameter.

queryHash

@Nonnull
JwtJsonBuilder queryHash(@Nonnull
                                  String qsh)

Sets the 'qsh' parameter

claim

@Nonnull
JwtJsonBuilder claim(@Nonnull
                              String name,
                              @Nonnull
                              Object obj)

Adds an arbitrary claim.

Parameters:

name - the claim's name.

obj - the claim's value. Allowed types are:

• String
• Boolean
• Number
• a Map of String to any of the above
• an array of any of the above

build

@Nonnull
String build()

Returns:

the generated JSON.