public static class JWTCreator.Builder extends Object
| Modifier and Type | Method and Description |
|---|---|
String |
sign(Algorithm algorithm)
Creates a new JWT and signs is with the given algorithm
|
JWTCreator.Builder |
withArrayClaim(String name,
Integer[] items)
Add a custom Array Claim with the given items.
|
JWTCreator.Builder |
withArrayClaim(String name,
Long[] items)
Add a custom Array Claim with the given items.
|
JWTCreator.Builder |
withArrayClaim(String name,
String[] items)
Add a custom Array Claim with the given items.
|
JWTCreator.Builder |
withAudience(String... audience)
Add a specific Audience ("aud") claim to the Payload.
|
JWTCreator.Builder |
withClaim(String name,
Boolean value)
Add a custom Claim value.
|
JWTCreator.Builder |
withClaim(String name,
Date value)
Add a custom Claim value.
|
JWTCreator.Builder |
withClaim(String name,
Double value)
Add a custom Claim value.
|
JWTCreator.Builder |
withClaim(String name,
Integer value)
Add a custom Claim value.
|
JWTCreator.Builder |
withClaim(String name,
Long value)
Add a custom Claim value.
|
JWTCreator.Builder |
withClaim(String name,
String value)
Add a custom Claim value.
|
JWTCreator.Builder |
withExpiresAt(Date expiresAt)
Add a specific Expires At ("exp") claim to the Payload.
|
JWTCreator.Builder |
withHeader(Map<String,Object> headerClaims)
Add specific Claims to set as the Header.
|
JWTCreator.Builder |
withIssuedAt(Date issuedAt)
Add a specific Issued At ("iat") claim to the Payload.
|
JWTCreator.Builder |
withIssuer(String issuer)
Add a specific Issuer ("iss") claim to the Payload.
|
JWTCreator.Builder |
withJWTId(String jwtId)
Add a specific JWT Id ("jti") claim to the Payload.
|
JWTCreator.Builder |
withKeyId(String keyId)
Add a specific Key Id ("kid") claim to the Header.
|
JWTCreator.Builder |
withNotBefore(Date notBefore)
Add a specific Not Before ("nbf") claim to the Payload.
|
JWTCreator.Builder |
withSubject(String subject)
Add a specific Subject ("sub") claim to the Payload.
|
public JWTCreator.Builder withHeader(Map<String,Object> headerClaims)
headerClaims - the values to use as Claims in the token's Header.public JWTCreator.Builder withKeyId(String keyId)
Algorithm used to sign this token was instantiated with a KeyProvider, the 'kid' value will be taken from that provider and this one will be ignored.keyId - the Key Id value.public JWTCreator.Builder withIssuer(String issuer)
issuer - the Issuer value.public JWTCreator.Builder withSubject(String subject)
subject - the Subject value.public JWTCreator.Builder withAudience(String... audience)
audience - the Audience value.public JWTCreator.Builder withExpiresAt(Date expiresAt)
expiresAt - the Expires At value.public JWTCreator.Builder withNotBefore(Date notBefore)
notBefore - the Not Before value.public JWTCreator.Builder withIssuedAt(Date issuedAt)
issuedAt - the Issued At value.public JWTCreator.Builder withJWTId(String jwtId)
jwtId - the Token Id value.public JWTCreator.Builder withClaim(String name, Boolean value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withClaim(String name, Integer value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withClaim(String name, Long value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withClaim(String name, Double value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withClaim(String name, String value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withClaim(String name, Date value) throws IllegalArgumentException
name - the Claim's name.value - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withArrayClaim(String name, String[] items) throws IllegalArgumentException
name - the Claim's name.items - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withArrayClaim(String name, Integer[] items) throws IllegalArgumentException
name - the Claim's name.items - the Claim's value.IllegalArgumentException - if the name is null.public JWTCreator.Builder withArrayClaim(String name, Long[] items) throws IllegalArgumentException
name - the Claim's name.items - the Claim's value.IllegalArgumentException - if the name is null.public String sign(Algorithm algorithm) throws IllegalArgumentException, JWTCreationException
algorithm - used to sign the JWTIllegalArgumentException - if the provided algorithm is null.JWTCreationException - if the claims could not be converted to a valid JSON or there was a problem with the signing key.Copyright © 2017. All rights reserved.