KEYCLOAK-3618: Extensible ResourceType for provider-created AdminEvents

examples/providers/event-store-mem/src/main/java/org/keycloak/examples/providers/events/MemAdminEventQuery.java

@@ -20,7 +20,7 @@
 import org.keycloak.events.admin.AdminEvent;
 import org.keycloak.events.admin.AdminEventQuery;
 import org.keycloak.events.admin.OperationType;
-import org.keycloak.events.admin.ResourceType;
+import org.keycloak.events.admin.IResourceType;
 
 import java.util.Collections;
 import java.util.Date;
@@ -74,13 +74,13 @@ public AdminEventQuery operation(OperationType... operations) {
     }
 
     @Override
-    public AdminEventQuery resourceType(ResourceType... resourceTypes) {
+    public AdminEventQuery resourceType(IResourceType... resourceTypes) {
 
         Iterator<AdminEvent> itr = this.adminEvents.iterator();
         while (itr.hasNext()) {
             AdminEvent next = itr.next();
             boolean include = false;
-            for (ResourceType e : resourceTypes) {
+            for (IResourceType e : resourceTypes) {
                 if (next.getResourceType().equals(e)) {
                     include = true;
                     break;

model/jpa/src/main/java/org/keycloak/events/jpa/JpaAdminEventQuery.java

@@ -20,7 +20,7 @@
 import org.keycloak.events.admin.AdminEvent;
 import org.keycloak.events.admin.AdminEventQuery;
 import org.keycloak.events.admin.OperationType;
-import org.keycloak.events.admin.ResourceType;
+import org.keycloak.events.admin.IResourceType;
 
 import javax.persistence.EntityManager;
 import javax.persistence.TypedQuery;
@@ -73,10 +73,10 @@ public AdminEventQuery operation(OperationType... operations) {
     }
 
     @Override
-    public AdminEventQuery resourceType(ResourceType... resourceTypes) {
+    public AdminEventQuery resourceType(IResourceType... resourceTypes) {
 
         List<String> resourceTypeStrings = new LinkedList<String>();
-        for (ResourceType e : resourceTypes) {
+        for (IResourceType e : resourceTypes) {
             resourceTypeStrings.add(e.toString());
         }
         predicates.add(root.get("resourceType").in(resourceTypeStrings));

model/jpa/src/main/java/org/keycloak/events/jpa/JpaEventStoreProvider.java

@@ -172,7 +172,7 @@ static AdminEvent convertAdminEvent(AdminEventEntity adminEventEntity) {
         adminEvent.setOperationType(OperationType.valueOf(adminEventEntity.getOperationType()));
 
         if (adminEventEntity.getResourceType() != null) {
-            adminEvent.setResourceType(ResourceType.valueOf(adminEventEntity.getResourceType()));
+            adminEvent.setResourceType(ResourceType.of(adminEventEntity.getResourceType()));
         }
 
         adminEvent.setResourcePath(adminEventEntity.getResourcePath());

model/mongo/src/main/java/org/keycloak/events/mongo/MongoAdminEventQuery.java

@@ -23,7 +23,7 @@
 import org.keycloak.events.admin.AdminEvent;
 import org.keycloak.events.admin.AdminEventQuery;
 import org.keycloak.events.admin.OperationType;
-import org.keycloak.events.admin.ResourceType;
+import org.keycloak.events.admin.IResourceType;
 
 import java.util.Date;
 import java.util.LinkedList;
@@ -59,10 +59,10 @@ public AdminEventQuery operation(OperationType... operations) {
     }
 
     @Override
-    public AdminEventQuery resourceType(ResourceType... resourceTypes) {
+    public AdminEventQuery resourceType(IResourceType... resourceTypes) {
 
         List<String> resourceTypeStrings = new LinkedList<String>();
-        for (ResourceType e : resourceTypes) {
+        for (IResourceType e : resourceTypes) {
             resourceTypeStrings.add(e.toString());
         }
         query.put("resourceType", new BasicDBObject("$in", resourceTypeStrings));

server-spi/src/main/java/org/keycloak/events/admin/AdminEvent.java

@@ -31,7 +31,7 @@ public class AdminEvent {
     /**
      * The resource type an AdminEvent was triggered for.
      */
-    private ResourceType resourceType;
+    private IResourceType resourceType;
 
     private OperationType operationType;
 
@@ -143,11 +143,11 @@ public void setError(String error) {
      *
      * @return
      */
-    public ResourceType getResourceType() {
+    public IResourceType getResourceType() {
         return resourceType;
     }
 
-    public void setResourceType(ResourceType resourceType) {
+    public void setResourceType(IResourceType resourceType) {
         this.resourceType = resourceType;
     }
 }

server-spi/src/main/java/org/keycloak/events/admin/AdminEventQuery.java

@@ -78,7 +78,7 @@ public interface AdminEventQuery {
      * @param resourceTypes
      * @return <code>this</code> for method chaining
      */
-    AdminEventQuery resourceType(ResourceType ... resourceTypes);
+    AdminEventQuery resourceType(IResourceType ... resourceTypes);
 
     /**
      * Search by resource path. Supports wildcards <code>*</code> and <code>**</code>. For example:

server-spi/src/main/java/org/keycloak/events/admin/IResourceType.java

@@ -0,0 +1,26 @@
+/*
+ * Copyright 2016 Red Hat, Inc. and/or its affiliates
+ * and other contributors as indicated by the @author tags.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.keycloak.events.admin;
+
+/**
+ * Interface to be implemented by ResourceType and subclasses
+ *
+ * @author <a href="mailto:mitya@cargosoft.ru">Dmitry Telegin</a>
+ */
+public interface IResourceType {
+
+}

server-spi/src/main/java/org/keycloak/events/admin/ResourceType.java

@@ -16,12 +16,15 @@
  */
 package org.keycloak.events.admin;
 
+import java.util.concurrent.ConcurrentHashMap;
+import java.util.concurrent.ConcurrentMap;
+
 /**
  * Represents Keycloak resource types for which {@link AdminEvent AdminEvent's} can be triggered.
  *
  * @author <a href="mailto:thomas.darimont@gmail.com">Thomas Darimont</a>
  */
-public enum ResourceType {
+public enum ResourceType implements IResourceType {
 
     /**
      *
@@ -157,4 +160,26 @@ public enum ResourceType {
      *
      */
     , CLUSTER_NODE;
+
+    private static final ConcurrentMap<String, IResourceType> types = new ConcurrentHashMap<>();
+
+    public static IResourceType of(final String name) {
+
+        if (types.isEmpty()) {
+            for (ResourceType type : values()) {
+                types.putIfAbsent(type.name(), type);
+            }
+        }
+
+        types.putIfAbsent(name.toString(/* null-check */), new IResourceType() {
+            @Override
+            public String toString() {
+                return name;
+            }
+        });
+
+        return types.get(name);
+
+    }
+
 }

services/src/main/java/org/keycloak/services/resources/admin/AdminEventBuilder.java

@@ -23,7 +23,7 @@
 import org.keycloak.events.admin.AdminEvent;
 import org.keycloak.events.admin.AuthDetails;
 import org.keycloak.events.admin.OperationType;
-import org.keycloak.events.admin.ResourceType;
+import org.keycloak.events.admin.IResourceType;
 import org.keycloak.models.ClientModel;
 import org.keycloak.models.KeycloakSession;
 import org.keycloak.models.RealmModel;
@@ -91,7 +91,7 @@ public AdminEventBuilder operation(OperationType operationType) {
         return this;
     }
 
-    public AdminEventBuilder resource(ResourceType resourceType){
+    public AdminEventBuilder resource(IResourceType resourceType){
         adminEvent.setResourceType(resourceType);
         return this;
     }

services/src/main/java/org/keycloak/services/resources/admin/RealmAdminResource.java

@@ -33,6 +33,7 @@
 import org.keycloak.events.admin.AdminEventQuery;
 import org.keycloak.events.admin.OperationType;
 import org.keycloak.events.admin.ResourceType;
+import org.keycloak.events.admin.IResourceType;
 import org.keycloak.exportimport.ClientDescriptionConverter;
 import org.keycloak.exportimport.ClientDescriptionConverterFactory;
 import org.keycloak.models.ClientModel;
@@ -650,9 +651,9 @@ public List<AdminEventRepresentation> getEvents(@QueryParam("operationTypes") Li
         }
 
         if (resourceTypes != null && !resourceTypes.isEmpty()) {
-            ResourceType[] t = new ResourceType[resourceTypes.size()];
+            IResourceType[] t = new IResourceType[resourceTypes.size()];
             for (int i = 0; i < t.length; i++) {
-                t[i] = ResourceType.valueOf(resourceTypes.get(i));
+                t[i] = ResourceType.of(resourceTypes.get(i));
             }
             query.resourceType(t);
         }