org.keycloak.sessions

Interface AuthenticationSessionProvider

All Superinterfaces:

Provider

public interface AuthenticationSessionProvider
extends Provider

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
RootAuthenticationSessionModel	createRootAuthenticationSession(RealmModel realm) Creates and registers a new authentication session with random ID.
RootAuthenticationSessionModel	createRootAuthenticationSession(String id, RealmModel realm)
RootAuthenticationSessionModel	getRootAuthenticationSession(RealmModel realm, String authenticationSessionId)
void	onClientRemoved(RealmModel realm, ClientModel client)
void	onRealmRemoved(RealmModel realm)
void	removeExpired(RealmModel realm)
void	removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)
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 interface org.keycloak.provider.Provider

close

Method Detail

createRootAuthenticationSession

RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm)

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

createRootAuthenticationSession

RootAuthenticationSessionModel createRootAuthenticationSession(String id,
                                                               RealmModel realm)

getRootAuthenticationSession

RootAuthenticationSessionModel getRootAuthenticationSession(RealmModel realm,
                                                            String authenticationSessionId)

removeRootAuthenticationSession

void removeRootAuthenticationSession(RealmModel realm,
                                     RootAuthenticationSessionModel authenticationSession)

removeExpired

void removeExpired(RealmModel realm)

onRealmRemoved

void onRealmRemoved(RealmModel realm)

onClientRemoved

void onClientRemoved(RealmModel realm,
                     ClientModel client)

updateNonlocalSessionAuthNotes

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.

Parameters:

compoundId -

authNotesFragment - Map with authNote values. Auth note is removed if the corresponding value in the map is null.