public class LogoutTokenClaimsSet extends ClaimsSet
Example logout token claims set:
o { "iss" : "https://server.example.com", "sub" : "248289761001", "aud" : "s6BhdRkqt3", "iat" : 1471566154, "jti" : "bWJq", "sid" : "08a5019c-17e1-4977-8f42-65a12843ea02", "events" : { "http://schemas.openid.net/event/backchannel-logout": { } } }
Related specifications:
Modifier and Type | Field and Description |
---|---|
static String |
AUD_CLAIM_NAME
The audience claim name.
|
static String |
EVENT_TYPE
The OpenID logout event type.
|
static String |
EVENTS_CLAIM_NAME
The events claim name.
|
static String |
IAT_CLAIM_NAME
The issue time claim name.
|
static String |
ISS_CLAIM_NAME
The issuer claim name.
|
static String |
JTI_CLAIM_NAME
The JWT ID claim name.
|
static String |
SID_CLAIM_NAME
The session identifier claim name.
|
static String |
SUB_CLAIM_NAME
The subject claim name.
|
Constructor and Description |
---|
LogoutTokenClaimsSet(Issuer iss,
Subject sub,
List<Audience> aud,
Date iat,
JWTID jti,
SessionID sid)
Creates a new logout token claims set.
|
LogoutTokenClaimsSet(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet)
Creates a new logout token claims set from the specified JSON Web
Token (JWT) claims set.
|
Modifier and Type | Method and Description |
---|---|
List<Audience> |
getAudience()
Gets the audience.
|
Issuer |
getIssuer()
Gets the issuer.
|
Date |
getIssueTime()
Gets the issue time.
|
JWTID |
getJWTID()
Gets the JWT ID.
|
SessionID |
getSessionID()
Gets the session ID.
|
static Set<String> |
getStandardClaimNames()
Gets the names of the standard top-level logout token claims.
|
Subject |
getSubject()
Gets the subject.
|
static LogoutTokenClaimsSet |
parse(String json)
Parses a logout token claims set from the specified JSON object
string.
|
void |
setSessionID(SessionID sid)
Sets the session ID.
|
net.minidev.json.JSONObject |
toJSONObject()
Gets the JSON object representation of this claims set.
|
com.nimbusds.jwt.JWTClaimsSet |
toJWTClaimsSet()
Gets the JSON Web Token (JWT) claims set for this claim set.
|
getBooleanClaim, getClaim, getClaim, getDateClaim, getEmailClaim, getLangTaggedClaim, getNumberClaim, getStringClaim, getStringClaim, getStringListClaim, getURIClaim, getURLClaim, putAll, putAll, setClaim, setClaim, setDateClaim, setEmailClaim, setURIClaim, setURLClaim
public static final String JTI_CLAIM_NAME
public static final String EVENTS_CLAIM_NAME
public static final String EVENT_TYPE
public static final String ISS_CLAIM_NAME
public static final String SUB_CLAIM_NAME
public static final String AUD_CLAIM_NAME
public static final String IAT_CLAIM_NAME
public static final String SID_CLAIM_NAME
public LogoutTokenClaimsSet(Issuer iss, Subject sub, List<Audience> aud, Date iat, JWTID jti, SessionID sid)
iss
- The issuer. Must not be null
.sub
- The subject. Must not be null
unless the session
ID is set.aud
- The audience. Must not be null
.iat
- The issue time. Must not be null
.jti
- The JWT ID. Must not be null
.sid
- The session ID. Must not be null
unless the
subject is set.public LogoutTokenClaimsSet(com.nimbusds.jwt.JWTClaimsSet jwtClaimsSet) throws ParseException
jwtClaimsSet
- The JWT claims set. Must not be null
.ParseException
- If the JWT claims set doesn't represent a
valid logout token claims set.public static Set<String> getStandardClaimNames()
public JWTID getJWTID()
jti
claim.public net.minidev.json.JSONObject toJSONObject()
ClaimsSet
Example:
{ "country" : "USA", "country#en" : "USA", "country#de_DE" : "Vereinigte Staaten", "country#fr_FR" : "Etats Unis" }
toJSONObject
in class ClaimsSet
public com.nimbusds.jwt.JWTClaimsSet toJWTClaimsSet() throws ParseException
ClaimsSet
toJWTClaimsSet
in class ClaimsSet
ParseException
- If the conversion to a JWT claims set fails.public static LogoutTokenClaimsSet parse(String json) throws ParseException
json
- The JSON object string to parse. Must not be
null
.ParseException
- If parsing failed.public Issuer getIssuer()
iss
claim.null
if not specified.public Subject getSubject()
sub
claim.public List<Audience> getAudience()
aud
claim.null
if not specified.public Date getIssueTime()
iss
claim.null
if not specified.public SessionID getSessionID()
sid
claim.null
if not specified.public void setSessionID(SessionID sid)
sid
claim.sid
- The session ID, null
if not specified.Copyright © 2017 Connect2id Ltd.. All rights reserved.