Package org.keycloak.sessions
Interface RootAuthenticationSessionModel
- All Known Implementing Classes:
RootAuthenticationSessionAdapter
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 TypeMethodDescriptionCreate a new authentication session and returns it.getAuthenticationSession
(ClientModel client, String tabId) Returns an authentication session for the particular client and tab or null if it doesn't yet exists.Returns authentication sessions for the root authentication session.getId()
Returns id of the root authentication session.getRealm()
Returns realm associated to the root authentication session.int
Returns timestamp when the root authentication session was created or updated.void
Removes the authentication session specified by tab id from the root authentication session.void
restartSession
(RealmModel realm) Will completely restart whole state of authentication session.void
setTimestamp
(int timestamp) Sets a timestamp when the root authentication session was created or updated.
-
Method Details
-
getId
String getId()Returns id of the root authentication session.- Returns:
String
-
getRealm
RealmModel getRealm()Returns realm associated to the root authentication session.- Returns:
RealmModel
-
getTimestamp
int getTimestamp()Returns timestamp when the root authentication session was created or updated.- Returns:
int
-
setTimestamp
void setTimestamp(int timestamp) Sets a timestamp when the root authentication session was created or updated. It also updates the expiration time for the root authentication session entity.- Parameters:
timestamp
-int
-
getAuthenticationSessions
Map<String,AuthenticationSessionModel> getAuthenticationSessions()Returns authentication sessions for the root authentication session. Key is tabId, Value is AuthenticationSessionModel.- Returns:
Map<String, AuthenticationSessionModel>
authentication sessions or empty map if no authentication sessions are present. Never return null.
-
getAuthenticationSession
Returns an authentication session for the particular client and tab or null if it doesn't yet exists.- Parameters:
client
-ClientModel
Ifnull
is provided the method will returnnull
.tabId
-String
Ifnull
is provided the method will returnnull
.- Returns:
AuthenticationSessionModel
ornull
in no authentication session is found.
-
createAuthenticationSession
Create a new authentication session and returns it.- Parameters:
client
-ClientModel
Can't benull
.- Returns:
AuthenticationSessionModel
non-null fresh authentication session. Never returnsnull
.
-
removeAuthenticationSessionByTabId
Removes the authentication session specified by tab id from the root authentication session. If there's no child authentication session left in the root authentication session, it's removed as well.- Parameters:
tabId
-String
Can't benull
.
-
restartSession
Will completely restart whole state of authentication session. It will just keep same ID. It will setup it with provided realm.- Parameters:
realm
-RealmModel
Associated realm to the root authentication session.
-