forked from keycloak/keycloak
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Don't show global event listeners in the admin UI
Closes keycloak#34602 Signed-off-by: Alexander Schwartz <[email protected]>
- Loading branch information
Showing
7 changed files
with
195 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
...dmin-ui-ext/src/main/java/org/keycloak/admin/ui/rest/AvailableEventListenersResource.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| /* | ||
| * Copyright 2024 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.admin.ui.rest; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
|
|
||
| import jakarta.ws.rs.GET; | ||
| import jakarta.ws.rs.Path; | ||
| import jakarta.ws.rs.Produces; | ||
| import org.eclipse.microprofile.openapi.annotations.Operation; | ||
| import org.eclipse.microprofile.openapi.annotations.enums.SchemaType; | ||
| import org.eclipse.microprofile.openapi.annotations.media.Content; | ||
| import org.eclipse.microprofile.openapi.annotations.media.Schema; | ||
| import org.eclipse.microprofile.openapi.annotations.responses.APIResponse; | ||
| import org.keycloak.admin.ui.rest.model.EventListener; | ||
| import org.keycloak.admin.ui.rest.model.ProviderMapper; | ||
| import org.keycloak.events.EventListenerProvider; | ||
| import org.keycloak.events.EventListenerProviderFactory; | ||
| import org.keycloak.models.KeycloakSession; | ||
| import org.keycloak.services.resources.admin.permissions.AdminPermissionEvaluator; | ||
|
|
||
| public class AvailableEventListenersResource { | ||
|
|
||
| private final KeycloakSession session; | ||
| private final AdminPermissionEvaluator auth; | ||
|
|
||
| public AvailableEventListenersResource(KeycloakSession session, AdminPermissionEvaluator auth) { | ||
| this.session = session; | ||
| this.auth = auth; | ||
| } | ||
|
|
||
| @GET | ||
| @Path("/") | ||
| @Produces({"application/json"}) | ||
| @Operation( | ||
| summary = "List all available event listener providers", | ||
| description = "This endpoint returns List all available event listener providers" | ||
| ) | ||
| @APIResponse( | ||
| responseCode = "200", | ||
| description = "", | ||
| content = {@Content( | ||
| schema = @Schema( | ||
| implementation = EventListener.class, | ||
| type = SchemaType.ARRAY | ||
| ) | ||
| )} | ||
| ) | ||
| public final List<EventListener> listAvailableEventListeners() { | ||
| auth.realm().requireViewEvents(); | ||
| this.auth.adminAuth().getRealm().getEventsListenersStream(); | ||
|
|
||
| ArrayList<EventListener> result = new ArrayList<>(); | ||
|
|
||
| session.getKeycloakSessionFactory().getProviderFactoriesStream(EventListenerProvider.class).forEach( | ||
| providerFactory -> { | ||
| if (!((EventListenerProviderFactory) providerFactory).isGlobal()) { | ||
| result.add(ProviderMapper.convertToModel((EventListenerProviderFactory) providerFactory)); | ||
| } | ||
| } | ||
| ); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| } |
34 changes: 34 additions & 0 deletions
34
rest/admin-ui-ext/src/main/java/org/keycloak/admin/ui/rest/model/EventListener.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /* | ||
| * Copyright 2024 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.admin.ui.rest.model; | ||
|
|
||
| import org.eclipse.microprofile.openapi.annotations.media.Schema; | ||
|
|
||
| public class EventListener { | ||
|
|
||
| @Schema(required = true) | ||
| private String id; | ||
|
|
||
| public String getId() { | ||
| return id; | ||
| } | ||
|
|
||
| public void setId(String id) { | ||
| this.id = id; | ||
| } | ||
| } |
28 changes: 28 additions & 0 deletions
28
rest/admin-ui-ext/src/main/java/org/keycloak/admin/ui/rest/model/ProviderMapper.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| * Copyright 2024 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.admin.ui.rest.model; | ||
|
|
||
| import org.keycloak.events.EventListenerProviderFactory; | ||
|
|
||
| public class ProviderMapper { | ||
| public static EventListener convertToModel(EventListenerProviderFactory eventListenerProviderFactory) { | ||
| EventListener eventListener = new EventListener(); | ||
| eventListener.setId(eventListenerProviderFactory.getId()); | ||
| return eventListener; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters