KEYCLOAK-5688 Add externalizers for session entities

and remove unused events
filipeferraz · Oct 18, 2017 · 6d18ba4 · 6d18ba4
1 parent d01be82
commit 6d18ba4
Show file tree

Hide file tree

Showing 28 changed files with 288 additions and 253 deletions.
diff --git a/...main/java/org/keycloak/models/cache/infinispan/events/AddInvalidatedActionTokenEvent.java b/...main/java/org/keycloak/models/cache/infinispan/events/AddInvalidatedActionTokenEvent.java
diff --git a/...org/keycloak/models/cache/infinispan/events/AuthenticationSessionAuthNoteUpdateEvent.java b/...org/keycloak/models/cache/infinispan/events/AuthenticationSessionAuthNoteUpdateEvent.java
@@ -17,19 +17,33 @@
 package org.keycloak.models.cache.infinispan.events;
 
 import org.keycloak.cluster.ClusterEvent;
+import java.io.IOException;
+import java.io.ObjectInput;
+import java.io.ObjectOutput;
+import java.util.HashMap;
 import java.util.LinkedHashMap;
 import java.util.Map;
+import org.infinispan.commons.marshall.Externalizer;
+import org.infinispan.commons.marshall.MarshallUtil;
+import org.infinispan.commons.marshall.SerializeWith;
 
 /**
  *
  * @author hmlnarik
  */
+@SerializeWith(AuthenticationSessionAuthNoteUpdateEvent.ExternalizerImpl.class)
 public class AuthenticationSessionAuthNoteUpdateEvent implements ClusterEvent {
 
     private String authSessionId;
 
     private Map<String, String> authNotesFragment;
 
+    /**
+     * Creates an instance of the event.
+     * @param authSessionId
+     * @param authNotesFragment
+     * @return Event. Note that {@code authNotesFragment} property is not thread safe which is fine for now.
+     */
     public static AuthenticationSessionAuthNoteUpdateEvent create(String authSessionId, Map<String, String> authNotesFragment) {
         AuthenticationSessionAuthNoteUpdateEvent event = new AuthenticationSessionAuthNoteUpdateEvent();
         event.authSessionId = authSessionId;
@@ -50,4 +64,34 @@ public String toString() {
         return String.format("AuthenticationSessionAuthNoteUpdateEvent [ authSessionId=%s, authNotesFragment=%s ]", authSessionId, authNotesFragment);
     }
 
+    public static class ExternalizerImpl implements Externalizer<AuthenticationSessionAuthNoteUpdateEvent> {
+
+        private static final int VERSION_1 = 1;
+
+        @Override
+        public void writeObject(ObjectOutput output, AuthenticationSessionAuthNoteUpdateEvent value) throws IOException {
+            output.write(VERSION_1);
+
+            MarshallUtil.marshallString(value.authSessionId, output);
+            MarshallUtil.marshallMap(value.authNotesFragment, output);
+        }
+
+        @Override
+        public AuthenticationSessionAuthNoteUpdateEvent readObject(ObjectInput input) throws IOException, ClassNotFoundException {
+            switch (input.readByte()) {
+                case VERSION_1:
+                    return readObjectVersion1(input);
+                default:
+                    throw new IOException("Unknown version");
+            }
+        }
+
+        public AuthenticationSessionAuthNoteUpdateEvent readObjectVersion1(ObjectInput input) throws IOException, ClassNotFoundException {
+            return create(
+              MarshallUtil.unmarshallString(input),
+              MarshallUtil.unmarshallMap(input, (size) -> new HashMap<>(size))
+            );
+        }
+
+    }
 }
diff --git a/...ain/java/org/keycloak/models/cache/infinispan/events/RemoveActionTokensSpecificEvent.java b/...ain/java/org/keycloak/models/cache/infinispan/events/RemoveActionTokensSpecificEvent.java
diff --git a/...n/src/main/java/org/keycloak/models/sessions/infinispan/AuthenticationSessionAdapter.java b/...n/src/main/java/org/keycloak/models/sessions/infinispan/AuthenticationSessionAdapter.java
@@ -323,7 +323,7 @@ public void restartSession(RealmModel realm, ClientModel client) {
         String id = entity.getId();
         entity = new AuthenticationSessionEntity();
         entity.setId(id);
-        entity.setRealm(realm.getId());
+        entity.setRealmId(realm.getId());
         entity.setClientUuid(client.getId());
         entity.setTimestamp(Time.currentTime());
         update();

diff --git a/...main/java/org/keycloak/models/sessions/infinispan/InfinispanActionTokenStoreProvider.java b/...main/java/org/keycloak/models/sessions/infinispan/InfinispanActionTokenStoreProvider.java
@@ -17,11 +17,9 @@
 package org.keycloak.models.sessions.infinispan;
 
 import org.jboss.logging.Logger;
-import org.keycloak.cluster.ClusterProvider;
 import org.keycloak.common.util.Time;
 import org.keycloak.models.*;
 
-import org.keycloak.models.cache.infinispan.events.RemoveActionTokensSpecificEvent;
 import org.keycloak.models.sessions.infinispan.entities.ActionTokenValueEntity;
 import org.keycloak.models.sessions.infinispan.entities.ActionTokenReducedKey;
 import java.util.*;
@@ -99,14 +97,4 @@ public ActionTokenValueModel remove(ActionTokenKeyModel actionTokenKey) {
 
         return value;
     }
-
-    @Override
-    public void removeAll(String userId, String actionId) {
-        if (userId == null || actionId == null) {
-            return;
-        }
-
-        ClusterProvider cluster = session.getProvider(ClusterProvider.class);
-        this.tx.notify(cluster, InfinispanActionTokenStoreProviderFactory.ACTION_TOKEN_EVENTS, new RemoveActionTokensSpecificEvent(userId, actionId), false);
-    }
 }
diff --git a/...va/org/keycloak/models/sessions/infinispan/InfinispanActionTokenStoreProviderFactory.java b/...va/org/keycloak/models/sessions/infinispan/InfinispanActionTokenStoreProviderFactory.java
@@ -18,39 +18,23 @@
 
 import org.keycloak.Config;
 import org.keycloak.Config.Scope;
-import org.keycloak.cluster.ClusterProvider;
 import org.keycloak.connections.infinispan.InfinispanConnectionProvider;
 import org.keycloak.models.*;
 
-import org.keycloak.models.cache.infinispan.events.RemoveActionTokensSpecificEvent;
 import org.keycloak.models.sessions.infinispan.entities.ActionTokenValueEntity;
 import org.keycloak.models.sessions.infinispan.entities.ActionTokenReducedKey;
-import java.util.List;
-import java.util.Objects;
-import java.util.stream.Collectors;
-import org.infinispan.AdvancedCache;
 import org.infinispan.Cache;
-import org.infinispan.context.Flag;
-import org.infinispan.remoting.transport.Address;
-import org.jboss.logging.Logger;
 
 /**
  *
  * @author hmlnarik
  */
 public class InfinispanActionTokenStoreProviderFactory implements ActionTokenStoreProviderFactory {
 
-    private static final Logger LOG = Logger.getLogger(InfinispanActionTokenStoreProviderFactory.class);
-
     private volatile Cache<ActionTokenReducedKey, ActionTokenValueEntity> actionTokenCache;
 
     public static final String ACTION_TOKEN_EVENTS = "ACTION_TOKEN_EVENTS";
 
-    /**
-     * If expiration is set to this value, no expiration is set on the corresponding cache entry (hence cache default is honored)
-     */
-    private static final int DEFAULT_CACHE_EXPIRATION = 0;
-
     private Config.Scope config;
 
     @Override
@@ -66,32 +50,6 @@ public void init(Scope config) {
     private static Cache<ActionTokenReducedKey, ActionTokenValueEntity> initActionTokenCache(KeycloakSession session) {
         InfinispanConnectionProvider connections = session.getProvider(InfinispanConnectionProvider.class);
         Cache<ActionTokenReducedKey, ActionTokenValueEntity> cache = connections.getCache(InfinispanConnectionProvider.ACTION_TOKEN_CACHE);
-        final Address cacheAddress = cache.getCacheManager().getAddress();
-
-        ClusterProvider cluster = session.getProvider(ClusterProvider.class);
-
-        cluster.registerListener(ACTION_TOKEN_EVENTS, event -> {
-
-            RemoveActionTokensSpecificEvent e = (RemoveActionTokensSpecificEvent) event;
-
-            LOG.debugf("[%s] Removing token invalidation for user+action: userId=%s, actionId=%s", cacheAddress, e.getUserId(), e.getActionId());
-
-            AdvancedCache<ActionTokenReducedKey, ActionTokenValueEntity> localCache = cache
-                    .getAdvancedCache()
-                    .withFlags(Flag.CACHE_MODE_LOCAL, Flag.SKIP_CACHE_LOAD);
-
-            List<ActionTokenReducedKey> toRemove = localCache
-                    .keySet()
-                    .stream()
-                    .filter(k -> Objects.equals(k.getUserId(), e.getUserId()) && Objects.equals(k.getActionId(), e.getActionId()))
-                    .collect(Collectors.toList());
-
-            toRemove.forEach(localCache::remove);
-
-        });
-
-        LOG.debugf("[%s] Registered cluster listeners", cacheAddress);
-
         return cache;
     }
 

diff --git a/...java/org/keycloak/models/sessions/infinispan/InfinispanAuthenticationSessionProvider.java b/...java/org/keycloak/models/sessions/infinispan/InfinispanAuthenticationSessionProvider.java
@@ -71,7 +71,7 @@ public AuthenticationSessionModel createAuthenticationSession(RealmModel realm,
     public AuthenticationSessionModel createAuthenticationSession(String id, RealmModel realm, ClientModel client) {
         AuthenticationSessionEntity entity = new AuthenticationSessionEntity();
         entity.setId(id);
-        entity.setRealm(realm.getId());
+        entity.setRealmId(realm.getId());
         entity.setTimestamp(Time.currentTime());
         entity.setClientUuid(client.getId());
 

diff --git a/.../src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProvider.java b/.../src/main/java/org/keycloak/models/sessions/infinispan/InfinispanUserSessionProvider.java
@@ -172,7 +172,7 @@ public CrossDCMessageStatus getCrossDCMessageStatus(SessionEntityWrapper<UserSes
     }
 
     void updateSessionEntity(UserSessionEntity entity, RealmModel realm, UserModel user, String loginUsername, String ipAddress, String authMethod, boolean rememberMe, String brokerSessionId, String brokerUserId) {
-        entity.setRealm(realm.getId());
+        entity.setRealmId(realm.getId());
         entity.setUser(user.getId());
         entity.setLoginUsername(loginUsername);
         entity.setIpAddress(ipAddress);
@@ -525,7 +525,7 @@ private LoginFailureEntity getLoginFailureEntity(LoginFailureKey key) {
     public UserLoginFailureModel addUserLoginFailure(RealmModel realm, String userId) {
         LoginFailureKey key = new LoginFailureKey(realm.getId(), userId);
         LoginFailureEntity entity = new LoginFailureEntity();
-        entity.setRealm(realm.getId());
+        entity.setRealmId(realm.getId());
         entity.setUserId(userId);
 
         SessionUpdateTask<LoginFailureEntity> createLoginFailureTask = new SessionUpdateTask<LoginFailureEntity>() {
@@ -768,7 +768,7 @@ public List<UserSessionModel> getOfflineUserSessions(RealmModel realm, ClientMod
     public UserSessionAdapter importUserSession(UserSessionModel userSession, boolean offline, boolean importAuthenticatedClientSessions) {
         UserSessionEntity entity = new UserSessionEntity();
         entity.setId(userSession.getId());
-        entity.setRealm(userSession.getRealm().getId());
+        entity.setRealmId(userSession.getRealm().getId());
 
         entity.setAuthMethod(userSession.getAuthMethod());
         entity.setBrokerSessionId(userSession.getBrokerSessionId());

diff --git a/.../org/keycloak/models/sessions/infinispan/changes/InfinispanChangelogBasedTransaction.java b/.../org/keycloak/models/sessions/infinispan/changes/InfinispanChangelogBasedTransaction.java
@@ -63,7 +63,7 @@ public void addTask(K key, SessionUpdateTask<V> task) {
                 return;
             }
 
-            RealmModel realm = kcSession.realms().getRealm(wrappedEntity.getEntity().getRealm());
+            RealmModel realm = kcSession.realms().getRealm(wrappedEntity.getEntity().getRealmId());
 
             myUpdates = new SessionUpdatesList<>(realm, wrappedEntity);
             updates.put(key, myUpdates);
@@ -81,7 +81,7 @@ public void addTask(K key, SessionUpdateTask<V> task, V entity) {
             throw new IllegalArgumentException("Null entity not allowed");
         }
 
-        RealmModel realm = kcSession.realms().getRealm(entity.getRealm());
+        RealmModel realm = kcSession.realms().getRealm(entity.getRealmId());
         SessionEntityWrapper<V> wrappedEntity = new SessionEntityWrapper<>(entity);
         SessionUpdatesList<V> myUpdates = new SessionUpdatesList<>(realm, wrappedEntity);
         updates.put(key, myUpdates);
@@ -121,7 +121,7 @@ public SessionEntityWrapper<V> get(K key) {
                 return null;
             }
 
-            RealmModel realm = kcSession.realms().getRealm(wrappedEntity.getEntity().getRealm());
+            RealmModel realm = kcSession.realms().getRealm(wrappedEntity.getEntity().getRealmId());
 
             myUpdates = new SessionUpdatesList<>(realm, wrappedEntity);
             updates.put(key, myUpdates);

diff --git a/...in/java/org/keycloak/models/sessions/infinispan/entities/AuthenticationSessionEntity.java b/...in/java/org/keycloak/models/sessions/infinispan/entities/AuthenticationSessionEntity.java
@@ -40,7 +40,7 @@ public class AuthenticationSessionEntity extends SessionEntity {
     private Set<String> roles;
     private Set<String> protocolMappers;
 
-    private Map<String, AuthenticationSessionModel.ExecutionStatus> executionStatus  = new HashMap<>();;
+    private Map<String, AuthenticationSessionModel.ExecutionStatus> executionStatus  = new HashMap<>();
     private String protocol;
 
     private Map<String, String> clientNotes;
@@ -179,6 +179,6 @@ public int hashCode() {
 
     @Override
     public String toString() {
-        return String.format("AuthenticationSessionEntity [id=%s, realm=%s, clientUuid=%s ]", getId(), getRealm(), getClientUuid());
+        return String.format("AuthenticationSessionEntity [id=%s, realm=%s, clientUuid=%s ]", getId(), getRealmId(), getClientUuid());
     }
 }