org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader クラス

org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader の継承関係図

org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader 連携図

公開メンバ関数
	OfflinePersistentUserSessionLoader (int sessionsPerSegment)
void	init (KeycloakSession session)
OfflinePersistentUserSessionLoaderContext	computeLoaderContext (KeycloakSession session)
boolean	loadSessions (KeycloakSession session, OfflinePersistentUserSessionLoaderContext ctx, int segment)
boolean	isFinished (BaseCacheInitializer initializer)
void	afterAllSessionsLoaded (BaseCacheInitializer initializer)
String	toString ()
boolean	loadSessions (KeycloakSession session, LOADER_CONTEXT loaderContext, int segment)

静的公開変数類
static final String	PERSISTENT_SESSIONS_LOADED = "PERSISTENT_SESSIONS_LOADED"
static final String	PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC = "PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC"

非公開変数類
final int	sessionsPerSegment

静的非公開変数類
static final Logger	log = Logger.getLogger(OfflinePersistentUserSessionLoader.class)

詳解

著者

Marek Posolda

構築子と解体子

OfflinePersistentUserSessionLoader()

org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.OfflinePersistentUserSessionLoader ( int  sessionsPerSegment )

inline

                                                                      {
        this.sessionsPerSegment = sessionsPerSegment;
    }

関数詳解

afterAllSessionsLoaded()

void org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.afterAllSessionsLoaded ( BaseCacheInitializer  initializer )

inline

                                                                         {
        Cache<String, Serializable> workCache = initializer.getWorkCache();

        // Will retry few times for the case when backup site not available in cross-dc environment.
        // The site might be taken offline automatically if "take-offline" properly configured
        Retry.executeWithBackoff((int iteration) -> {

            try {
                // Cross-DC aware flag
                workCache
                        .getAdvancedCache().withFlags(Flag.SKIP_REMOTE_LOOKUP)
                        .put(PERSISTENT_SESSIONS_LOADED, true);

            } catch (HotRodClientException re) {
                log.warnf(re, "Failed to write flag PERSISTENT_SESSIONS_LOADED in iteration '%d' . Retrying", iteration);

                // Rethrow the exception. Retry will take care of handle the exception and eventually retry the operation.
                throw re;
            }

        }, 10, 10);

        // Just local-DC aware flag
        workCache
                .getAdvancedCache().withFlags(Flag.SKIP_REMOTE_LOOKUP, Flag.SKIP_CACHE_LOAD, Flag.SKIP_CACHE_STORE)
                .put(PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC, true);


        log.debugf("Persistent sessions loaded successfully!");
    }

computeLoaderContext()

OfflinePersistentUserSessionLoaderContext org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.computeLoaderContext ( KeycloakSession  session )

inline

                                                                                                   {
        UserSessionPersisterProvider persister = session.getProvider(UserSessionPersisterProvider.class);
        int sessionsCount = persister.getUserSessionsCount(true);

        return new OfflinePersistentUserSessionLoaderContext(sessionsCount, sessionsPerSegment);
    }

init()

void org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.init ( KeycloakSession  session )

inline

                                              {
        UserSessionPersisterProvider persister = session.getProvider(UserSessionPersisterProvider.class);

        // TODO: check if update of timestamps in persister can be skipped entirely
        int clusterStartupTime = session.getProvider(ClusterProvider.class).getClusterStartupTime();

        log.debugf("Clearing detached sessions from persistent storage and updating timestamps to %d", clusterStartupTime);

        persister.clearDetachedUserSessions();
        persister.updateAllTimestamps(clusterStartupTime);
    }

isFinished()

boolean org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.isFinished ( BaseCacheInitializer  initializer )

inline

                                                                {
        Cache<String, Serializable> workCache = initializer.getWorkCache();
        Boolean sessionsLoaded = (Boolean) workCache.get(PERSISTENT_SESSIONS_LOADED);

        if (sessionsLoaded != null && sessionsLoaded) {
            log.debugf("Persistent sessions loaded already.");
            return true;
        } else {
            log.debugf("Persistent sessions not yet loaded.");
            return false;
        }
    }

loadSessions() [1/2]

boolean org.keycloak.models.sessions.infinispan.initializer.SessionLoader< LOADER_CONTEXT extends SessionLoader.LoaderContext >.loadSessions ( KeycloakSession  session, LOADER_CONTEXT  loaderContext, int  segment  )

inherited

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

引数

session
loaderContext	loaderContext object, which was already computed before
segment	to be computed

戻り値

loadSessions() [2/2]

boolean org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.loadSessions ( KeycloakSession  session, OfflinePersistentUserSessionLoaderContext  ctx, int  segment  )

inline

                                                                                                                     {
        int first = ctx.getSessionsPerSegment() * segment;
        int max = sessionsPerSegment;

        if (log.isTraceEnabled()) {
            log.tracef("Loading sessions - first: %d, max: %d", first, max);
        }

        UserSessionPersisterProvider persister = session.getProvider(UserSessionPersisterProvider.class);
        List<UserSessionModel> sessions = persister.loadUserSessions(first, max, true);

        for (UserSessionModel persistentSession : sessions) {

            // Save to memory/infinispan
            UserSessionModel offlineUserSession = session.sessions().importUserSession(persistentSession, true, true);
        }

        return true;
    }

toString()

String org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.toString ( )

inline

                             {
        return new StringBuilder("OfflinePersistentUserSessionLoader [ ")
                .append("sessionsPerSegment: ").append(sessionsPerSegment)
                .append(" ]")
                .toString();
    }

メンバ詳解

log

final Logger org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.log = Logger.getLogger(OfflinePersistentUserSessionLoader.class)

staticprivate

PERSISTENT_SESSIONS_LOADED

final String org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.PERSISTENT_SESSIONS_LOADED = "PERSISTENT_SESSIONS_LOADED"

static

PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC

final String org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC = "PERSISTENT_SESSIONS_LOADED_IN_CURRENT_DC"

static

sessionsPerSegment

final int org.keycloak.models.sessions.infinispan.initializer.OfflinePersistentUserSessionLoader.sessionsPerSegment

private

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/models/sessions/infinispan/initializer/OfflinePersistentUserSessionLoader.java