Class RemoteInfinispanAuthenticationSessionProvider
java.lang.Object
org.keycloak.models.sessions.infinispan.remote.RemoteInfinispanAuthenticationSessionProvider
- All Implemented Interfaces:
Provider
,AuthenticationSessionProvider
public class RemoteInfinispanAuthenticationSessionProvider
extends Object
implements AuthenticationSessionProvider
-
Constructor Summary
ConstructorDescriptionRemoteInfinispanAuthenticationSessionProvider
(KeycloakSession session, int authSessionsLimit, AuthenticationSessionTransaction transaction) -
Method Summary
Modifier and TypeMethodDescriptionvoid
close()
Creates and registers a new authentication session with random ID.createRootAuthenticationSession
(RealmModel realm, String id) Creates a new root authentication session specified by the provided realm and id.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
Remove expired authentication sessions in all the realmsvoid
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.
-
Constructor Details
-
RemoteInfinispanAuthenticationSessionProvider
public RemoteInfinispanAuthenticationSessionProvider(KeycloakSession session, int authSessionsLimit, AuthenticationSessionTransaction transaction)
-
-
Method Details
-
close
public void close() -
createRootAuthenticationSession
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 interfaceAuthenticationSessionProvider
- Parameters:
realm
-RealmModel
Can't benull
.- Returns:
- Returns created
RootAuthenticationSessionModel
. Never returnsnull
.
-
createRootAuthenticationSession
Description copied from interface:AuthenticationSessionProvider
Creates a new root authentication session specified by the provided realm and id.- Specified by:
createRootAuthenticationSession
in interfaceAuthenticationSessionProvider
- 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
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 interfaceAuthenticationSessionProvider
- 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
public void removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession) Description copied from interface:AuthenticationSessionProvider
Removes provided root authentication session.- Specified by:
removeRootAuthenticationSession
in interfaceAuthenticationSessionProvider
- Parameters:
realm
-RealmModel
Associated realm to the given root authentication session.authenticationSession
-RootAuthenticationSessionModel
Can't benull
.
-
removeAllExpired
public void removeAllExpired()Description copied from interface:AuthenticationSessionProvider
Remove expired authentication sessions in all the realms- Specified by:
removeAllExpired
in interfaceAuthenticationSessionProvider
-
removeExpired
Description copied from interface:AuthenticationSessionProvider
Removes all expired root authentication sessions for the given realm.- Specified by:
removeExpired
in interfaceAuthenticationSessionProvider
- Parameters:
realm
-RealmModel
Can't benull
.
-
onRealmRemoved
Description copied from interface:AuthenticationSessionProvider
Removes all associated root authentication sessions to the given realm which was removed.- Specified by:
onRealmRemoved
in interfaceAuthenticationSessionProvider
- Parameters:
realm
-RealmModel
Can't benull
.
-
onClientRemoved
Description copied from interface:AuthenticationSessionProvider
Removes all associated root authentication sessions to the given realm and client which was removed.- Specified by:
onClientRemoved
in interfaceAuthenticationSessionProvider
- Parameters:
realm
-RealmModel
Can't benull
.client
-ClientModel
Can't benull
.
-
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 interfaceAuthenticationSessionProvider
- 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
.
-