Package org.keycloak.adapters

Class RefreshableKeycloakSecurityContext

java.lang.Object

org.keycloak.KeycloakSecurityContext

org.keycloak.adapters.RefreshableKeycloakSecurityContext

All Implemented Interfaces:

Serializable

public class RefreshableKeycloakSecurityContext
extends KeycloakSecurityContext

Version:

$Revision: 1 $

Author:

Bill Burke

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected KeycloakDeployment	deployment
protected static org.jboss.logging.Logger	log
protected String	refreshToken
protected AdapterTokenStore	tokenStore

Fields inherited from class org.keycloak.KeycloakSecurityContext

authorizationContext, idToken, idTokenString, token, tokenString

Constructor Summary

Constructors

Constructor	Description
RefreshableKeycloakSecurityContext()
RefreshableKeycloakSecurityContext(KeycloakDeployment deployment, AdapterTokenStore tokenStore, String tokenString, AccessToken token, String idTokenString, IDToken idToken, String refreshToken)

Method Summary

Modifier and Type	Method	Description
KeycloakDeployment	getDeployment()
IDToken	getIdToken()
String	getIdTokenString()
String	getRefreshToken()
AccessToken	getToken()
String	getTokenString()
boolean	isActive()
boolean	isTokenTimeToLiveSufficient(AccessToken token)
void	logout(KeycloakDeployment deployment)
boolean	refreshExpiredToken(boolean checkActive)
void	setAuthorizationContext(AuthorizationContext authorizationContext)
void	setCurrentRequestInfo(KeycloakDeployment deployment, AdapterTokenStore tokenStore)

Methods inherited from class org.keycloak.KeycloakSecurityContext

getAuthorizationContext, getRealm

Methods inherited from class java.lang.Object

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

Field Details

log

protected static org.jboss.logging.Logger log

deployment

protected transient KeycloakDeployment deployment

tokenStore

protected transient AdapterTokenStore tokenStore

refreshToken

protected String refreshToken

Constructor Details

RefreshableKeycloakSecurityContext

public RefreshableKeycloakSecurityContext()

RefreshableKeycloakSecurityContext

public RefreshableKeycloakSecurityContext(KeycloakDeployment deployment,
 AdapterTokenStore tokenStore,
 String tokenString,
 AccessToken token,
 String idTokenString,
 IDToken idToken,
 String refreshToken)

Method Details

getToken

public AccessToken getToken()

Overrides:

getToken in class KeycloakSecurityContext

getTokenString

public String getTokenString()

Overrides:

getTokenString in class KeycloakSecurityContext

getIdToken

public IDToken getIdToken()

Overrides:

getIdToken in class KeycloakSecurityContext

getIdTokenString

public String getIdTokenString()

Overrides:

getIdTokenString in class KeycloakSecurityContext

getRefreshToken

public String getRefreshToken()

logout

public void logout(KeycloakDeployment deployment)

isActive

public boolean isActive()

isTokenTimeToLiveSufficient

public boolean isTokenTimeToLiveSufficient(AccessToken token)

getDeployment

public KeycloakDeployment getDeployment()

setCurrentRequestInfo

public void setCurrentRequestInfo(KeycloakDeployment deployment,
 AdapterTokenStore tokenStore)

refreshExpiredToken

public boolean refreshExpiredToken(boolean checkActive)

Parameters:

checkActive - if true, then we won't send refresh request if current accessToken is still active.

Returns:

true if accessToken is active or was successfully refreshed

setAuthorizationContext

public void setAuthorizationContext(AuthorizationContext authorizationContext)