org.keycloak.models.sessions.infinispan.UserSessionAdapter クラス

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

org.keycloak.models.sessions.infinispan.UserSessionAdapter 連携図

公開メンバ関数
	UserSessionAdapter (KeycloakSession session, InfinispanUserSessionProvider provider, InfinispanChangelogBasedTransaction< String, UserSessionEntity > userSessionUpdateTx, InfinispanChangelogBasedTransaction< UUID, AuthenticatedClientSessionEntity > clientSessionUpdateTx, RealmModel realm, UserSessionEntity entity, boolean offline)
Map< String, AuthenticatedClientSessionModel >	getAuthenticatedClientSessions ()
AuthenticatedClientSessionModel	getAuthenticatedClientSessionByClient (String clientUUID)
void	removeAuthenticatedClientSessions (Collection< String > removedClientUUIDS)
String	getId ()
RealmModel	getRealm ()
String	getBrokerSessionId ()
String	getBrokerUserId ()
UserModel	getUser ()
String	getLoginUsername ()
String	getIpAddress ()
String	getAuthMethod ()
boolean	isRememberMe ()
int	getStarted ()
int	getLastSessionRefresh ()
void	setLastSessionRefresh (int lastSessionRefresh)
boolean	isOffline ()
String	getNote (String name)
void	setNote (String name, String value)
void	removeNote (String name)
Map< String, String >	getNotes ()
State	getState ()
void	setState (State state)
void	restartSession (RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId)
boolean	equals (Object o)
int	hashCode ()

関数
UserSessionEntity	getEntity ()
void	update (UserSessionUpdateTask task)

非公開変数類
final KeycloakSession	session
final InfinispanUserSessionProvider	provider
final InfinispanChangelogBasedTransaction< String, UserSessionEntity >	userSessionUpdateTx
final InfinispanChangelogBasedTransaction< UUID, AuthenticatedClientSessionEntity >	clientSessionUpdateTx
final RealmModel	realm
final UserSessionEntity	entity
final boolean	offline

静的非公開変数類
static final int	MINIMUM_INACTIVE_CLIENT_SESSIONS_TO_CLEANUP = 5

詳解

著者

Stian Thorgersen

構築子と解体子

UserSessionAdapter()

org.keycloak.models.sessions.infinispan.UserSessionAdapter.UserSessionAdapter ( KeycloakSession  session, InfinispanUserSessionProvider  provider, InfinispanChangelogBasedTransaction< String, UserSessionEntity >  userSessionUpdateTx, InfinispanChangelogBasedTransaction< UUID, AuthenticatedClientSessionEntity >  clientSessionUpdateTx, RealmModel  realm, UserSessionEntity  entity, boolean  offline  )

inline

                                                                                           {
        this.session = session;
        this.provider = provider;
        this.userSessionUpdateTx = userSessionUpdateTx;
        this.clientSessionUpdateTx = clientSessionUpdateTx;
        this.realm = realm;
        this.entity = entity;
        this.offline = offline;
    }

関数詳解

equals()

boolean org.keycloak.models.sessions.infinispan.UserSessionAdapter.equals ( Object  o )

inline

                                    {
        if (this == o) return true;
        if (o == null || !(o instanceof UserSessionModel)) return false;

        UserSessionModel that = (UserSessionModel) o;
        return that.getId().equals(getId());
    }

getAuthenticatedClientSessionByClient()

AuthenticatedClientSessionModel org.keycloak.models.sessions.infinispan.UserSessionAdapter.getAuthenticatedClientSessionByClient ( String  clientUUID )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                                                                    {
        AuthenticatedClientSessionStore clientSessionEntities = entity.getAuthenticatedClientSessions();
        final UUID clientSessionId = clientSessionEntities.get(clientUUID);

        if (clientSessionId == null) {
            return null;
        }

        ClientModel client = realm.getClientById(clientUUID);

        if (client != null) {
            return provider.getClientSession(this, client, clientSessionId, offline);
        }

        removeAuthenticatedClientSessions(Collections.singleton(clientUUID));
        return null;
    }

getAuthenticatedClientSessions()

Map<String, AuthenticatedClientSessionModel> org.keycloak.models.sessions.infinispan.UserSessionAdapter.getAuthenticatedClientSessions ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                                                         {
        AuthenticatedClientSessionStore clientSessionEntities = entity.getAuthenticatedClientSessions();
        Map<String, AuthenticatedClientSessionModel> result = new HashMap<>();

        List<String> removedClientUUIDS = new LinkedList<>();

        if (clientSessionEntities != null) {
            clientSessionEntities.forEach((String key, UUID value) -> {
                // Check if client still exists
                ClientModel client = realm.getClientById(key);
                if (client != null) {
                    final AuthenticatedClientSessionAdapter clientSession = provider.getClientSession(this, client, value, offline);
                    if (clientSession != null) {
                        result.put(key, clientSession);
                    }
                } else {
                    removedClientUUIDS.add(key);
                }
            });
        }

        removeAuthenticatedClientSessions(removedClientUUIDS);

        return Collections.unmodifiableMap(result);
    }

getAuthMethod()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getAuthMethod ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                  {
        return entity.getAuthMethod();
    }

getBrokerSessionId()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getBrokerSessionId ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                       {
        return entity.getBrokerSessionId();
    }

getBrokerUserId()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getBrokerUserId ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                    {
        return entity.getBrokerUserId();
    }

getEntity()

UserSessionEntity org.keycloak.models.sessions.infinispan.UserSessionAdapter.getEntity ( )

inlinepackage

                                  {
        return entity;
    }

getId()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getId ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                          {
        return entity.getId();
    }

getIpAddress()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getIpAddress ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                 {
        return entity.getIpAddress();
    }

getLastSessionRefresh()

int org.keycloak.models.sessions.infinispan.UserSessionAdapter.getLastSessionRefresh ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                       {
        return entity.getLastSessionRefresh();
    }

getLoginUsername()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getLoginUsername ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                     {
        if (entity.getLoginUsername() == null) {
            // this is a hack so that UserModel doesn't have to be available when offline token is imported.
            // see related JIRA - KEYCLOAK-5350 and corresponding test
            return getUser().getUsername();
        } else {
            return entity.getLoginUsername();
        }
    }

getNote()

String org.keycloak.models.sessions.infinispan.UserSessionAdapter.getNote ( String  name )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                       {
        return entity.getNotes() != null ? entity.getNotes().get(name) : null;
    }

getNotes()

Map<String, String> org.keycloak.models.sessions.infinispan.UserSessionAdapter.getNotes ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                          {
        return entity.getNotes();
    }

getRealm()

RealmModel org.keycloak.models.sessions.infinispan.UserSessionAdapter.getRealm ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                 {
        return realm;
    }

getStarted()

int org.keycloak.models.sessions.infinispan.UserSessionAdapter.getStarted ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                            {
        return entity.getStarted();
    }

getState()

State org.keycloak.models.sessions.infinispan.UserSessionAdapter.getState ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                            {
        return entity.getState();
    }

getUser()

UserModel org.keycloak.models.sessions.infinispan.UserSessionAdapter.getUser ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                               {
        return session.users().getUserById(entity.getUser(), realm);
    }

hashCode()

int org.keycloak.models.sessions.infinispan.UserSessionAdapter.hashCode ( )

inline

                          {
        return getId().hashCode();
    }

isOffline()

boolean org.keycloak.models.sessions.infinispan.UserSessionAdapter.isOffline ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                               {
        return offline;
    }

isRememberMe()

boolean org.keycloak.models.sessions.infinispan.UserSessionAdapter.isRememberMe ( )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                  {
        return entity.isRememberMe();
    }

removeAuthenticatedClientSessions()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.removeAuthenticatedClientSessions ( Collection< String >  removedClientUUIDS )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                                                         {
        if (removedClientUUIDS == null || removedClientUUIDS.isEmpty()) {
            return;
        }

        // Performance: do not remove the clientUUIDs from the user session until there is enough of them;
        // an invalid session is handled as nonexistent in UserSessionAdapter.getAuthenticatedClientSessions()
        if (removedClientUUIDS.size() >= MINIMUM_INACTIVE_CLIENT_SESSIONS_TO_CLEANUP) {
            // Update user session
            UserSessionUpdateTask task = new UserSessionUpdateTask() {
                @Override               
                public void runUpdate(UserSessionEntity entity) {               
                    removedClientUUIDS.forEach(entity.getAuthenticatedClientSessions()::remove);                
                }               
            };          
            update(task);
        }

        // do not iterate the removedClientUUIDS and remove the clientSession directly as the addTask can manipulate
        // the collection being iterated, and that can lead to unpredictable behaviour (e.g. NPE)
        List<UUID> clientSessionUuids = removedClientUUIDS.stream()
          .map(entity.getAuthenticatedClientSessions()::get)
          .filter(Objects::nonNull)
          .collect(Collectors.toList());

        clientSessionUuids.forEach(clientSessionId -> this.clientSessionUpdateTx.addTask(clientSessionId, Tasks.removeSync()));
    }

removeNote()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.removeNote ( String  name )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                        {
        UserSessionUpdateTask task = new UserSessionUpdateTask() {

            @Override
            public void runUpdate(UserSessionEntity entity) {
                entity.getNotes().remove(name);
            }

        };

        update(task);
    }

restartSession()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.restartSession ( RealmModel  realm, UserModel  user, String  loginUsername, String  ipAddress, String  authMethod, boolean  rememberMe, String  brokerSessionId, String  brokerUserId  )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                                                                                                                                                             {
        UserSessionUpdateTask task = new UserSessionUpdateTask() {

            @Override
            public void runUpdate(UserSessionEntity entity) {
                provider.updateSessionEntity(entity, realm, user, loginUsername, ipAddress, authMethod, rememberMe, brokerSessionId, brokerUserId);

                entity.setState(null);
                entity.getNotes().clear();
                entity.getAuthenticatedClientSessions().clear();
            }

        };

        update(task);
    }

setLastSessionRefresh()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.setLastSessionRefresh ( int  lastSessionRefresh )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                              {
        UserSessionUpdateTask task = new UserSessionUpdateTask() {

            @Override
            public void runUpdate(UserSessionEntity entity) {
                entity.setLastSessionRefresh(lastSessionRefresh);
            }

            @Override
            public CrossDCMessageStatus getCrossDCMessageStatus(SessionEntityWrapper<UserSessionEntity> sessionWrapper) {
                return new LastSessionRefreshChecker(provider.getLastSessionRefreshStore(), provider.getOfflineLastSessionRefreshStore())
                        .shouldSaveUserSessionToRemoteCache(UserSessionAdapter.this.session, UserSessionAdapter.this.realm, sessionWrapper, offline, lastSessionRefresh);
            }

            @Override
            public String toString() {
                return "setLastSessionRefresh(" + lastSessionRefresh + ')';
            }
        };

        update(task);
    }

setNote()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.setNote ( String  name, String  value  )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                                   {
        UserSessionUpdateTask task = new UserSessionUpdateTask() {

            @Override
            public void runUpdate(UserSessionEntity entity) {
                if (value == null) {
                    if (entity.getNotes().containsKey(name)) {
                        removeNote(name);
                    }
                    return;
                }
                entity.getNotes().put(name, value);
            }

        };

        update(task);
    }

setState()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.setState ( State  state )

inline

org.keycloak.models.UserSessionModelを実装しています。

                                      {
        UserSessionUpdateTask task = new UserSessionUpdateTask() {

            @Override
            public void runUpdate(UserSessionEntity entity) {
                entity.setState(state);
            }

        };

        update(task);
    }

update()

void org.keycloak.models.sessions.infinispan.UserSessionAdapter.update ( UserSessionUpdateTask  task )

inlinepackage

                                            {
        userSessionUpdateTx.addTask(getId(), task);
    }

メンバ詳解

clientSessionUpdateTx

final InfinispanChangelogBasedTransaction<UUID, AuthenticatedClientSessionEntity> org.keycloak.models.sessions.infinispan.UserSessionAdapter.clientSessionUpdateTx

private

entity

final UserSessionEntity org.keycloak.models.sessions.infinispan.UserSessionAdapter.entity

private

MINIMUM_INACTIVE_CLIENT_SESSIONS_TO_CLEANUP

final int org.keycloak.models.sessions.infinispan.UserSessionAdapter.MINIMUM_INACTIVE_CLIENT_SESSIONS_TO_CLEANUP = 5

staticprivate

offline

final boolean org.keycloak.models.sessions.infinispan.UserSessionAdapter.offline

private

provider

final InfinispanUserSessionProvider org.keycloak.models.sessions.infinispan.UserSessionAdapter.provider

private

realm

final RealmModel org.keycloak.models.sessions.infinispan.UserSessionAdapter.realm

private

session

final KeycloakSession org.keycloak.models.sessions.infinispan.UserSessionAdapter.session

private

userSessionUpdateTx

final InfinispanChangelogBasedTransaction<String, UserSessionEntity> org.keycloak.models.sessions.infinispan.UserSessionAdapter.userSessionUpdateTx

private

---

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

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