Package org.keycloak.models

Interface UserSessionModel

All Known Subinterfaces:

OfflineUserSessionModel

All Known Implementing Classes:

PersistentUserSessionAdapter, UserSessionAdapter, UserSessionModelDelegate, UserSessionUpdater

public interface UserSessionModel

Author:

Stian Thorgersen

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	UserSessionModel.SessionPersistenceState	Flag used when creating user session
static enum	UserSessionModel.State

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CORRESPONDING_SESSION_ID	Represents the corresponding online/offline user session.

Method Summary

Modifier and Type	Method	Description
default AuthenticatedClientSessionModel	getAuthenticatedClientSessionByClient(String clientUUID)	Returns a client session for the given client UUID.
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()
default UserSessionModel.SessionPersistenceState	getPersistenceState()
RealmModel	getRealm()
int	getStarted()
UserSessionModel.State	getState()
UserModel	getUser()
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	setLastSessionRefresh(int seconds)	Set the last session refresh timestamp for the user session.
void	setNote(String name, String value)
void	setState(UserSessionModel.State state)

Field Details

CORRESPONDING_SESSION_ID

static final String CORRESPONDING_SESSION_ID

Represents the corresponding online/offline user session.

See Also:

• Constant Field Values

Method Details

getId

String getId()

getRealm

RealmModel getRealm()

getBrokerSessionId

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

Returns:

getBrokerUserId

String getBrokerUserId()

getUser

UserModel getUser()

getLoginUsername

String getLoginUsername()

getIpAddress

String getIpAddress()

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

Returns:

the ip address

getAuthMethod

String getAuthMethod()

isRememberMe

boolean isRememberMe()

getStarted

int getStarted()

getLastSessionRefresh

int getLastSessionRefresh()

setLastSessionRefresh

void setLastSessionRefresh(int seconds)

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.

isOffline

boolean isOffline()

getAuthenticatedClientSessions

Map<String,AuthenticatedClientSessionModel> getAuthenticatedClientSessions()

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().

getAuthenticatedClientSessionByClient

default AuthenticatedClientSessionModel getAuthenticatedClientSessionByClient(String clientUUID)

Returns a client session for the given client UUID.

Returns:

removeAuthenticatedClientSessions

void removeAuthenticatedClientSessions(Collection<String> removedClientUUIDS)

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

Parameters:

removedClientUUIDS -

getNote

String getNote(String name)

setNote

void setNote(String name,
 String value)

removeNote

void removeNote(String name)

getNotes

Map<String,String> getNotes()

getState

UserSessionModel.State getState()

setState

void setState(UserSessionModel.State state)

restartSession

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

getPersistenceState

default UserSessionModel.SessionPersistenceState getPersistenceState()

Returns:

Persistence state of the session