org.keycloak.sessions

Interface AuthenticationSessionProvider

All Superinterfaces:

Provider

public interface AuthenticationSessionProvider
extends Provider

Author:

Marek Posolda

Method Summary

Modifier and Type	Method and Description
AuthenticationSessionModel	createAuthenticationSession(RealmModel realm, ClientModel client) Creates and registers a new authentication session with random ID.
AuthenticationSessionModel	createAuthenticationSession(String id, RealmModel realm, ClientModel client)
AuthenticationSessionModel	getAuthenticationSession(RealmModel realm, String authenticationSessionId)
void	onClientRemoved(RealmModel realm, ClientModel client)
void	onRealmRemoved(RealmModel realm)
void	removeAuthenticationSession(RealmModel realm, AuthenticationSessionModel authenticationSession)
void	removeExpired(RealmModel realm)
void	updateNonlocalSessionAuthNotes(String authSessionId, Map<String,String> authNotesFragment) Requests update of authNotes of an 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

createAuthenticationSession

AuthenticationSessionModel createAuthenticationSession(RealmModel realm,
                                                       ClientModel client)

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

createAuthenticationSession

AuthenticationSessionModel createAuthenticationSession(String id,
                                                       RealmModel realm,
                                                       ClientModel client)

getAuthenticationSession

AuthenticationSessionModel getAuthenticationSession(RealmModel realm,
                                                    String authenticationSessionId)

removeAuthenticationSession

void removeAuthenticationSession(RealmModel realm,
                                 AuthenticationSessionModel authenticationSession)

removeExpired

void removeExpired(RealmModel realm)

onRealmRemoved

void onRealmRemoved(RealmModel realm)

onClientRemoved

void onClientRemoved(RealmModel realm,
                     ClientModel client)

updateNonlocalSessionAuthNotes

void updateNonlocalSessionAuthNotes(String authSessionId,
                                    Map<String,String> authNotesFragment)

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

Parameters:

authSessionId -

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