com.nimbusds.jwt
Interface ReadOnlyJWTClaimsSet

All Known Implementing Classes:

JWTClaimsSet

public interface ReadOnlyJWTClaimsSet

Read-only view of a JWTClaimsSet.

Version:

$version$ (2013-01-15)

Author:

Vladimir Dzhuvinov

Method Summary

String[]	getAudienceClaim() Gets the audience (aud) clam.
Object	getCustomClaim(String name) Gets a custom (non-reserved) claim.
Map<String,Object>	getCustomClaims() Gets the custom (non-reserved) claims.
long	getExpirationTimeClaim() Gets the expiration time (exp) claim.
long	getIssuedAtClaim() Gets the issued-at (iat) claim.
String	getIssuerClaim() Gets the issuer (iss) claim.
String	getJWTIDClaim() Gets the JWT ID (jti) claim.
long	getNotBeforeClaim() Gets the not-before (nbf) claim.
String	getSubjectClaim() Gets the subject (sub) claim.
String	getTypeClaim() Gets the type (typ) claim.
net.minidev.json.JSONObject	toJSONObject() Returns the JSON object representation of the claims set.

Method Detail

getIssuerClaim

String getIssuerClaim()

Gets the issuer (iss) claim.

Returns:

The issuer claim, null if not specified.

getSubjectClaim

String getSubjectClaim()

Gets the subject (sub) claim.

Returns:

The subject claim, null if not specified.

getAudienceClaim

String[] getAudienceClaim()

Gets the audience (aud) clam.

Returns:

The audience claim, null if not specified.

getExpirationTimeClaim

long getExpirationTimeClaim()

Gets the expiration time (exp) claim.

Returns:

The expiration time, -1 if not specified.

getNotBeforeClaim

long getNotBeforeClaim()

Gets the not-before (nbf) claim.

Returns:

The not-before claim, -1 if not specified.

getIssuedAtClaim

long getIssuedAtClaim()

Gets the issued-at (iat) claim.

Returns:

The issued-at claim, -1 if not specified.

getJWTIDClaim

String getJWTIDClaim()

Gets the JWT ID (jti) claim.

Returns:

The JWT ID claim, null if not specified.

getTypeClaim

String getTypeClaim()

Gets the type (typ) claim.

Returns:

The type claim, null if not specified.

getCustomClaim

Object getCustomClaim(String name)

Gets a custom (non-reserved) claim.

Parameters:

name - The name of the custom claim. Must not be null.

Returns:

The value of the custom claim, null if not specified.

getCustomClaims

Map<String,Object> getCustomClaims()

Gets the custom (non-reserved) claims.

Returns:

The custom claims, as a unmodifiable map, empty map if none.

toJSONObject

net.minidev.json.JSONObject toJSONObject()

Returns the JSON object representation of the claims set.

Returns:

The JSON object representation.