Package org.jose4j.jwt

Class JwtClaims

java.lang.Object

org.jose4j.jwt.JwtClaims

public class JwtClaims
extends Object

Constructor Summary

Constructors

Constructor	Description
JwtClaims()

Method Summary

Modifier and Type	Method	Description
Map<String,List<Object>>	flattenClaims()
Map<String,List<Object>>	flattenClaims(Set<String> omittedClaims)
List<String>	getAudience()	Gets the value of the "aud" (Audience) Claim.
Collection<String>	getClaimNames()
Collection<String>	getClaimNames(Set<String> omittedClaims)
Map<String,Object>	getClaimsMap()
Map<String,Object>	getClaimsMap(Set<String> omittedClaims)
Object	getClaimValue(String claimName)
<T> T	getClaimValue(String claimName, Class<T> type)
String	getClaimValueAsString(String claimName)	Gets the value of the claim, if present, as a string by calling toString on the value returned by getClaimValue(String).
NumericDate	getExpirationTime()
NumericDate	getIssuedAt()
String	getIssuer()
String	getJwtId()
NumericDate	getNotBefore()
NumericDate	getNumericDateClaimValue(String claimName)
String	getRawJson()
String	getStringClaimValue(String claimName)
List<String>	getStringListClaimValue(String claimName)	Gets the value of the claim as a List of Strings, which assumes that it is a JSON array of strings.
String	getSubject()
boolean	hasAudience()	Is there an "aud" (Audience) Claim in this claim set?
boolean	hasClaim(String claimName)
boolean	isClaimValueOfType(String claimName, Class type)
boolean	isClaimValueString(String claimName)
boolean	isClaimValueStringList(String claimName)	Is the claim present with a string array value.
static JwtClaims	parse(String jsonClaims)
static JwtClaims	parse(String jsonClaims, JwtContext jwtContext)
void	setAudience(String audience)
void	setAudience(String... audience)
void	setAudience(List<String> audiences)
void	setClaim(String claimName, Object value)
void	setExpirationTime(NumericDate expirationTime)
void	setExpirationTimeMinutesInTheFuture(float minutes)
void	setGeneratedJwtId()
void	setGeneratedJwtId(int numberOfBytes)
void	setIssuedAt(NumericDate issuedAt)
void	setIssuedAtToNow()
void	setIssuer(String issuer)
void	setJwtId(String jwtId)
void	setNotBefore(NumericDate notBefore)
void	setNotBeforeMinutesInThePast(float minutes)
void	setNumericDateClaim(String claimName, NumericDate value)
void	setStringClaim(String claimName, String value)
void	setStringListClaim(String claimName, String... values)
void	setStringListClaim(String claimName, List<String> values)
void	setSubject(String subject)
String	toJson()
String	toString()
void	unsetClaim(String claimName)

Methods inherited from class java.lang.Object

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

Constructor Details

JwtClaims

public JwtClaims()

Method Details

parse

public static JwtClaims parse(String jsonClaims,
 JwtContext jwtContext)
                       throws InvalidJwtException

Throws:

InvalidJwtException

parse

public static JwtClaims parse(String jsonClaims)
                       throws InvalidJwtException

Throws:

InvalidJwtException

getIssuer

public String getIssuer()
                 throws MalformedClaimException

Throws:

MalformedClaimException

setIssuer

public void setIssuer(String issuer)

getSubject

public String getSubject()
                  throws MalformedClaimException

Throws:

MalformedClaimException

setSubject

public void setSubject(String subject)

setAudience

public void setAudience(String audience)

setAudience

public void setAudience(String... audience)

setAudience

public void setAudience(List<String> audiences)

hasAudience

public boolean hasAudience()

Is there an "aud" (Audience) Claim in this claim set?

Returns:

true, if the claims have an "aud" claim, false otherwise

getAudience

public List<String> getAudience()
                         throws MalformedClaimException

Gets the value of the "aud" (Audience) Claim. An empty list is returned if aud is not present. Use hasAudience() to distinguish between an aud claim with an empty array value and the lack of an aud claim.

Returns:

a list of the audience values. Will return an empty list, if aud is not present.

Throws:

MalformedClaimException - if the value of the audience claim is not an array of strings or a single string value

getExpirationTime

public NumericDate getExpirationTime()
                              throws MalformedClaimException

Throws:

MalformedClaimException

setExpirationTime

public void setExpirationTime(NumericDate expirationTime)

setExpirationTimeMinutesInTheFuture

public void setExpirationTimeMinutesInTheFuture(float minutes)

getNotBefore

public NumericDate getNotBefore()
                         throws MalformedClaimException

Throws:

MalformedClaimException

setNotBefore

public void setNotBefore(NumericDate notBefore)

setNotBeforeMinutesInThePast

public void setNotBeforeMinutesInThePast(float minutes)

getIssuedAt

public NumericDate getIssuedAt()
                        throws MalformedClaimException

Throws:

MalformedClaimException

setIssuedAt

public void setIssuedAt(NumericDate issuedAt)

setIssuedAtToNow

public void setIssuedAtToNow()

getJwtId

public String getJwtId()
                throws MalformedClaimException

Throws:

MalformedClaimException

setJwtId

public void setJwtId(String jwtId)

setGeneratedJwtId

public void setGeneratedJwtId(int numberOfBytes)

setGeneratedJwtId

public void setGeneratedJwtId()

unsetClaim

public void unsetClaim(String claimName)

getClaimValue

public <T> T getClaimValue(String claimName,
 Class<T> type)
                    throws MalformedClaimException

Throws:

MalformedClaimException

getClaimValue

public Object getClaimValue(String claimName)

hasClaim

public boolean hasClaim(String claimName)

getNumericDateClaimValue

public NumericDate getNumericDateClaimValue(String claimName)
                                     throws MalformedClaimException

Throws:

MalformedClaimException

getStringClaimValue

public String getStringClaimValue(String claimName)
                           throws MalformedClaimException

Throws:

MalformedClaimException

getClaimValueAsString

public String getClaimValueAsString(String claimName)

Gets the value of the claim, if present, as a string by calling toString on the value returned by getClaimValue(String).

Parameters:

claimName - the claim name

Returns:

the claim value as a String or null if no such named claim is present

getStringListClaimValue

public List<String> getStringListClaimValue(String claimName)
                                     throws MalformedClaimException

Gets the value of the claim as a List of Strings, which assumes that it is a JSON array of strings.

Parameters:

claimName - the name of the claim

Returns:

a List<String> with the values of the claim. Empty list, if the claim is not present.

Throws:

MalformedClaimException - if the claim value is not an array or is an array that contains non string values

setNumericDateClaim

public void setNumericDateClaim(String claimName,
 NumericDate value)

setStringClaim

public void setStringClaim(String claimName,
 String value)

setStringListClaim

public void setStringListClaim(String claimName,
 List<String> values)

setStringListClaim

public void setStringListClaim(String claimName,
 String... values)

setClaim

public void setClaim(String claimName,
 Object value)

isClaimValueOfType

public boolean isClaimValueOfType(String claimName,
 Class type)

isClaimValueString

public boolean isClaimValueString(String claimName)

isClaimValueStringList

public boolean isClaimValueStringList(String claimName)

Is the claim present with a string array value.

Parameters:

claimName - the name of the claim

Returns:

true, if the claim is present and its value is array of strings. False otherwise.

flattenClaims

public Map<String,List<Object>> flattenClaims()

flattenClaims

public Map<String,List<Object>> flattenClaims(Set<String> omittedClaims)

getClaimsMap

public Map<String,Object> getClaimsMap(Set<String> omittedClaims)

getClaimsMap

public Map<String,Object> getClaimsMap()

getClaimNames

public Collection<String> getClaimNames(Set<String> omittedClaims)

getClaimNames

public Collection<String> getClaimNames()

toJson

public String toJson()

getRawJson

public String getRawJson()

toString

public String toString()

Overrides:

toString in class Object