Package org.keycloak.representations

Class RefreshToken

java.lang.Object

org.keycloak.representations.JsonWebToken

org.keycloak.representations.IDToken

org.keycloak.representations.AccessToken

org.keycloak.representations.RefreshToken

All Implemented Interfaces:

Serializable, Token

public class RefreshToken
extends AccessToken

Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.representations.AccessToken

AccessToken.Access, AccessToken.Authorization, AccessToken.Confirmation

Field Summary

Fields inherited from class org.keycloak.representations.AccessToken

allowedOrigins, authorization, confirmation, realmAccess, resourceAccess, scope, trustedCertificates

Fields inherited from class org.keycloak.representations.IDToken

accessTokenHash, acr, ACR, address, ADDRESS, AT_HASH, auth_time, AUTH_TIME, birthdate, BIRTHDATE, C_HASH, CLAIMS_LOCALES, claimsLocales, codeHash, email, EMAIL, EMAIL_VERIFIED, emailVerified, FAMILY_NAME, familyName, gender, GENDER, GIVEN_NAME, givenName, locale, LOCALE, MIDDLE_NAME, middleName, name, NAME, nickName, NICKNAME, nonce, NONCE, PHONE_NUMBER, PHONE_NUMBER_VERIFIED, phoneNumber, phoneNumberVerified, picture, PICTURE, PREFERRED_USERNAME, preferredUsername, profile, PROFILE, S_HASH, SESSION_ID, SESSION_STATE, sessionId, stateHash, UPDATED_AT, updatedAt, website, WEBSITE, zoneinfo, ZONEINFO

Fields inherited from class org.keycloak.representations.JsonWebToken

audience, AZP, exp, iat, id, issuedFor, issuer, nbf, otherClaims, subject, SUBJECT, type

Constructor Summary

Constructors

Constructor	Description
RefreshToken(AccessToken token)	Deep copies issuer, subject, issuedFor, sessionState from AccessToken.
RefreshToken(AccessToken token, AccessToken.Confirmation confirmation)	Deep copies issuer, subject, issuedFor, sessionState from AccessToken.

Method Summary

Modifier and Type	Method	Description
TokenCategory	getCategory()
String	getSessionId()

Methods inherited from class org.keycloak.representations.AccessToken

addAccess, getAllowedOrigins, getAuthorization, getConfirmation, getRealmAccess, getResourceAccess, getResourceAccess, getScope, getTrustedCertificates, id, issuedFor, issuer, isVerifyCaller, isVerifyCaller, setAllowedOrigins, setAuthorization, setConfirmation, setRealmAccess, setResourceAccess, setScope, setTrustedCertificates, subject, type

Methods inherited from class org.keycloak.representations.IDToken

getAccessTokenHash, getAcr, getAddress, getAuth_time, getBirthdate, getClaimsLocales, getCodeHash, getEmail, getEmailVerified, getFamilyName, getGender, getGivenName, getLocale, getMiddleName, getName, getNickName, getNonce, getPhoneNumber, getPhoneNumberVerified, getPicture, getPreferredUsername, getProfile, getSessionState, getStateHash, getUpdatedAt, getWebsite, getZoneinfo, setAccessTokenHash, setAcr, setAddress, setAuth_time, setBirthdate, setClaimsLocales, setCodeHash, setEmail, setEmailVerified, setFamilyName, setGender, setGivenName, setLocale, setMiddleName, setName, setNickName, setNonce, setPhoneNumber, setPhoneNumberVerified, setPicture, setPreferredUsername, setProfile, setSessionId, setStateHash, setUpdatedAt, setWebsite, setZoneinfo

Methods inherited from class org.keycloak.representations.JsonWebToken

addAudience, audience, exp, getAudience, getExp, getIat, getId, getIssuedFor, getIssuer, getNbf, getOtherClaims, getSubject, getType, hasAnyAudience, hasAudience, iat, isActive, isActive, isExpired, isIssuedBeforeSessionStart, isNotBefore, issuedNow, nbf, setOtherClaims, setSubject

Methods inherited from class java.lang.Object

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

Constructor Details

RefreshToken

public RefreshToken(AccessToken token)

Deep copies issuer, subject, issuedFor, sessionState from AccessToken.

RefreshToken

public RefreshToken(AccessToken token,
 AccessToken.Confirmation confirmation)

Deep copies issuer, subject, issuedFor, sessionState from AccessToken.

Parameters:

token -

confirmation - optional confirmation parameter that might be processed during authentication but should not always be included in the response

Method Details

getCategory

public TokenCategory getCategory()

Specified by:

getCategory in interface Token

Overrides:

getCategory in class AccessToken

getSessionId

public String getSessionId()

Overrides:

getSessionId in class IDToken