Package org.keycloak.models.session

Class PersistentUserSessionAdapter

java.lang.Object

org.keycloak.models.session.PersistentUserSessionAdapter

All Implemented Interfaces:

OfflineUserSessionModel, UserSessionModel

public class PersistentUserSessionAdapter
extends Object
implements OfflineUserSessionModel

Author:

Marek Posolda

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	PersistentUserSessionAdapter.PersistentUserSessionData

Nested classes/interfaces inherited from interface org.keycloak.models.UserSessionModel

UserSessionModel.SessionPersistenceState, UserSessionModel.State

Field Summary

Fields inherited from interface org.keycloak.models.UserSessionModel

CORRESPONDING_SESSION_ID

Constructor Summary

Constructors

Constructor	Description
PersistentUserSessionAdapter(KeycloakSession session, PersistentUserSessionModel model, RealmModel realm, String userId, Map<String,AuthenticatedClientSessionModel> clientSessions)
PersistentUserSessionAdapter(UserSessionModel other)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
Map<String,AuthenticatedClientSessionModel>	getAuthenticatedClientSessions()	Returns map where key is ID of the client (its UUID) and value is ID respective AuthenticatedClientSessionModel object.
String	getAuthMethod()
String	getBrokerSessionId()	If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession
String	getBrokerUserId()
String	getId()
String	getIpAddress()	Note: will not be an address when a proxy does not provide a valid one
int	getLastSessionRefresh()
String	getLoginUsername()
String	getNote(String name)
Map<String,String>	getNotes()
RealmModel	getRealm()
int	getStarted()
UserSessionModel.State	getState()
PersistentUserSessionModel	getUpdatedModel()
UserModel	getUser()
String	getUserId()
int	hashCode()
boolean	isOffline()
boolean	isRememberMe()
void	removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)	Removes authenticated client sessions for all clients whose UUID is present in removedClientUUIDS parameter.
void	removeNote(String name)
void	restartSession(RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
void	setAuthMethod(String authMethod)
void	setBrokerSessionId(String brokerSessionId)
void	setBrokerUserId(String brokerUserId)
void	setClientSessionsLoader(Consumer<Map<String,AuthenticatedClientSessionModel>> clientSessionsLoader)
void	setIpAddress(String ipAddress)
void	setLastSessionRefresh(int seconds)	Set the last session refresh timestamp for the user session.
void	setLoginUsername(String loginUsername)
void	setNote(String name, String value)
void	setRealm(RealmModel realm)
void	setRememberMe(boolean rememberMe)
void	setStarted(int started)
void	setState(UserSessionModel.State state)
void	setUser(UserModel user)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.keycloak.models.UserSessionModel

getAuthenticatedClientSessionByClient, getPersistenceState

Constructor Details

PersistentUserSessionAdapter

public PersistentUserSessionAdapter(UserSessionModel other)

PersistentUserSessionAdapter

public PersistentUserSessionAdapter(KeycloakSession session,
 PersistentUserSessionModel model,
 RealmModel realm,
 String userId,
 Map<String,AuthenticatedClientSessionModel> clientSessions)

Method Details

getUpdatedModel

public PersistentUserSessionModel getUpdatedModel()

getId

public String getId()

Specified by:

getId in interface UserSessionModel

getBrokerSessionId

public String getBrokerSessionId()

Description copied from interface: UserSessionModel

If created via a broker external login, this is an identifier that can be used to match external broker backchannel logout requests to a UserSession

Specified by:

getBrokerSessionId in interface UserSessionModel

Returns:

getBrokerUserId

public String getBrokerUserId()

Specified by:

getBrokerUserId in interface UserSessionModel

getUser

public UserModel getUser()

Specified by:

getUser in interface UserSessionModel

getUserId

public String getUserId()

Specified by:

getUserId in interface OfflineUserSessionModel

getRealm

public RealmModel getRealm()

Specified by:

getRealm in interface UserSessionModel

getLoginUsername

public String getLoginUsername()

Specified by:

getLoginUsername in interface UserSessionModel

getIpAddress

public String getIpAddress()

Description copied from interface: UserSessionModel

Note: will not be an address when a proxy does not provide a valid one

Specified by:

getIpAddress in interface UserSessionModel

Returns:

the ip address

getAuthMethod

public String getAuthMethod()

Specified by:

getAuthMethod in interface UserSessionModel

isRememberMe

public boolean isRememberMe()

Specified by:

isRememberMe in interface UserSessionModel

getStarted

public int getStarted()

Specified by:

getStarted in interface UserSessionModel

getLastSessionRefresh

public int getLastSessionRefresh()

Specified by:

getLastSessionRefresh in interface UserSessionModel

setLastSessionRefresh

public void setLastSessionRefresh(int seconds)

Description copied from interface: UserSessionModel

Set the last session refresh timestamp for the user session. If the timestamp is smaller or equal than the current timestamp, the operation is ignored.

Specified by:

setLastSessionRefresh in interface UserSessionModel

isOffline

public boolean isOffline()

Specified by:

isOffline in interface UserSessionModel

getAuthenticatedClientSessions

public Map<String,AuthenticatedClientSessionModel> getAuthenticatedClientSessions()

Description copied from interface: UserSessionModel

Returns map where key is ID of the client (its UUID) and value is ID respective AuthenticatedClientSessionModel object.

Any direct modification via the Map interface will throw an UnsupportedOperationException. To add a new mapping, use a method like UserSessionProvider.createClientSession(RealmModel, ClientModel, UserSessionModel) or equivalent. To remove a mapping, use AuthenticatedClientSessionModel.detachFromUserSession().

Specified by:

getAuthenticatedClientSessions in interface UserSessionModel

removeAuthenticatedClientSessions

public void removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)

Description copied from interface: UserSessionModel

Removes authenticated client sessions for all clients whose UUID is present in removedClientUUIDS parameter.

Specified by:

removeAuthenticatedClientSessions in interface UserSessionModel

getNote

public String getNote(String name)

Specified by:

getNote in interface UserSessionModel

setNote

public void setNote(String name,
 String value)

Specified by:

setNote in interface UserSessionModel

removeNote

public void removeNote(String name)

Specified by:

removeNote in interface UserSessionModel

getNotes

public Map<String,String> getNotes()

Specified by:

getNotes in interface UserSessionModel

getState

public UserSessionModel.State getState()

Specified by:

getState in interface UserSessionModel

setState

public void setState(UserSessionModel.State state)

Specified by:

setState in interface UserSessionModel

restartSession

public void restartSession(RealmModel realm,
 UserModel user,
 String loginUsername,
 String ipAddress,
 String authMethod,
 boolean rememberMe,
 String brokerSessionId,
 String brokerUserId)

Specified by:

restartSession in interface UserSessionModel

setLoginUsername

public void setLoginUsername(String loginUsername)

Specified by:

setLoginUsername in interface OfflineUserSessionModel

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

setRealm

public void setRealm(RealmModel realm)

setUser

public void setUser(UserModel user)

setIpAddress

public void setIpAddress(String ipAddress)

setAuthMethod

public void setAuthMethod(String authMethod)

setRememberMe

public void setRememberMe(boolean rememberMe)

setStarted

public void setStarted(int started)

setBrokerSessionId

public void setBrokerSessionId(String brokerSessionId)

setBrokerUserId

public void setBrokerUserId(String brokerUserId)

setClientSessionsLoader

public void setClientSessionsLoader(Consumer<Map<String,AuthenticatedClientSessionModel>> clientSessionsLoader)