org.keycloak.models.sessions.infinispan.initializer

Interface SessionLoader

All Known Implementing Classes:

OfflinePersistentUserSessionLoader, RemoteCacheSessionsLoader

public interface SessionLoader

Author:

Marek Posolda

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.

Method Detail

init

void init(KeycloakSession session)

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!

Parameters:

session -

getSessionsCount

int getSessionsCount(KeycloakSession session)

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

Parameters:

session -

Returns:

loadSessions

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

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

Parameters:

session -

first -

max -

Returns:

isFinished

boolean isFinished(BaseCacheInitializer initializer)

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

Parameters:

initializer -

Returns:

afterAllSessionsLoaded

void afterAllSessionsLoaded(BaseCacheInitializer initializer)

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

Parameters:

initializer -