Package org.keycloak.models.map.authSession

Class MapRootAuthenticationSessionProvider

java.lang.Object

org.keycloak.models.map.authSession.MapRootAuthenticationSessionProvider

All Implemented Interfaces:

Provider, AuthenticationSessionProvider

public class MapRootAuthenticationSessionProvider
extends Object
implements AuthenticationSessionProvider

Author:

Martin Kanis

Field Summary

Fields

Modifier and Type	Field	Description
protected MapStorage<MapRootAuthenticationSessionEntity,RootAuthenticationSessionModel>	store

Constructor Summary

Constructors

Constructor	Description
MapRootAuthenticationSessionProvider(KeycloakSession session, MapStorage<MapRootAuthenticationSessionEntity,RootAuthenticationSessionModel> sessionStore, int authSessionsLimit)

Method Summary

Modifier and Type	Method	Description
void	close()
RootAuthenticationSessionModel	createRootAuthenticationSession(RealmModel realm)	Creates and registers a new authentication session with random ID.
RootAuthenticationSessionModel	createRootAuthenticationSession(RealmModel realm, String id)	Creates a new root authentication session specified by the provided realm and id.
RootAuthenticationSessionModel	getRootAuthenticationSession(RealmModel realm, String authenticationSessionId)	Returns the root authentication session specified by the provided realm and id.
void	onClientRemoved(RealmModel realm, ClientModel client)	Removes all associated root authentication sessions to the given realm and client which was removed.
void	onRealmRemoved(RealmModel realm)	Removes all associated root authentication sessions to the given realm which was removed.
void	removeAllExpired()	Remove expired authentication sessions in all the realms
void	removeExpired(RealmModel realm)	Removes all expired root authentication sessions for the given realm.
void	removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)	Removes provided root authentication session.
void	updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId compoundId, Map<String,String> authNotesFragment)	Requests update of authNotes of a root authentication session that is not owned by this instance but might exist somewhere in the cluster.

Methods inherited from class java.lang.Object

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

Field Detail

store

protected final MapStorage<MapRootAuthenticationSessionEntity,RootAuthenticationSessionModel> store

Constructor Detail

MapRootAuthenticationSessionProvider

public MapRootAuthenticationSessionProvider(KeycloakSession session,
                                            MapStorage<MapRootAuthenticationSessionEntity,RootAuthenticationSessionModel> sessionStore,
                                            int authSessionsLimit)

Method Detail

createRootAuthenticationSession

public RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm)

Description copied from interface: AuthenticationSessionProvider

Creates and registers a new authentication session with random ID. Authentication session entity will be prefilled with current timestamp, the given realm and client.

Specified by:

createRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

Returns:

Returns created RootAuthenticationSessionModel. Never returns null.

createRootAuthenticationSession

public RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm,
                                                                      String id)

Description copied from interface: AuthenticationSessionProvider

Creates a new root authentication session specified by the provided realm and id.

Specified by:

createRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

id - String Id of newly created root authentication session. If null a random id will be generated.

Returns:

Returns created RootAuthenticationSessionModel. Never returns null.

getRootAuthenticationSession

public RootAuthenticationSessionModel getRootAuthenticationSession(RealmModel realm,
                                                                   String authenticationSessionId)

Description copied from interface: AuthenticationSessionProvider

Returns the root authentication session specified by the provided realm and id.

Specified by:

getRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

authenticationSessionId - RootAuthenticationSessionModel If null then null will be returned.

Returns:

Returns found RootAuthenticationSessionModel or null if no root authentication session is found.

removeRootAuthenticationSession

public void removeRootAuthenticationSession(RealmModel realm,
                                            RootAuthenticationSessionModel authenticationSession)

Description copied from interface: AuthenticationSessionProvider

Removes provided root authentication session.

Specified by:

removeRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Associated realm to the given root authentication session.

authenticationSession - RootAuthenticationSessionModel Can't be null.

removeAllExpired

public void removeAllExpired()

Description copied from interface: AuthenticationSessionProvider

Remove expired authentication sessions in all the realms

Specified by:

removeAllExpired in interface AuthenticationSessionProvider

removeExpired

public void removeExpired(RealmModel realm)

Description copied from interface: AuthenticationSessionProvider

Removes all expired root authentication sessions for the given realm.

Specified by:

removeExpired in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

onRealmRemoved

public void onRealmRemoved(RealmModel realm)

Description copied from interface: AuthenticationSessionProvider

Removes all associated root authentication sessions to the given realm which was removed.

Specified by:

onRealmRemoved in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

onClientRemoved

public void onClientRemoved(RealmModel realm,
                            ClientModel client)

Description copied from interface: AuthenticationSessionProvider

Removes all associated root authentication sessions to the given realm and client which was removed.

Specified by:

onClientRemoved in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

client - ClientModel Can't be null.

updateNonlocalSessionAuthNotes

public void updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId compoundId,
                                           Map<String,String> authNotesFragment)

Description copied from interface: AuthenticationSessionProvider

Requests update of authNotes of a root authentication session that is not owned by this instance but might exist somewhere in the cluster.

Specified by:

updateNonlocalSessionAuthNotes in interface AuthenticationSessionProvider

Parameters:

compoundId - AuthenticationSessionCompoundId The method has no effect if null.

authNotesFragment - Map<String, String> Map with authNote values. Auth note is removed if the corresponding value in the map is null. Map itself can't be null.

close

public void close()

Specified by:

close in interface Provider