Package org.keycloak.sessions
Interface AuthenticationSessionProvider
-
- All Superinterfaces:
Provider
- All Known Implementing Classes:
InfinispanAuthenticationSessionProvider
,MapRootAuthenticationSessionProvider
public interface AuthenticationSessionProvider extends Provider
- Author:
- Marek Posolda
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description 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()
Deprecated.manual removal of expired entities should not be used anymore.void
removeExpired(RealmModel realm)
Deprecated.manual removal of expired entities should not be used anymore.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.
-
-
-
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.- Parameters:
realm
-RealmModel
Can't benull
.- Returns:
- Returns created
RootAuthenticationSessionModel
. Never returnsnull
.
-
createRootAuthenticationSession
RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm, String id)
Creates a new root authentication session specified by the provided realm and id.- Parameters:
realm
-RealmModel
Can't benull
.id
-String
Id of newly created root authentication session. Ifnull
a random id will be generated.- Returns:
- Returns created
RootAuthenticationSessionModel
. Never returnsnull
.
-
getRootAuthenticationSession
RootAuthenticationSessionModel getRootAuthenticationSession(RealmModel realm, String authenticationSessionId)
Returns the root authentication session specified by the provided realm and id.- Parameters:
realm
-RealmModel
Can't benull
.authenticationSessionId
-RootAuthenticationSessionModel
Ifnull
thennull
will be returned.- Returns:
- Returns found
RootAuthenticationSessionModel
ornull
if no root authentication session is found.
-
removeRootAuthenticationSession
void removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)
Removes provided root authentication session.- Parameters:
realm
-RealmModel
Associated realm to the given root authentication session.authenticationSession
-RootAuthenticationSessionModel
Can't benull
.
-
removeAllExpired
void removeAllExpired()
Deprecated.manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entitiesRemove expired authentication sessions in all the realms
-
removeExpired
void removeExpired(RealmModel realm)
Deprecated.manual removal of expired entities should not be used anymore. It is responsibility of the store implementation to handle expirable entitiesRemoves all expired root authentication sessions for the given realm.- Parameters:
realm
-RealmModel
Can't benull
.
-
onRealmRemoved
void onRealmRemoved(RealmModel realm)
Removes all associated root authentication sessions to the given realm which was removed.- Parameters:
realm
-RealmModel
Can't benull
.
-
onClientRemoved
void onClientRemoved(RealmModel realm, ClientModel client)
Removes all associated root authentication sessions to the given realm and client which was removed.- Parameters:
realm
-RealmModel
Can't benull
.client
-ClientModel
Can't benull
.
-
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
-AuthenticationSessionCompoundId
The method has no effect ifnull
.authNotesFragment
-Map<String, String>
Map with authNote values. Auth note is removed if the corresponding value in the map isnull
. Map itself can't benull
.
-
-