org.keycloak.sessions

Interface RootAuthenticationSessionModel

public interface RootAuthenticationSessionModel

Represents usually one browser session with potentially many browser tabs. Every browser tab is represented by AuthenticationSessionModel of different client.

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
AuthenticationSessionModel	createAuthenticationSession(ClientModel client) Create new authentication session and returns it.
AuthenticationSessionModel	getAuthenticationSession(ClientModel client, String tabId)
Map<String,AuthenticationSessionModel>	getAuthenticationSessions() Key is tabId, Value is AuthenticationSessionModel.
String	getId()
RealmModel	getRealm()
int	getTimestamp()
void	restartSession(RealmModel realm) Will completely restart whole state of authentication session.
void	setTimestamp(int timestamp)

Method Detail

getId

String getId()

getRealm

RealmModel getRealm()

getTimestamp

int getTimestamp()

setTimestamp

void setTimestamp(int timestamp)

getAuthenticationSessions

Map<String,AuthenticationSessionModel> getAuthenticationSessions()

Key is tabId, Value is AuthenticationSessionModel.

Returns:

authentication sessions or empty map if no authenticationSessions presents. Never return null.

getAuthenticationSession

AuthenticationSessionModel getAuthenticationSession(ClientModel client,
                                                    String tabId)

Returns:

authentication session for particular client and tab or null if it doesn't yet exists.

createAuthenticationSession

AuthenticationSessionModel createAuthenticationSession(ClientModel client)

Create new authentication session and returns it. Overwrites existing session for particular client if already exists.

Parameters:

client -

Returns:

non-null fresh authentication session

restartSession

void restartSession(RealmModel realm)

Will completely restart whole state of authentication session. It will just keep same ID. It will setup it with provided realm.