public interface AuthenticationSessionProvider extends Provider
Modifier and Type | Method and 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.
|
default RootAuthenticationSessionModel |
createRootAuthenticationSession(String id,
RealmModel realm)
Deprecated.
Use
createRootAuthenticationSession(RealmModel, String) createRootAuthenticationSession} instead. |
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.
|
RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm)
realm
- RealmModel
Can't be null
.RootAuthenticationSessionModel
. Never returns null
.@Deprecated default RootAuthenticationSessionModel createRootAuthenticationSession(String id, RealmModel realm)
createRootAuthenticationSession(RealmModel, String)
createRootAuthenticationSession} instead.id
- String
Id of newly created root authentication session. If null
a random id will be generated.realm
- RealmModel
Can't be null
.RootAuthenticationSessionModel
. Never returns null
.RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm, String id)
realm
- RealmModel
Can't be null
.id
- String
Id of newly created root authentication session. If null
a random id will be generated.RootAuthenticationSessionModel
. Never returns null
.RootAuthenticationSessionModel getRootAuthenticationSession(RealmModel realm, String authenticationSessionId)
realm
- RealmModel
Can't be null
.authenticationSessionId
- RootAuthenticationSessionModel
If null
then null
will be returned.RootAuthenticationSessionModel
or null
if no root authentication session is found.void removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)
realm
- RealmModel
Associated realm to the given root authentication session.authenticationSession
- RootAuthenticationSessionModel
Can't be null
.void removeAllExpired()
void removeExpired(RealmModel realm)
realm
- RealmModel
Can't be null
.void onRealmRemoved(RealmModel realm)
realm
- RealmModel
Can't be null
.void onClientRemoved(RealmModel realm, ClientModel client)
realm
- RealmModel
Can't be null
.client
- ClientModel
Can't be null
.void updateNonlocalSessionAuthNotes(AuthenticationSessionCompoundId compoundId, Map<String,String> authNotesFragment)
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
.Copyright © 2021 JBoss by Red Hat. All rights reserved.