Package org.keycloak.authentication.jpa

Class JpaAuthenticationSessionProvider

java.lang.Object

org.keycloak.models.AbstractKeycloakTransaction

org.keycloak.authentication.jpa.JpaAuthenticationSessionProvider

All Implemented Interfaces:

KeycloakTransaction, Provider, AuthenticationSessionProvider

public class JpaAuthenticationSessionProvider
extends AbstractKeycloakTransaction
implements AuthenticationSessionProvider

Nested Class Summary

Nested classes/interfaces inherited from class org.keycloak.models.AbstractKeycloakTransaction

AbstractKeycloakTransaction.TransactionState

Field Summary

Fields inherited from class org.keycloak.models.AbstractKeycloakTransaction

state

Constructor Summary

Constructors

Constructor	Description
JpaAuthenticationSessionProvider(KeycloakSession session, int authSessionsLimit)

Method Summary

Modifier and Type	Method	Description
void	close()
protected void	commitImpl()
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 id)	Returns the root authentication session specified by the provided realm and id.
void	onRealmRemoved(RealmModel realm)	Removes all associated root authentication sessions to the given realm which was removed.
void	removeRootAuthenticationSession(RealmModel realm, RootAuthenticationSessionModel authenticationSession)	Removes provided root authentication session.
protected void	rollbackImpl()

Methods inherited from class org.keycloak.models.AbstractKeycloakTransaction

begin, beginImpl, commit, getRollbackOnly, getState, isActive, rollback, setRollbackOnly

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.keycloak.sessions.AuthenticationSessionProvider

migrate, onClientRemoved, removeAllExpired, removeExpired, updateNonlocalSessionAuthNotes

Constructor Details

JpaAuthenticationSessionProvider

public JpaAuthenticationSessionProvider(KeycloakSession session,
 int authSessionsLimit)

Method Details

createRootAuthenticationSession

public RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm)

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 interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

Returns:

Returns created RootAuthenticationSessionModel. Never returns null.

createRootAuthenticationSession

public RootAuthenticationSessionModel createRootAuthenticationSession(RealmModel realm,
 String id)

Description copied from interface: AuthenticationSessionProvider

Creates a new root authentication session specified by the provided realm and id.

Specified by:

createRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

id - String Id of newly created root authentication session. If null a random id will be generated.

Returns:

Returns created RootAuthenticationSessionModel. Never returns null.

getRootAuthenticationSession

public RootAuthenticationSessionModel getRootAuthenticationSession(RealmModel realm,
 String id)

Description copied from interface: AuthenticationSessionProvider

Returns the root authentication session specified by the provided realm and id.

Specified by:

getRootAuthenticationSession in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

id - RootAuthenticationSessionModel If null then null will be returned.

Returns:

Returns found RootAuthenticationSessionModel or null 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 interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Associated realm to the given root authentication session.

authenticationSession - RootAuthenticationSessionModel Can't be null.

onRealmRemoved

public void onRealmRemoved(RealmModel realm)

Description copied from interface: AuthenticationSessionProvider

Removes all associated root authentication sessions to the given realm which was removed.

Specified by:

onRealmRemoved in interface AuthenticationSessionProvider

Parameters:

realm - RealmModel Can't be null.

close

public void close()

Specified by:

close in interface Provider

commitImpl

protected void commitImpl()

Specified by:

commitImpl in class AbstractKeycloakTransaction

rollbackImpl

protected void rollbackImpl()

Specified by:

rollbackImpl in class AbstractKeycloakTransaction