org.keycloak.models.sessions.infinispan.initializer

Class OfflinePersistentUserSessionLoader

java.lang.Object

org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader

All Implemented Interfaces:

Serializable, SessionLoader

public class OfflinePersistentUserSessionLoader
extends Object
implements SessionLoader, Serializable

Author:

Marek Posolda

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	PERSISTENT_SESSIONS_LOADED
static String	PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC

Constructor Summary

Constructors

Constructor and Description
OfflinePersistentUserSessionLoader()

Method Summary

Modifier and Type	Method and Description
void	afterAllSessionsLoaded(BaseCacheInitializer initializer) Callback triggered on cluster coordinator once it recognize that all sessions were successfully loaded
int	getSessionsCount(KeycloakSession session) Will be triggered just once on cluster coordinator node to count the number of sessions
void	init(KeycloakSession session) Will be triggered just once on cluster coordinator node to perform some generic initialization tasks (Eg.
boolean	isFinished(BaseCacheInitializer initializer) This will be called on nodes to check if loading is finished.
boolean	loadSessions(KeycloakSession session, int first, int max) Will be called on all cluster nodes to load the specified page.

Methods inherited from class java.lang.Object

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

Field Detail

PERSISTENT_SESSIONS_LOADED

public static final String PERSISTENT_SESSIONS_LOADED

See Also:

Constant Field Values

PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC

public static final String PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC

See Also:

Constant Field Values

Constructor Detail

OfflinePersistentUserSessionLoader

public OfflinePersistentUserSessionLoader()

Method Detail

init

public void init(KeycloakSession session)

Description copied from interface: SessionLoader

Will be triggered just once on cluster coordinator node to perform some generic initialization tasks (Eg. update DB before starting load). NOTE: This shouldn't be used for the initialization of loader instance itself!

Specified by:

init in interface SessionLoader

getSessionsCount

public int getSessionsCount(KeycloakSession session)

Description copied from interface: SessionLoader

Will be triggered just once on cluster coordinator node to count the number of sessions

Specified by:

getSessionsCount in interface SessionLoader

Returns:

loadSessions

public boolean loadSessions(KeycloakSession session,
                            int first,
                            int max)

Description copied from interface: SessionLoader

Will be called on all cluster nodes to load the specified page.

Specified by:

loadSessions in interface SessionLoader

Returns:

isFinished

public boolean isFinished(BaseCacheInitializer initializer)

Description copied from interface: SessionLoader

This will be called on nodes to check if loading is finished. It allows loader to notify that loading is finished for some reason.

Specified by:

isFinished in interface SessionLoader

Returns:

afterAllSessionsLoaded

public void afterAllSessionsLoaded(BaseCacheInitializer initializer)

Description copied from interface: SessionLoader

Callback triggered on cluster coordinator once it recognize that all sessions were successfully loaded

Specified by:

afterAllSessionsLoaded in interface SessionLoader